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 toujours 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 
{
  "citation": {
    object (Citation)
  },

  // 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)
  },
  "exampleQueries": {
    object (ExampleQueries)
  }
  // End of list of possible types for union field kind.
  "groupId": integer
}
Champs
citation

object (Citation)

Uniquement en sortie. Informations de citation pour le message système.
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.
exampleQueries

object (ExampleQueries)

Facultatif. Message contenant des exemples de requêtes.
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
  ],
  "textType": enum (TextType),
  "thoughtSignature": string
}
Champs
parts[]

string

Facultatif. Les parties du message.
textType

enum (TextType)

Facultatif. Type du message texte.
thoughtSignature

string (bytes format)

Facultatif. Signature opaque d'une pensée, qui peut être réutilisée dans les requêtes ultérieures.

Chaîne encodée en base64.

TextType

Type du message texte.

Enums
TEXT_TYPE_UNSPECIFIED Type de texte par défaut.
FINAL_RESPONSE Le texte est une réponse finale à la question de l'utilisateur.
THOUGHT Le texte est une réflexion du modèle.
PROGRESS Le texte est un message informatif sur la progression de l'agent, par exemple lorsqu'un outil est appelé. Ces messages sont distincts du processus de réflexion interne de l'agent (THOUGHT) et de la réponse finale à l'utilisateur (FINAL_RESPONSE). Ils donnent un aperçu des actions de l'agent.
FOLLOWUP_QUESTIONS Le texte est une liste de questions de suivi suggérées. Chaque élément de "parts" est une question complémentaire.

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)
  },
  "structSchema": {
    object
  },

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

object (Schema)

Facultatif. Schéma de la source de données.
structSchema

object (Struct format)

Facultatif. Représentation structurée du schéma. Cette valeur est renseignée pour les sources de données dont les schémas ne peuvent pas être entièrement représentés par le champ schema à typage fort.

Pour les sources de données Looker, cela correspond au type LookmlModelExplore : https://cloud.google.com/looker/docs/reference/looker-api/latest/types/LookmlModelExplore
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.
bigqueryPropertyGraphReference

object (BigQueryPropertyGraphReference)

Référence à un graphique de propriétés BigQuery.

BigQueryPropertyGraphReference

Message représentant une référence à un seul graphique de propriétés BigQuery.

Représentation JSON 
{
  "projectId": string,
  "datasetId": string,
  "propertyGraphId": string
}
Champs
projectId

string

Obligatoire. Projet auquel appartient le graphique de propriété.
datasetId

string

Obligatoire. Ensemble de données auquel appartient le graphique de propriété.
propertyGraphId

string

Obligatoire. ID du graphique de propriété.

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)
  },
  "bigQueryJob": {
    object (BigQueryJob)
  },
  "matchedQuery": {
    object (MatchedQuery)
  }
  // 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.
bigQueryJob

object (BigQueryJob)

Job BigQuery exécuté par le système pour récupérer des données.
matchedQuery

object (MatchedQuery)

Requête préexistante qui a été mise en correspondance 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)
    }
  ],

  // Union field query_type can be only one of the following:
  "looker": {
    object (LookerQuery)
  }
  // End of list of possible types for union field query_type.
}
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.
Champ d'union query_type. Type de requête à exécuter. query_type ne peut être qu'un des éléments suivants :
looker

object (LookerQuery)

Facultatif. Requête permettant de récupérer des données à partir d'une exploration Looker.

DataResult

Données récupérées.

