- Représentation JSON
- UserMessage
- SystemMessage
- TextMessage
- TextType
- SchemaMessage
- SchemaQuery
- SchemaResult
- Datasource
- DataMessage
- DataQuery
- DataResult
- BigQueryJob
- MatchedQuery
- QueryParameterValues
- AnalysisMessage
- AnalysisQuery
- AnalysisEvent
- ChartMessage
- ChartQuery
- ChartResult
- Blob
- ErrorMessage
- ExampleQueries
- ClarificationMessage
- ClarificationQuestion
- SelectionMode
- ClarificationQuestionType
- Citation
- CitationSource
- CitationAnchor
- TextMessageCitationAnchor
Message issu d'une interaction entre l'utilisateur et le système.
| Représentation JSON |
|---|
{ "timestamp": string, "messageId": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "userMessage": { object ( |
| 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 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 : |
messageId |
Facultatif. Identifiant unique du message dans la conversation à des fins de persistance. |
| Type de message. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
userMessage |
Message de l'utilisateur qui interagit avec le système. |
systemMessage |
Message du système en réponse à l'utilisateur. |
| Fin des champs mutuellement exclusifs. | |
UserMessage
Message de l'utilisateur qui interagit avec le système.
| Représentation JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "text": string // End of mutually exclusive fields. } |
| Champs | |
|---|---|
| Type de contenu du message de l'utilisateur. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
text |
Le texte doit utiliser ce champ au lieu du blob. |
| Fin des champs mutuellement exclusifs. | |
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 ( |
| Champs | |
|---|---|
citation |
Uniquement en sortie. Informations de citation pour le message système. |
| Type de contenu du message système. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
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. |
exampleQueries |
Facultatif. Message contenant des exemples de requêtes. |
clarification |
Facultatif. Obsolète : utilisez TextMessage avec TextType.FINAL_RESPONSE à la place. Un message contenant des questions de clarification. |
| Fin des champs mutuellement exclusifs. | |
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
],
"textType": enum ( |
| Champs | |
|---|---|
parts[] |
Facultatif. Les parties du message. |
textType |
Facultatif. Type du message. |
thoughtSignature |
Facultatif. Signature opaque d'une pensée afin qu'elle puisse être réutilisée dans les requêtes ultérieures. Chaîne encodée en base64. |
TextType
Type du message.
| 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 étape de raisonnement du modèle. |
PROGRESS |
Le texte est un message d'information sur la progression de l'agent, par exemple l'appel d'un outil. Il est distinct du processus de réflexion interne de l'agent (THOUGHT) et de la réponse finale à l'utilisateur (FINAL_RESPONSE). Ces messages fournissent des informations sur les actions de l'agent. |
FOLLOWUP_QUESTIONS |
Le texte est une liste de questions complémentaires suggérées. Chaque élément de parts est une question de suivi. |
SchemaMessage
Message généré lors de la résolution du schéma.
| Représentation JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Champs | |
|---|---|
| Indique si ce message contient la requête ou le résultat de la résolution du schéma. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
query |
Requête de résolution de schéma. |
result |
Résultat d'une requête de résolution de schéma. |
| Fin des champs mutuellement exclusifs. | |
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. |
structSchema |
Facultatif. Représentation du schéma sous forme de structure. Ce champ est renseigné pour les sources de données dont les schémas ne peuvent pas être entièrement représentés par le champ Pour les sources de données Looker, cela correspond au type LookmlModelExplore : https://cloud.google.com/looker/docs/reference/looker-api/latest/types/LookmlModelExplore |
| Référence à la source de données. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
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. |
alloyDbReference |
Référence à une base de données AlloyDB. |
spannerReference |
Référence à une base de données Spanner. |
cloudSqlReference |
Référence à une base de données Cloud SQL. |
bigtableReference |
Référence à une instance Bigtable. |
bigqueryPropertyGraphReference |
Référence à un graphe de propriétés BigQuery. |
firestoreReference |
Référence à une base de données Firestore. |
| Fin des champs mutuellement exclusifs. | |
DataMessage
Message généré lors de la récupération des données.
| Représentation JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Champs | |
|---|---|
| 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. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
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 |
Obsolète : la requête Looker générée se trouve désormais sous DataQuery.looker. 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. |
matchedQuery |
Une requête préexistante qui a été mise en correspondance pour récupérer des données. |
| Fin des champs mutuellement exclusifs. | |
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. |
| Type de requête à exécuter. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
looker |
Facultatif. Requête permettant de récupérer des données à partir d'une exploration Looker. |
| Fin des champs mutuellement exclusifs. | |
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. |
formattedData[] |
Facultatif. Représentation formatée des données, le cas échéant. Chaque ligne est un struct qui correspond directement à la ligne au même index dans le champ |
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. |
MatchedQuery
Un message de requête correspondante indique que l'agent a mis en correspondance l'un des exemples de requêtes fournis dans le contexte comme étant applicable à la question actuelle. Il contiendra également des informations supplémentaires pendant le processus de mise en correspondance.
| Représentation JSON |
|---|
{ "exampleQuery": { object ( |
| Champs | |
|---|---|
exampleQuery |
Requête mise en correspondance sur la base d'un exemple de requête. |
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, sur la base de l'exemple de requête.
| Représentation JSON |
|---|
{ "name": string, "value": string } |
| Champs | |
|---|---|
name |
Obligatoire. Nom du paramètre. |
value |
Obligatoire. Valeur du paramètre. |
AnalysisMessage
Message généré lors de l'analyse.
| Représentation JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Champs | |
|---|---|
| Indique si ce message contient la requête ou l'un des événements de l'analyse. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
query |
Requête d'analyse. |
progressEvent |
Événement indiquant la progression de l'analyse. |
| Fin des champs mutuellement exclusifs. | |
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 |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "plannerReasoning": string, "coderInstruction": string, "code": string, "executionOutput": string, "executionError": string, "resultVegaChartJson": string, "resultNaturalLanguage": string, "resultCsvData": string, "resultReferenceData": string, "error": string // End of mutually exclusive fields. } |
| Champs | |
|---|---|
| Type d'événement survenu lors de l'analyse. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
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 de code. |
executionError |
Erreur d'exécution de 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. |
| Fin des champs mutuellement exclusifs. | |
ChartMessage
Message généré lors de la génération d'un graphique.
| Représentation JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Champs | |
|---|---|
| Indique si ce message contient la requête ou le résultat de la génération du graphique. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
query |
Requête permettant de générer un graphique. |
result |
Résultat d'une requête de génération de graphique. |
| Fin des champs mutuellement exclusifs. | |
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 d'un appel d'outil. Ce message est utilisé pour représenter une erreur qui s'est produite lorsqu'un agent a tenté d'utiliser un outil. Il est important de noter que toutes les erreurs ne sont pas fatales. Beaucoup sont récupérables, et l'agent peut utiliser les informations de ce message d'erreur pour s'autocorriger 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 être prudents avant d'interpréter ce message comme un échec définitif. Il peut faire partie du processus itératif normal de l'agent pour accomplir une tâche. Présenter ces erreurs directement aux utilisateurs finaux sans contexte (par exemple, en tant qu'"échec matériel") peut être trompeur.
| Représentation JSON |
|---|
{ "text": string } |
| Champs | |
|---|---|
text |
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 ( |
| Champs | |
|---|---|
exampleQueries[] |
Facultatif. Liste d'exemples de requêtes dérivées et créées, fournissant des exemples de requêtes SQL pertinentes et couramment utilisées, ainsi que les requêtes en langage naturel correspondantes, éventuellement présentes. Actuellement utilisé uniquement pour les sources de données BigQuery. |
ClarificationMessage
Obsolète : utilisez TextMessage avec TextType.FINAL_RESPONSE à la place. Message contenant des questions pour aider à clarifier la requête de l'utilisateur. Ce message est renvoyé lorsque le système ne peut pas répondre avec certitude à la question de l'utilisateur.
| Représentation JSON |
|---|
{
"questions": [
{
object ( |
| Champs | |
|---|---|
questions[] |
Obligatoire. Obsolète : le message parent est obsolète. Un ensemble de questions de clarification à poser à l'utilisateur. |
ClarificationQuestion
Obsolète : utilisez TextMessage avec TextType.FINAL_RESPONSE à la place. Représente une seule question posée à l'utilisateur pour l'aider à clarifier sa requête.
| Représentation JSON |
|---|
{ "question": string, "selectionMode": enum ( |
| Champs | |
|---|---|
question |
Obligatoire. Obsolète : le message parent est obsolète. Question en langage naturel à poser à l'utilisateur. |
selectionMode |
Obligatoire. Obsolète : le message parent est obsolète. Mode de sélection pour cette question. |
options[] |
Obligatoire. Obsolète : le message parent est obsolète. Liste d'options distinctes parmi lesquelles l'utilisateur peut choisir. Le nombre d'options est limité à cinq au maximum. |
clarificationQuestionType |
Facultatif. Obsolète : le message parent est obsolète. Type de question de clarification. |
SelectionMode
Obsolète : le message parent est obsolète. Mode de sélection de la question de clarification.
| Enums | |
|---|---|
SELECTION_MODE_UNSPECIFIED |
Obsolète : le message parent est obsolète. Mode de sélection non spécifié. |
SINGLE_SELECT |
Obsolète : le message parent est obsolète. L'utilisateur ne peut sélectionner qu'une seule option. |
MULTI_SELECT |
Obsolète : le message parent est obsolète. L'utilisateur peut sélectionner plusieurs options. |
ClarificationQuestionType
Obsolète : le message parent est obsolète. Type de question de clarification. Cet énumération pourra être étendue avec de nouvelles valeurs à l'avenir.
| Enums | |
|---|---|
CLARIFICATION_QUESTION_TYPE_UNSPECIFIED |
Obsolète : le message parent est obsolète. Type de question de clarification non spécifié. |
FILTER_VALUES |
Obsolète : le message parent est obsolète. La question de clarification concerne les valeurs de filtre. |
FIELDS |
Obsolète : le message parent est obsolète. La question de clarification concerne les champs de données. Il s'agit d'un terme générique englobant les colonnes SQL, les champs Looker (dimensions/mesures) ou les propriétés de structure de données imbriquées. |
Citation
Attributions de sources pour le contenu.
| Représentation JSON |
|---|
{ "sources": [ { object ( |
| Champs | |
|---|---|
sources[] |
Uniquement en sortie. Liste des sources citées. |
anchors[] |
Uniquement en sortie. Liste des ancres des citations. |
CitationSource
Source de la citation.
| Représentation JSON |
|---|
{ "id": string, "title": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "uri": string, "exampleQuery": { object ( |
| Champs | |
|---|---|
id |
Uniquement en sortie. Identifiant unique de la source. Cet ID est généré par le service et est unique dans le cadre d'un seul message |
title |
Uniquement en sortie. Titre de la source. |
| Source de la citation, qui peut être l'un des types acceptés. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
uri |
Uniquement en sortie. URI utilisé comme source, tel qu'une URL d'ancrage Web. |
exampleQuery |
Uniquement en sortie. Exemple de requête utilisé comme source. |
glossaryTerm |
Uniquement en sortie. Terme du glossaire utilisé comme source. |
| Fin des champs mutuellement exclusifs. | |
CitationAnchor
Ancre de la citation.
| Représentation JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"textMessageAnchor": {
object ( |
| Champs | |
|---|---|
| Ancre de la citation, qui peut être l'un des types acceptés. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
textMessageAnchor |
Uniquement en sortie. Défini uniquement si la citation concerne un TextMessage. |
| Fin des champs mutuellement exclusifs. | |
TextMessageCitationAnchor
Ancre de citation dans un TextMessage.
| Représentation JSON |
|---|
{ "partIndex": integer, "startOffsetBytes": integer, "endOffsetBytes": integer, "sourceIds": [ string ] } |
| Champs | |
|---|---|
partIndex |
Uniquement en sortie. Index en base 0 de la partie dans le champ TextMessage.parts. |
startOffsetBytes |
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 "Hello, world" où "world" est cité, l'octet de décalage de début (inclus) est 7 et l'octet de décalage de fin (exclus) est 12. |
endOffsetBytes |
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 "Hello, world" où "world" est cité, l'octet de décalage de début (inclusif) est 7 et l'octet de décalage de fin (exclusif) est 12. |
sourceIds[] |
Uniquement en sortie. ID des sources citées. |