- Représentation JSON
- UserMessage
- SystemMessage
- TextMessage
- SchemaMessage
- SchemaQuery
- SchemaResult
- Datasource
- DataMessage
- DataQuery
- DataResult
- LookerQuery
- Filter
- BigQueryJob
- AnalysisMessage
- AnalysisQuery
- AnalysisEvent
- ChartMessage
- ChartQuery
- ChartResult
- Blob
- ErrorMessage
Message issu d'une interaction entre l'utilisateur et le système.
Représentation JSON |
---|
{ "timestamp": string, "messageId": string, // Union field |
Champs | |
---|---|
timestamp |
Uniquement en sortie. Pour les messages utilisateur, il s'agit de l'heure à laquelle le système a reçu le message. Pour les messages système, il s'agit de l'heure à laquelle le système a généré le message. Utilise la norme RFC 3339, où la sortie générée utilise le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : |
messageId |
Facultatif. Identifiant unique du message dans la conversation à des fins de persistance. |
Champ d'union kind . Type de message. kind ne peut être qu'un des éléments suivants : |
|
userMessage |
Message de l'utilisateur qui interagit avec le système. |
systemMessage |
Message du système en réponse à l'utilisateur. |
UserMessage
Message de l'utilisateur qui interagit avec le système.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union kind . Type de contenu du message de l'utilisateur. kind ne peut être qu'un des éléments suivants : |
|
text |
Le texte doit utiliser ce champ au lieu du blob. |
SystemMessage
Message du système en réponse à l'utilisateur. Ce message peut également être un message de l'utilisateur servant de contexte historique pour les conversations multitours avec le système.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union kind . Type de contenu du message système. kind ne peut être qu'un des éléments suivants : |
|
text |
Réponse directe au message de l'utilisateur, en langage naturel. |
schema |
Message généré lors de la résolution du schéma. |
data |
Message généré lors de la récupération des données. |
analysis |
Message généré lors de l'analyse. |
chart |
Message généré lors de la génération d'un graphique. |
error |
Message d'erreur. |
groupId |
Identifie le groupe auquel appartient l'événement. Les événements similaires sont considérés comme logiquement pertinents les uns par rapport aux autres et doivent être affichés ensemble dans l'UI. |
TextMessage
Message en plusieurs parties.
Représentation JSON |
---|
{ "parts": [ string ] } |
Champs | |
---|---|
parts[] |
Facultatif. Les parties du message. |
SchemaMessage
Message généré lors de la résolution du schéma.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union kind . Indique si ce message contient la requête ou le résultat de la résolution du schéma. kind ne peut être qu'un des éléments suivants : |
|
query |
Requête de résolution de schéma. |
result |
Résultat d'une requête de résolution de schéma. |
SchemaQuery
Requête permettant de résoudre le schéma pertinent pour la question posée.
Représentation JSON |
---|
{ "question": string } |
Champs | |
---|---|
question |
Facultatif. Question à envoyer au système pour la résolution du schéma. |
SchemaResult
Résultat de la résolution du schéma.
Représentation JSON |
---|
{
"datasources": [
{
object ( |
Champs | |
---|---|
datasources[] |
Facultatif. Sources de données utilisées pour résoudre la requête de schéma. |
Datasource
Source de données pouvant être utilisée pour répondre à des questions.
Représentation JSON |
---|
{ "schema": { object ( |
Champs | |
---|---|
schema |
Facultatif. Schéma de la source de données. |
Champ d'union reference . Référence à la source de données. reference ne peut être qu'un des éléments suivants : |
|
bigqueryTableReference |
Référence à une table BigQuery. |
studioDatasourceId |
Référence à une source de données Looker Studio. |
lookerExploreReference |
Référence à une exploration Looker. |
DataMessage
Message généré lors de la récupération des données.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union kind . Indique si ce message contient la requête, le résultat ou le code SQL généré pour la récupération des données. kind ne peut être qu'un des éléments suivants : |
|
query |
Requête de récupération de données. |
generatedSql |
Code SQL généré par le système pour récupérer les données. |
result |
Données récupérées. |
generatedLookerQuery |
Requête Looker générée par le système pour récupérer les données. |
bigQueryJob |
Job BigQuery exécuté par le système pour récupérer des données. |
DataQuery
Requête permettant de récupérer des données.
Représentation JSON |
---|
{
"question": string,
"name": string,
"datasources": [
{
object ( |
Champs | |
---|---|
question |
Facultatif. Question en langage naturel à laquelle répondre. |
name |
Facultatif. Nom au format snake case pour la requête, qui reflète son intention. Il permet de nommer le résultat de données correspondant pour qu'il puisse être référencé lors des étapes ultérieures.
|
datasources[] |
Facultatif. Sources de données disponibles pour répondre à la question. |
DataResult
Données récupérées.
Représentation JSON |
---|
{
"name": string,
"schema": {
object ( |
Champs | |
---|---|
name |
Facultatif. Nom au format snake case pour le résultat des données, qui reflète son contenu. Le nom est utilisé pour transmettre le résultat par référence et sert de signal concernant sa signification.
|
schema |
Facultatif. Schéma des données. |
data[] |
Facultatif. Contenu des données. Chaque ligne est un struct qui correspond au schéma. Les valeurs simples sont représentées sous forme de chaînes, tandis que les structures imbriquées sont représentées sous forme de listes ou de structs. |
LookerQuery
Requête permettant de récupérer des données à partir d'une exploration Looker. Consultez Exécuter une requête intégrée.
Représentation JSON |
---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
Champs | |
---|---|
model |
Obligatoire. Modèle LookML utilisé pour générer la requête. |
explore |
Obligatoire. Exploration LookML utilisée pour générer la requête. |
fields[] |
Facultatif. Champs à récupérer à partir de l'exploration. |
filters[] |
Facultatif. Filtres à appliquer à l'exploration. |
sorts[] |
Facultatif. Tris à appliquer à l'exploration. |
limit |
Facultatif. Limite dans la requête. |
Filtre
Filtre de requête Looker.
Représentation JSON |
---|
{ "field": string, "value": string } |
Champs | |
---|---|
field |
Obligatoire. Champ sur lequel filtrer. |
value |
Obligatoire. Valeur du champ "f" à filtrer. |
BigQueryJob
Job BigQuery exécuté par le système.
Représentation JSON |
---|
{ "projectId": string, "jobId": string, "location": string, "destinationTable": { object ( |
Champs | |
---|---|
projectId |
Obligatoire. Projet auquel appartient le job. Consultez JobReference. |
jobId |
Obligatoire. ID du job. Consultez JobReference. |
location |
Facultatif. Emplacement du job. Consultez JobReference. |
destinationTable |
Facultatif. Référence à la table de destination des résultats de requête du job. Consultez JobConfigurationQuery. |
schema |
Facultatif. Schéma des résultats de requête du job. Consultez JobStatistics2. |
AnalysisMessage
Message généré lors de l'analyse.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union kind . Indique si ce message contient la requête ou l'un des événements de l'analyse. kind ne peut être qu'un des éléments suivants : |
|
query |
Requête d'analyse. |
progressEvent |
Événement indiquant la progression de l'analyse. |
AnalysisQuery
Requête permettant d'effectuer une analyse.
Représentation JSON |
---|
{ "question": string, "dataResultNames": [ string ] } |
Champs | |
---|---|
question |
Facultatif. Question d'analyse pour aider à répondre à la question initiale de l'utilisateur. |
dataResultNames[] |
Facultatif. Noms des résultats de données précédemment récupérés à analyser. |
AnalysisEvent
Événement indiquant la progression d'une analyse.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union kind . Type d'événement survenu lors de l'analyse. kind ne peut être qu'un des éléments suivants : |
|
plannerReasoning |
Raisonnement du planificateur de génération de code Python. |
coderInstruction |
Instructions émises pour la génération de code. |
code |
Code généré. |
executionOutput |
Sortie de l'exécution du code. |
executionError |
Erreur d'exécution du code. |
resultVegaChartJson |
Résultat sous forme de chaîne JSON de graphique Vega. |
resultNaturalLanguage |
Résultat sous forme de chaîne en langage naturel. |
resultCsvData |
Résultat sous forme de chaîne CSV. |
resultReferenceData |
Résultat sous forme de référence à une source de données. |
error |
Message d'erreur générique. |
ChartMessage
Message généré lors de la génération d'un graphique.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union kind . Indique si ce message contient la requête ou le résultat de la génération du graphique. kind ne peut être qu'un des éléments suivants : |
|
query |
Requête permettant de générer un graphique. |
result |
Résultat d'une requête de génération de graphique. |
ChartQuery
Requête permettant de générer un graphique.
Représentation JSON |
---|
{ "instructions": string, "dataResultName": string } |
Champs | |
---|---|
instructions |
Facultatif. Instructions en langage naturel pour générer le graphique. |
dataResultName |
Facultatif. Nom d'un résultat de données récupéré précédemment à utiliser dans le graphique. |
ChartResult
Résultat d'une requête de génération de graphique.
Représentation JSON |
---|
{
"vegaConfig": {
object
},
"image": {
object ( |
Champs | |
---|---|
vegaConfig |
Facultatif. Configuration de graphique Vega générée. Consultez https://vega.github.io/vega/docs/config/. |
image |
Facultatif. Représentation du graphique si cela a été demandé dans le contexte. |
Blob
Blob de données avec un type MIME.
Représentation JSON |
---|
{ "mimeType": string, "data": string } |
Champs | |
---|---|
mimeType |
Obligatoire. Type MIME standard IANA des données du message. |
data |
Obligatoire. Données représentées sous forme d'octets. Chaîne encodée en base64. |
ErrorMessage
Message d'erreur.
Représentation JSON |
---|
{ "text": string } |
Champs | |
---|---|
text |
Uniquement en sortie. Texte de l'erreur. |