Représentation JSON 
{
  "name": string,
  "schema": {
    object (Schema)
  },
  "data": [
    {
      object
    }
  ],
  "formattedData": [
    {
      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.
formattedData[]

object (Struct format)

Facultatif. Représentation mise en forme des données, le cas échéant. Chaque ligne est un struct qui correspond directement à la ligne du même index dans le champ data. Ses valeurs sont des représentations sous forme de chaîne des données d'origine, formatées selon les spécifications de la source de données (par exemple, "1 234,56 $" pour la devise). Les colonnes sans mise en forme sont définies par défaut sur la représentation de leur valeur brute. Si aucune règle de mise en forme n'est définie pour les colonnes, ce champ est vide.

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.

MatchedQuery

Un message de requête correspondante signifie que l'agent a trouvé une requête exemple dans le contexte qui s'applique à la question actuelle. Il contiendra également des informations supplémentaires lors du processus de mise en correspondance.

Représentation JSON 
{
  "exampleQuery": {
    object (ExampleQuery)
  },
  "queryParameterValues": [
    {
      object (QueryParameterValues)
    }
  ]
}
Champs
exampleQuery

object (ExampleQuery)

Requête mise en correspondance en fonction d'un exemple de requête.
queryParameterValues[]

object (QueryParameterValues)

Valeurs extraites pour les paramètres de requête.

QueryParameterValues

Un message de valeurs de paramètres de requête représente les valeurs des paramètres de requête qui ont été extraites de la question de l'utilisateur par le LLM, en fonction de l'exemple de requête.

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

string

Obligatoire. Nom du paramètre.
value

string

Obligatoire. Valeur du paramètre.

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 de 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 provenant d'un appel d'outil. Ce message est utilisé pour représenter une erreur survenue lorsqu'un agent a essayé d'utiliser un outil. Il est important de noter que toutes les erreurs ne sont pas fatales. Dans de nombreux cas, les erreurs peuvent être corrigées. L'agent peut utiliser les informations de ce message d'erreur pour se corriger lui-même et réessayer l'appel d'outil ou essayer une autre approche.

Par exemple, si une requête de données échoue, l'agent peut recevoir un ErrorMessage, l'analyser, puis générer une requête corrigée.

Les clients doivent faire preuve de prudence lorsqu'ils interprètent ce message comme un échec définitif. Cela peut faire partie du processus itératif normal de l'agent pour accomplir une tâche. Afficher ces erreurs directement aux utilisateurs finaux sans contexte (par exemple, en tant qu'"échec irréversible") peut être trompeur.

Représentation JSON 
{
  "text": string
}
Champs
text

string

Uniquement en sortie. Texte de l'erreur.

ExampleQueries

Message contenant des exemples de requêtes dérivées et créées.

Représentation JSON 
{
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
Champs
exampleQueries[]

object (ExampleQuery)

Facultatif. Liste d'exemples de requêtes dérivées et créées, avec éventuellement les requêtes en langage naturel correspondantes. Actuellement utilisé uniquement pour les sources de données BigQuery.

Citation

Attributions de source pour le contenu.

Représentation JSON 
{
  "sources": [
    {
      object (CitationSource)
    }
  ],
  "anchors": [
    {
      object (CitationAnchor)
    }
  ]
}
Champs
sources[]

object (CitationSource)

Uniquement en sortie. Liste des sources citées.
anchors[]

object (CitationAnchor)

Uniquement en sortie. Liste des ancres des citations.

CitationSource

Source de la citation.

Représentation JSON 
{
  "id": string,
  "title": string,

  // Union field source_type can be only one of the following:
  "uri": string,
  "exampleQuery": {
    object (ExampleQuery)
  },
  "glossaryTerm": {
    object (GlossaryTerm)
  }
  // End of list of possible types for union field source_type.
}
Champs
id

string

Uniquement en sortie. Identifiant unique de la source. Cet ID est généré par le service et est unique dans le champ d'application d'un seul message Citation.
title

string

Uniquement en sortie. Titre de la source.
Champ d'union source_type. Source de la citation, qui peut être l'un des types acceptés. source_type ne peut être qu'un des éléments suivants :
uri

string

Uniquement en sortie. URI utilisé comme source, tel qu'une URL d'ancrage Web.
exampleQuery

object (ExampleQuery)

Uniquement en sortie. Exemple de requête utilisé comme source.
glossaryTerm

object (GlossaryTerm)

Uniquement en sortie. Terme du glossaire utilisé comme source.

CitationAnchor

Ancre de la citation.

Représentation JSON 
{

  // Union field anchor_type can be only one of the following:
  "textMessageAnchor": {
    object (TextMessageCitationAnchor)
  }
  // End of list of possible types for union field anchor_type.
}
Champs
Champ d'union anchor_type. Ancre de la citation, qui peut être l'un des types acceptés. anchor_type ne peut être qu'un des éléments suivants :
textMessageAnchor

object (TextMessageCitationAnchor)

Uniquement en sortie. Défini uniquement si la citation concerne un TextMessage.

TextMessageCitationAnchor

Ancre de citation dans un TextMessage.

Représentation JSON 
{
  "partIndex": integer,
  "startOffsetBytes": integer,
  "endOffsetBytes": integer,
  "sourceIds": [
    string
  ]
}
Champs
partIndex

integer

Uniquement en sortie. Index basé sur 0 de la partie dans le champ TextMessage.parts.
startOffsetBytes

integer

Uniquement en sortie. Décalage, mesuré en octets UTF-8, dans la chaîne de la partie où la citation commence (inclus). Exemple : Pour le texte "Bonjour le monde" où "monde" est cité, les octets de décalage de début (inclus) sont 7 et les octets de décalage de fin (exclus) sont 12.
endOffsetBytes

integer

Uniquement en sortie. Décalage, mesuré en octets UTF-8, dans la chaîne de la partie où la citation se termine (exclusive). Exemple : Pour le texte "Bonjour le monde" où "monde" est cité, les octets de décalage de début (inclus) sont 7 et les octets de décalage de fin (exclus) sont 12.
sourceIds[]

string

Uniquement en sortie. ID des sources citées.