v1.Fact
export interface Fact
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
“INT” | “STRING” | “DATE” | “NUMERIC” | “TIMESTAMP” | “TIMESTAMP_TZ” | “BOOLEAN” | “HLL” | A column data type in the physical database. | ||
string | (Optional) An optional description of the field. | ||
boolean | (Optional) | ||
boolean | (Optional) Optional flag to indicate if the fact can contain null values. | ||
string | (Optional) Optional value which can be used as replacement for NULL in join conditions. | ||
boolean | (Optional) Optional flag to indicate if the fact should be shown in AI results. When omitted, the fact is visible. | ||
string | (Optional) A column name in the physical database. Optional, equals to id by default. | ||
(Optional) | |||
string | (Optional) A human readable title of the field. Optional, derived from id if not provided explicitly. | ||
“fact” |
Property details
v1.Fact.data_typeproperty
A column data type in the physical database.
data_type: "INT" | "STRING" | "DATE" | "NUMERIC" | "TIMESTAMP" | "TIMESTAMP_TZ" | "BOOLEAN" | "HLL";
v1.Fact.descriptionproperty
An optional description of the field.
description?: string;
v1.Fact.is_hiddenpropertyDeprecated
Warning: This API is now obsolete.
Deprecated. Use ‘show_in_ai_results’ instead.
is_hidden?: boolean;
v1.Fact.is_nullableproperty
Optional flag to indicate if the fact can contain null values.
is_nullable?: boolean;
v1.Fact.null_value_join_replacementproperty
Optional value which can be used as replacement for NULL in join conditions.
null_value_join_replacement?: string;
v1.Fact.show_in_ai_resultsproperty
Optional flag to indicate if the fact should be shown in AI results. When omitted, the fact is visible.
show_in_ai_results?: boolean;
v1.Fact.source_columnproperty
A column name in the physical database. Optional, equals to id by default.
source_column?: string;
v1.Fact.tagsproperty
tags?: Tags3;
v1.Fact.titleproperty
A human readable title of the field. Optional, derived from id if not provided explicitly.
title?: string;
v1.Fact.typeproperty
type: "fact";