Message

Message issu d'une interaction entre l'utilisateur et le système.

Représentation JSON
{
  "timestamp": string,
  "messageId": string,

  // Union field kind can be only one of the following:
  "userMessage": {
    object (UserMessage)
  },
  "systemMessage": {
    object (SystemMessage)
  }
  // End of list of possible types for union field kind.
}
Champs
timestamp

string (Timestamp format)

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 : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

messageId

string

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

object (UserMessage)

Message de l'utilisateur qui interagit avec le système.

systemMessage

object (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 kind can be only one of the following:
  "text": string
  // End of list of possible types for union field kind.
}
Champs
Champ d'union kind. Type de contenu du message de l'utilisateur. kind ne peut être qu'un des éléments suivants :
text

string

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 kind can be only one of the following:
  "text": {
    object (TextMessage)
  },
  "schema": {
    object (SchemaMessage)
  },
  "data": {
    object (DataMessage)
  },
  "analysis": {
    object (AnalysisMessage)
  },
  "chart": {
    object (ChartMessage)
  },
  "error": {
    object (ErrorMessage)
  }
  // End of list of possible types for union field kind.
  "groupId": integer
}
Champs
Champ d'union kind. Type de contenu du message système. kind ne peut être qu'un des éléments suivants :
text

object (TextMessage)

Réponse directe au message de l'utilisateur, en langage naturel.

schema

object (SchemaMessage)

Message généré lors de la résolution du schéma.

data

object (DataMessage)

Message généré lors de la récupération des données.

analysis

object (AnalysisMessage)

Message généré lors de l'analyse.

chart

object (ChartMessage)

Message généré lors de la génération d'un graphique.

error

object (ErrorMessage)

Message d'erreur.

groupId

integer

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[]

string

Facultatif. Les parties du message.

SchemaMessage

Message généré lors de la résolution du schéma.

Représentation JSON
{

  // Union field kind can be only one of the following:
  "query": {
    object (SchemaQuery)
  },
  "result": {
    object (SchemaResult)
  }
  // End of list of possible types for union field kind.
}
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

object (SchemaQuery)

Requête de résolution de schéma.

result

object (SchemaResult)

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

string

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 (Datasource)
    }
  ]
}
Champs
datasources[]

object (Datasource)

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 (Schema)
  },

  // Union field reference can be only one of the following:
  "bigqueryTableReference": {
    object (BigQueryTableReference)
  },
  "studioDatasourceId": string,
  "lookerExploreReference": {
    object (LookerExploreReference)
  }
  // End of list of possible types for union field reference.
}
Champs
schema

object (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

object (BigQueryTableReference)

Référence à une table BigQuery.

studioDatasourceId

string

Référence à une source de données Looker Studio.

lookerExploreReference

object (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 kind can be only one of the following:
  "query": {
    object (DataQuery)
  },
  "generatedSql": string,
  "result": {
    object (DataResult)
  },
  "generatedLookerQuery": {
    object (LookerQuery)
  },
  "bigQueryJob": {
    object (BigQueryJob)
  }
  // End of list of possible types for union field kind.
}
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

object (DataQuery)

Requête de récupération de données.

generatedSql

string

Code SQL généré par le système pour récupérer les données.

result

object (DataResult)

Données récupérées.

generatedLookerQuery

object (LookerQuery)

Requête Looker générée par le système pour récupérer les données.

bigQueryJob

object (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 (Datasource)
    }
  ]
}
Champs
question

string

Facultatif. Question en langage naturel à laquelle répondre.

name

string

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.

  • Exemple : "total_sales_by_product"
  • Exemple : "sales_for_product_12345"
datasources[]

object (Datasource)

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 (Schema)
  },
  "data": [
    {
      object
    }
  ]
}
Champs
name

string

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.

  • Exemple : "total_sales_by_product"
  • Exemple : "sales_for_product_12345"
schema

object (Schema)

Facultatif. Schéma des données.

data[]

object (Struct format)

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 (Filter)
    }
  ],
  "sorts": [
    string
  ],
  "limit": string
}
Champs
model

string

Obligatoire. Modèle LookML utilisé pour générer la requête.

explore

string

Obligatoire. Exploration LookML utilisée pour générer la requête.

fields[]

string

Facultatif. Champs à récupérer à partir de l'exploration.

filters[]

object (Filter)

Facultatif. Filtres à appliquer à l'exploration.

sorts[]

string

Facultatif. Tris à appliquer à l'exploration.

limit

string

Facultatif. Limite dans la requête.

Filtre

Filtre de requête Looker.

Représentation JSON
{
  "field": string,
  "value": string
}
Champs
field

string

Obligatoire. Champ sur lequel filtrer.

value

string

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 (BigQueryTableReference)
  },
  "schema": {
    object (Schema)
  }
}
Champs
projectId

string

Obligatoire. Projet auquel appartient le job.

Consultez JobReference.

jobId

string

Obligatoire. ID du job.

Consultez JobReference.

location

string

Facultatif. Emplacement du job.

Consultez JobReference.

destinationTable

object (BigQueryTableReference)

Facultatif. Référence à la table de destination des résultats de requête du job.

Consultez JobConfigurationQuery.

schema

object (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 kind can be only one of the following:
  "query": {
    object (AnalysisQuery)
  },
  "progressEvent": {
    object (AnalysisEvent)
  }
  // End of list of possible types for union field kind.
}
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

object (AnalysisQuery)

Requête d'analyse.

progressEvent

object (AnalysisEvent)

É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

string

Facultatif. Question d'analyse pour aider à répondre à la question initiale de l'utilisateur.

dataResultNames[]

string

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 kind can be only one of the following:
  "plannerReasoning": string,
  "coderInstruction": string,
  "code": string,
  "executionOutput": string,
  "executionError": string,
  "resultVegaChartJson": string,
  "resultNaturalLanguage": string,
  "resultCsvData": string,
  "resultReferenceData": string,
  "error": string
  // End of list of possible types for union field kind.
}
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

string

Raisonnement du planificateur de génération de code Python.

coderInstruction

string

Instructions émises pour la génération de code.

code

string

Code généré.

executionOutput

string

Sortie de l'exécution du code.

executionError

string

Erreur d'exécution du code.

resultVegaChartJson

string

Résultat sous forme de chaîne JSON de graphique Vega.

resultNaturalLanguage

string

Résultat sous forme de chaîne en langage naturel.

resultCsvData

string

Résultat sous forme de chaîne CSV.

resultReferenceData

string

Résultat sous forme de référence à une source de données.

error

string

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 kind can be only one of the following:
  "query": {
    object (ChartQuery)
  },
  "result": {
    object (ChartResult)
  }
  // End of list of possible types for union field kind.
}
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

object (ChartQuery)

Requête permettant de générer un graphique.

result

object (ChartResult)

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

string

Facultatif. Instructions en langage naturel pour générer le graphique.

dataResultName

string

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 (Blob)
  }
}
Champs
vegaConfig

object (Struct format)

Facultatif. Configuration de graphique Vega générée. Consultez https://vega.github.io/vega/docs/config/.

image

object (Blob)

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

string

Obligatoire. Type MIME standard IANA des données du message.

data

string (bytes format)

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

string

Uniquement en sortie. Texte de l'erreur.