AI Chat Schema Table

Docs

Fonctions de base
Paiement
Recouvrement de créances
- Recouvrement de créances
- Recouvreurs de dettes
Abonnement
Individualiser
Connecter
- Connected Services
- Imprimer
- Slack
- Shopify
- Wix
- Webhooks
Référence API

Documentation

An analytics table the human user can query, with what is needed to write SQL for it. In the schema context a table has the detail full, with its columns, the values of its state and type columns and sample queries, or summary, with only name, description, sharded, detail and href. The table detail is always full and adds the related tables, the href of its sample queries and the links guidance.

Propriétés

Colonnes

The columns of the table in schema order. Absent for a table with the detail summary, present for a table with the detail full.
Description

What the table contains: a short summary in the schema context, the full description in the table detail. Absent if the schema catalog has no description.
Detail

How much of the table is included. full: the columns, state and type values and samples are present. summary: only name, description, sharded, detail and href are present, so the table detail at href must be fetched before the table is used in a query. Absent if the AI Chat service does not provide it.
Examples Href

The href of the sample queries of the table, relative to .../analytics/ai-chat/queries/. Only in the table detail; absent in the schema context.
Exemples

Sample queries that reference this table and only tables the human user can query. Absent for a table with the detail summary. In the schema context each sample is listed at most once, under the first table by name with the detail full that it references, and their number is capped, so an empty list does not mean the table has no samples. The table detail lists none; its samples are at examplesHref.
Href

The href of the table detail, relative to .../analytics/ai-chat/queries/. Absent if the AI Chat service does not provide it.
Links Guidance

When to follow further hrefs, as advised by the AI Chat service. Only in the table detail; absent in the schema context, which carries its own advice.
Nom

The name of the analytics table, as used in SQL queries.
Related

The tables the human user can query that this table refers to or that refer to it by foreign key, sorted by name. Only in the table detail, where an empty list means there is none; absent in the schema context.
Sharded

Whether the table is sharded, i.e. its rows are partitioned by an internal database ID column.
State Query Hint

A hint on how to filter the table by its state column. Absent for a table with the detail summary and if the schema catalog has no hint.
State Values

The possible values of the state column of the table. Absent for a table with the detail summary; for a table with the detail full empty if the table has no state column.
Type Values

The possible values of the type columns of the table. Absent for a table with the detail summary; for a table with the detail full empty if the table has no type column.