- Rappresentazione JSON
- UserMessage
- SystemMessage
- TextMessage
- TextType
- SchemaMessage
- SchemaQuery
- SchemaResult
- Origine dati
- DataMessage
- DataQuery
- DataResult
- BigQueryJob
- MatchedQuery
- QueryParameterValues
- AnalysisMessage
- AnalysisQuery
- AnalysisEvent
- ChartMessage
- ChartQuery
- ChartResult
- Blob
- ErrorMessage
- ExampleQueries
- ClarificationMessage
- ClarificationQuestion
- SelectionMode
- ClarificationQuestionType
- Citazione
- CitationSource
- CitationAnchor
- TextMessageCitationAnchor
Un messaggio di un'interazione tra l'utente e il sistema.
| Rappresentazione 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 ( |
| Campi | |
|---|---|
timestamp |
Solo output. Per i messaggi degli utenti, si tratta dell'ora in cui il sistema ha ricevuto il messaggio. Per i messaggi di sistema, si tratta dell'ora in cui il sistema ha generato il messaggio. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
messageId |
(Facoltativo) ID univoco del messaggio nella conversazione per la persistenza. |
| Il tipo di messaggio. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
userMessage |
Un messaggio dell'utente che interagisce con il sistema. |
systemMessage |
Un messaggio del sistema in risposta all'utente. |
| Fine dei campi che si escludono a vicenda. | |
UserMessage
Un messaggio dell'utente che interagisce con il sistema.
| Rappresentazione 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. } |
| Campi | |
|---|---|
| Il tipo di contenuti nel messaggio dell'utente. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
text |
Il testo deve utilizzare questo campo anziché il blob. |
| Fine dei campi che si escludono a vicenda. | |
SystemMessage
Un messaggio del sistema in risposta all'utente. Questo messaggio può anche essere un messaggio dell'utente come contesto storico per le conversazioni multi-turn con il sistema.
| Rappresentazione JSON |
|---|
{ "citation": { object ( |
| Campi | |
|---|---|
citation |
Solo output. Informazioni sulla citazione per il messaggio di sistema. |
| Il tipo di contenuto nel messaggio di sistema. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
text |
Una risposta diretta in linguaggio naturale al messaggio dell'utente. |
schema |
Un messaggio generato durante la risoluzione dello schema. |
data |
Un messaggio generato durante il recupero dei dati. |
analysis |
Un messaggio generato durante l'analisi. |
chart |
Un messaggio generato durante la creazione del grafico. |
error |
Un messaggio di errore. |
exampleQueries |
Facoltativo. Un messaggio contenente query di esempio. |
clarification |
Facoltativo. Deprecato: utilizza TextMessage con TextType.FINAL_RESPONSE. Un messaggio contenente domande di chiarimento. |
| Fine dei campi che si escludono a vicenda. | |
groupId |
Identifica il gruppo a cui appartiene l'evento. Gli eventi simili sono considerati logicamente pertinenti tra loro e devono essere mostrati insieme nell'UI. |
TextMessage
Un messaggio di testo in più parti.
| Rappresentazione JSON |
|---|
{
"parts": [
string
],
"textType": enum ( |
| Campi | |
|---|---|
parts[] |
Facoltativo. Le parti del messaggio. |
textType |
Facoltativo. Il tipo di messaggio. |
thoughtSignature |
Facoltativo. Una firma opaca per un pensiero, in modo che possa essere riutilizzata nelle richieste successive. Una stringa con codifica in base64. |
TextType
Il tipo di messaggio.
| Enum | |
|---|---|
TEXT_TYPE_UNSPECIFIED |
Il tipo di testo predefinito. |
FINAL_RESPONSE |
Il testo è una risposta finale alla domanda dell'utente. |
THOUGHT |
Il testo è un pensiero del modello. |
PROGRESS |
Il testo è un messaggio informativo sull'avanzamento dell'agente, ad esempio uno strumento che viene richiamato. Questo è diverso dal processo di pensiero interno dell'agente (THOUGHT) e dalla risposta finale all'utente (FINAL_RESPONSE). Questi messaggi forniscono informazioni sulle azioni dell'agente. |
FOLLOWUP_QUESTIONS |
Il testo è un elenco di domande aggiuntive suggerite. Ogni elemento in parts è una domanda aggiuntiva. |
SchemaMessage
Un messaggio generato durante la risoluzione dello schema.
| Rappresentazione JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Campi | |
|---|---|
| Indica se questo messaggio contiene la query o il risultato della risoluzione dello schema. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
query |
Una query di risoluzione dello schema. |
result |
Il risultato di una query di risoluzione dello schema. |
| Fine dei campi che si escludono a vicenda. | |
SchemaQuery
Una query per risolvere lo schema pertinente alla domanda posta.
| Rappresentazione JSON |
|---|
{ "question": string } |
| Campi | |
|---|---|
question |
Facoltativo. La domanda da inviare al sistema per la risoluzione dello schema. |
SchemaResult
Il risultato della risoluzione dello schema.
| Rappresentazione JSON |
|---|
{
"datasources": [
{
object ( |
| Campi | |
|---|---|
datasources[] |
Facoltativo. Le origini dati utilizzate per risolvere la query dello schema. |
Origine dati
Un'origine dati che può essere utilizzata per rispondere alle domande.
| Rappresentazione JSON |
|---|
{ "schema": { object ( |
| Campi | |
|---|---|
schema |
Facoltativo. Lo schema dell'origine dati. |
structSchema |
Facoltativo. Una rappresentazione struct dello schema. Questo campo viene compilato per le origini dati con schemi che non possono essere completamente rappresentati dal campo Per le origini dati di Looker, questo viene mappato al tipo LookmlModelExplore: https://cloud.google.com/looker/docs/reference/looker-api/latest/types/LookmlModelExplore |
| Il riferimento all'origine dati. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
bigqueryTableReference |
Un riferimento a una tabella BigQuery. |
studioDatasourceId |
Un riferimento a un'origine dati di Looker Studio. |
lookerExploreReference |
Un riferimento a un'esplorazione di Looker. |
alloyDbReference |
Un riferimento a un database AlloyDB. |
spannerReference |
Un riferimento a un database Spanner. |
cloudSqlReference |
Un riferimento a un database Cloud SQL. |
bigtableReference |
Un riferimento a un'istanza Bigtable. |
bigqueryPropertyGraphReference |
Un riferimento a un grafico delle proprietà BigQuery. |
firestoreReference |
Un riferimento a un database Firestore. |
| Fine dei campi che si escludono a vicenda. | |
DataMessage
Un messaggio generato durante il recupero dei dati.
| Rappresentazione JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Campi | |
|---|---|
| Se questo messaggio contiene la query, il risultato o l'SQL generato per il recupero dei dati. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
query |
Una query di recupero dei dati. |
generatedSql |
SQL generato dal sistema per recuperare i dati. |
result |
Dati recuperati. |
generatedLookerQuery |
Ritirato: la query Looker generata è ora in DataQuery.looker. Query di Looker generata dal sistema per recuperare i dati. |
bigQueryJob |
Un job BigQuery eseguito dal sistema per recuperare i dati. |
matchedQuery |
Una query preesistente che è stata abbinata per recuperare i dati. |
| Fine dei campi che si escludono a vicenda. | |
DataQuery
Una query per recuperare i dati.
| Rappresentazione JSON |
|---|
{ "question": string, "name": string, "datasources": [ { object ( |
| Campi | |
|---|---|
question |
Facoltativo. Una domanda in linguaggio naturale a cui rispondere. |
name |
Facoltativo. Un nome in snake_case per la query che ne rifletta l'intent. Viene utilizzato per assegnare un nome al risultato dei dati corrispondente, in modo che possa essere utilizzato come riferimento nei passaggi successivi.
|
datasources[] |
Facoltativo. Le origini dati disponibili per rispondere alla domanda. |
| Il tipo di query da eseguire. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
looker |
Facoltativo. Una query per recuperare i dati da un'esplorazione di Looker. |
| Fine dei campi che si escludono a vicenda. | |
DataResult
Dati recuperati.
| Rappresentazione JSON |
|---|
{
"name": string,
"schema": {
object ( |
| Campi | |
|---|---|
name |
Facoltativo. Un nome in snake_case per il risultato dei dati che ne riflette i contenuti. Il nome viene utilizzato per passare il risultato per riferimento e funge da indicatore del suo significato.
|
schema |
Facoltativo. Lo schema dei dati. |
data[] |
Facoltativo. I contenuti dei dati. Ogni riga è una struttura che corrisponde allo schema. I valori semplici sono rappresentati come stringhe, mentre le strutture nidificate sono rappresentate come elenchi o struct. |
formattedData[] |
Facoltativo. Rappresentazione formattata dei dati, se applicabile. Ogni riga è uno struct che corrisponde direttamente alla riga con lo stesso indice all'interno del campo |
BigQueryJob
Un job BigQuery eseguito dal sistema.
| Rappresentazione JSON |
|---|
{ "projectId": string, "jobId": string, "location": string, "destinationTable": { object ( |
| Campi | |
|---|---|
projectId |
Obbligatorio. Il progetto a cui appartiene il job. Consulta JobReference. |
jobId |
Obbligatorio. L'ID del job. Consulta JobReference. |
location |
Facoltativo. La località del job. Consulta JobReference. |
destinationTable |
Facoltativo. Un riferimento alla tabella di destinazione dei risultati della query del job. Consulta JobConfigurationQuery. |
schema |
Facoltativo. Lo schema dei risultati della query del job. Consulta JobStatistics2. |
MatchedQuery
Un messaggio Query corrispondente indica che l'agente ha trovato una corrispondenza tra una delle query di esempio fornite nel contesto e la domanda corrente. Inoltre, conterrà informazioni aggiuntive durante il processo di corrispondenza.
| Rappresentazione JSON |
|---|
{ "exampleQuery": { object ( |
| Campi | |
|---|---|
exampleQuery |
La query corrispondente in base a una query di esempio. |
queryParameterValues[] |
I valori estratti per i parametri di ricerca. |
QueryParameterValues
Un messaggio con i valori dei parametri di query rappresenta i valori dei parametri di ricerca estratti dalla domanda dell'utente dall'LLM, in base alla query di esempio.
| Rappresentazione JSON |
|---|
{ "name": string, "value": string } |
| Campi | |
|---|---|
name |
Obbligatorio. Il nome del parametro. |
value |
Obbligatorio. Il valore del parametro. |
AnalysisMessage
Un messaggio generato durante l'analisi.
| Rappresentazione JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Campi | |
|---|---|
| Indica se questo messaggio contiene la query o uno degli eventi dell'analisi. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
query |
Una query di analisi. |
progressEvent |
Un evento che indica l'avanzamento dell'analisi. |
| Fine dei campi che si escludono a vicenda. | |
AnalysisQuery
Una query per eseguire un'analisi.
| Rappresentazione JSON |
|---|
{ "question": string, "dataResultNames": [ string ] } |
| Campi | |
|---|---|
question |
Facoltativo. Una domanda di analisi per rispondere alla domanda originale dell'utente. |
dataResultNames[] |
Facoltativo. I nomi dei risultati dei dati recuperati in precedenza da analizzare. |
AnalysisEvent
Un evento che indica l'avanzamento di un'analisi.
| Rappresentazione 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. } |
| Campi | |
|---|---|
| Il tipo di evento che si è verificato durante l'analisi. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
plannerReasoning |
Ragionamento del planner di generazione di codice Python. |
coderInstruction |
Istruzioni fornite per la generazione del codice. |
code |
Codice generato. |
executionOutput |
Output dell'esecuzione del codice. |
executionError |
Un errore relativo all'esecuzione del codice. |
resultVegaChartJson |
Risultato come stringa JSON del grafico Vega. |
resultNaturalLanguage |
Risultato come stringa NL. |
resultCsvData |
Risultato come stringa CSV. |
resultReferenceData |
Risultato come riferimento a un'origine dati. |
error |
Un messaggio di errore generico. |
| Fine dei campi che si escludono a vicenda. | |
ChartMessage
Un messaggio generato durante la creazione del grafico.
| Rappresentazione JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Campi | |
|---|---|
| Indica se questo messaggio contiene la query o il risultato della generazione del grafico. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
query |
Una query per generare un grafico. |
result |
Il risultato di una query di generazione di grafici. |
| Fine dei campi che si escludono a vicenda. | |
ChartQuery
Una query per generare un grafico.
| Rappresentazione JSON |
|---|
{ "instructions": string, "dataResultName": string } |
| Campi | |
|---|---|
instructions |
Facoltativo. Istruzioni in linguaggio naturale per la generazione del grafico. |
dataResultName |
Facoltativo. Il nome di un risultato dei dati recuperato in precedenza da utilizzare nel grafico. |
ChartResult
Il risultato di una query di generazione di grafici.
| Rappresentazione JSON |
|---|
{
"vegaConfig": {
object
},
"image": {
object ( |
| Campi | |
|---|---|
vegaConfig |
Facoltativo. Una configurazione del grafico Vega generata. Consulta https://vega.github.io/vega/docs/config/ |
image |
Facoltativo. Un rendering del grafico, se richiesto nel contesto. |
Blob
Un blob di dati con un tipo MIME.
| Rappresentazione JSON |
|---|
{ "mimeType": string, "data": string } |
| Campi | |
|---|---|
mimeType |
Obbligatorio. Il tipo MIME standard IANA dei dati del messaggio. |
data |
Obbligatorio. I dati rappresentati come byte. Una stringa con codifica in base64. |
ErrorMessage
Un messaggio di errore di una chiamata allo strumento. Questo messaggio viene utilizzato per rappresentare un errore che si è verificato mentre un agente stava tentando di utilizzare uno strumento. È importante notare che non tutti gli errori sono irreversibili. Molti sono recuperabili e l'agente può utilizzare le informazioni contenute in questo messaggio di errore per correggersi autonomamente e riprovare la chiamata allo strumento o provare un approccio diverso.
Ad esempio, se una query sui dati non va a buon fine, l'agente potrebbe ricevere un ErrorMessage, analizzarlo e generare una query corretta.
I client devono prestare attenzione a non interpretare questo messaggio come un errore definitivo. Può far parte del normale processo iterativo dell'agente per il completamento di un'attività. Mostrare questi errori direttamente agli utenti finali senza contesto (ad esempio, come un "errore irreversibile") potrebbe essere fuorviante.
| Rappresentazione JSON |
|---|
{ "text": string } |
| Campi | |
|---|---|
text |
Solo output. Il testo dell'errore. |
ExampleQueries
Un messaggio contenente query di esempio derivate e create.
| Rappresentazione JSON |
|---|
{
"exampleQueries": [
{
object ( |
| Campi | |
|---|---|
exampleQueries[] |
Facoltativo. Un elenco di query di esempio derivate e create, che fornisce esempi di query SQL pertinenti e di uso comune e le relative query in linguaggio naturale corrispondenti, se presenti. Attualmente utilizzato solo per le origini dati BigQuery. |
ClarificationMessage
Deprecato: utilizza TextMessage con TextType.FINAL_RESPONSE. Un messaggio con domande per chiarire la query dell'utente. Questo viene restituito quando il sistema non è in grado di rispondere con sicurezza alla domanda dell'utente.
| Rappresentazione JSON |
|---|
{
"questions": [
{
object ( |
| Campi | |
|---|---|
questions[] |
Obbligatorio. Ritirato: il messaggio principale è stato ritirato. Un gruppo di domande di chiarimento da porre all'utente. |
ClarificationQuestion
Deprecato: utilizza TextMessage con TextType.FINAL_RESPONSE. Rappresenta una singola domanda posta all'utente per aiutarlo a chiarire la sua query.
| Rappresentazione JSON |
|---|
{ "question": string, "selectionMode": enum ( |
| Campi | |
|---|---|
question |
Obbligatorio. Ritirato: il messaggio principale è stato ritirato. La domanda in linguaggio naturale da porre all'utente. |
selectionMode |
Obbligatorio. Ritirato: il messaggio principale è stato ritirato. La modalità di selezione per questa domanda. |
options[] |
Obbligatorio. Ritirato: il messaggio principale è stato ritirato. Un elenco di opzioni distinte tra cui l'utente può scegliere. Il numero di opzioni è limitato a un massimo di 5. |
clarificationQuestionType |
Facoltativo. Ritirato: il messaggio principale è stato ritirato. Il tipo di domanda di chiarimento. |
SelectionMode
Ritirato: il messaggio principale è stato ritirato. La modalità di selezione per la domanda di chiarimento.
| Enum | |
|---|---|
SELECTION_MODE_UNSPECIFIED |
Ritirato: il messaggio principale è stato ritirato. Modalità di selezione non specificata. |
SINGLE_SELECT |
Ritirato: il messaggio principale è stato ritirato. L'utente può selezionare una sola opzione. |
MULTI_SELECT |
Ritirato: il messaggio principale è stato ritirato. L'utente può selezionare più opzioni. |
ClarificationQuestionType
Ritirato: il messaggio principale è stato ritirato. Il tipo di domanda di chiarimento. Questo enum potrebbe essere esteso con nuovi valori in futuro.
| Enum | |
|---|---|
CLARIFICATION_QUESTION_TYPE_UNSPECIFIED |
Ritirato: il messaggio principale è stato ritirato. Tipo di domanda di chiarimento non specificato. |
FILTER_VALUES |
Ritirato: il messaggio principale è stato ritirato. La domanda di chiarimento riguarda i valori dei filtri. |
FIELDS |
Ritirato: il messaggio principale è stato ritirato. La domanda di chiarimento riguarda i campi di dati. Questo è un termine generico che comprende colonne SQL, campi di Looker (dimensioni/misure) o proprietà di strutture di dati nidificate. |
Citazione
Attribuzioni delle fonti per i contenuti.
| Rappresentazione JSON |
|---|
{ "sources": [ { object ( |
| Campi | |
|---|---|
sources[] |
Solo output. Elenco delle fonti citate. |
anchors[] |
Solo output. Elenco degli anchor delle citazioni. |
CitationSource
La fonte della citazione.
| Rappresentazione 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 ( |
| Campi | |
|---|---|
id |
Solo output. Identificatore univoco dell'origine. Questo ID è generato dal servizio ed è univoco nell'ambito di un singolo messaggio |
title |
Solo output. Il titolo della fonte. |
| La fonte della citazione, che può essere uno dei tipi supportati. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
uri |
Solo output. L'URI utilizzato come origine, ad esempio un URL di grounding web. |
exampleQuery |
Solo output. La query di esempio utilizzata come origine. |
glossaryTerm |
Solo output. Il termine del glossario utilizzato come origine. |
| Fine dei campi che si escludono a vicenda. | |
CitationAnchor
L'anchor della citazione.
| Rappresentazione JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"textMessageAnchor": {
object ( |
| Campi | |
|---|---|
| L'ancoraggio della citazione, che può essere uno dei tipi supportati. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
textMessageAnchor |
Solo output. Impostato solo se la citazione è per un TextMessage. |
| Fine dei campi che si escludono a vicenda. | |
TextMessageCitationAnchor
Ancoraggio della citazione all'interno di un TextMessage.
| Rappresentazione JSON |
|---|
{ "partIndex": integer, "startOffsetBytes": integer, "endOffsetBytes": integer, "sourceIds": [ string ] } |
| Campi | |
|---|---|
partIndex |
Solo output. L'indice basato su 0 della parte all'interno del campo TextMessage.parts. |
startOffsetBytes |
Solo output. L'offset, misurato in byte UTF-8, all'interno della stringa della parte in cui inizia la citazione (inclusa). Esempio: per il testo "Hello, world" in cui viene citato "world", i byte di offset iniziale (inclusi) sono 7 e i byte di offset finale (esclusi) sono 12. |
endOffsetBytes |
Solo output. L'offset, misurato in byte UTF-8, all'interno della stringa della parte in cui termina la citazione (esclusa). Esempio: per il testo "Hello, world" in cui viene citato "world", i byte di offset iniziale (inclusi) sono 7 e i byte di offset finale (esclusi) sono 12. |
sourceIds[] |
Solo output. Gli ID delle fonti citate. |