Message

Un messaggio proveniente da un'interazione tra l'utente e il sistema.

Rappresentazione 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.
}
Campi
timestamp

string (Timestamp format)

Solo output. Per i messaggi utente, questo è il momento in cui il sistema ha ricevuto il messaggio. Per i messaggi di sistema, questo è l'orario 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
messageId

string

(Facoltativo) ID univoco del messaggio nella conversazione per la persistenza.
Campo unione kind. Il tipo di messaggio. kind può essere solo uno dei seguenti tipi:
userMessage

object (UserMessage)

Un messaggio dell'utente che interagisce con il sistema.
systemMessage

object (SystemMessage)

Un messaggio del sistema in risposta all'utente.

UserMessage

Un messaggio dell'utente che interagisce con il sistema.

Rappresentazione JSON 
{

  // Union field kind can be only one of the following:
  "text": string
  // End of list of possible types for union field kind.
}
Campi
Campo unione kind. Il tipo di contenuti nel messaggio dell'utente. kind può essere solo uno dei seguenti tipi:
text

string

Il testo deve utilizzare questo campo anziché il blob.

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 (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
}
Campi
citation

object (Citation)

Solo output. Informazioni sulla citazione per il messaggio di sistema.
Campo unione kind. Il tipo di contenuti nel messaggio di sistema. kind può essere solo uno dei seguenti tipi:
text

object (TextMessage)

Una risposta diretta in linguaggio naturale al messaggio dell'utente.
schema

object (SchemaMessage)

Un messaggio prodotto durante la risoluzione dello schema.
data

object (DataMessage)

Un messaggio prodotto durante il recupero dei dati.
analysis

object (AnalysisMessage)

Un messaggio prodotto durante l'analisi.
chart

object (ChartMessage)

Un messaggio prodotto durante la generazione del grafico.
error

object (ErrorMessage)

Un messaggio di errore.
exampleQueries

object (ExampleQueries)

Facoltativo. Un messaggio contenente query di esempio.
groupId

integer

Identifica il gruppo a cui appartiene l'evento. Gli eventi simili sono considerati logicamente pertinenti tra loro e devono essere mostrati insieme nell'interfaccia utente.

TextMessage

Un messaggio di testo in più parti.

Rappresentazione JSON 
{
  "parts": [
    string
  ],
  "textType": enum (TextType),
  "thoughtSignature": string
}
Campi
parts[]

string

Facoltativo. Le parti del messaggio.
textType

enum (TextType)

Facoltativo. Il tipo di messaggio.
thoughtSignature

string (bytes format)

Facoltativo. Una firma opaca per un pensiero, in modo che possa essere riutilizzato 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 definitiva alla domanda dell'utente.
THOUGHT Il testo è un pensiero del modello.
PROGRESS Il testo è un messaggio informativo sullo stato di avanzamento dell'agente, ad esempio l'invocazione di uno strumento. Questi messaggi forniscono informazioni sulle azioni dell'agente.THOUGHTFINAL_RESPONSE
FOLLOWUP_QUESTIONS Il testo è un elenco di domande di follow-up suggerite. Ogni elemento nelle parti è una domanda di follow-up.

SchemaMessage

Un messaggio prodotto durante la risoluzione dello schema.

Rappresentazione 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.
}
Campi
Campo unione kind. Indica se questo messaggio contiene la query o il risultato della risoluzione dello schema. kind può essere solo uno dei seguenti tipi:
query

object (SchemaQuery)

Una query di risoluzione dello schema.
result

object (SchemaResult)

Il risultato di una query di risoluzione dello schema.

SchemaQuery

Una query per risolvere lo schema pertinente alla domanda posta.

Rappresentazione JSON 
{
  "question": string
}
Campi
question

string

Facoltativo. La domanda da inviare al sistema per la risoluzione dello schema.

SchemaResult

Il risultato della risoluzione dello schema.

Rappresentazione JSON 
{
  "datasources": [
    {
      object (Datasource)
    }
  ]
}
Campi
datasources[]

object (Datasource)

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 (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.
}
Campi
schema

object (Schema)

Facoltativo. Lo schema dell'origine dati.
structSchema

object (Struct format)

Facoltativo. Una rappresentazione struct dello schema. Questo campo viene compilato per le origini dati con schemi che non possono essere rappresentati completamente dal campo schema con tipo di dati definito.

Per le origini dati Looker, questo corrisponde al tipo LookmlModelExplore: https://cloud.google.com/looker/docs/reference/looker-api/latest/types/LookmlModelExplore
Campo unione reference. Il riferimento all'origine dati. reference può essere solo uno dei seguenti tipi:
bigqueryTableReference

object (BigQueryTableReference)

Un riferimento a una tabella BigQuery.
studioDatasourceId

string

Un riferimento a un'origine dati di Looker Studio.
lookerExploreReference

object (LookerExploreReference)

Un riferimento a un'esplorazione di Looker.
bigqueryPropertyGraphReference

object (BigQueryPropertyGraphReference)

Un riferimento a un grafico delle proprietà BigQuery.

BigQueryPropertyGraphReference

Messaggio che rappresenta un riferimento a un singolo grafico delle proprietà BigQuery.

Rappresentazione JSON 
{
  "projectId": string,
  "datasetId": string,
  "propertyGraphId": string
}
Campi
projectId

string

Obbligatorio. Il progetto a cui appartiene il grafico delle proprietà.
datasetId

string

Obbligatorio. Il set di dati a cui appartiene il grafico delle proprietà.
propertyGraphId

string

Obbligatorio. L'ID del grafico delle proprietà.

DataMessage

Un messaggio prodotto durante il recupero dei dati.

Rappresentazione 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.
}
Campi
Campo unione kind. Indica se questo messaggio contiene la query, il risultato o l'SQL generato per il recupero dei dati. kind può essere solo uno dei seguenti tipi:
query

object (DataQuery)

Una query di recupero dei dati.
generatedSql

string

SQL generato dal sistema per recuperare i dati.
result

object (DataResult)

Dati recuperati.
bigQueryJob

object (BigQueryJob)

Un job BigQuery eseguito dal sistema per recuperare i dati.
matchedQuery

object (MatchedQuery)

Una query preesistente a cui è stata trovata una corrispondenza per recuperare i dati.

DataQuery

Una query per recuperare i dati.

Rappresentazione 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.
}
Campi
question

string

Facoltativo. Una domanda in linguaggio naturale a cui rispondere.
name

string

Facoltativo. Un nome in snake case per la query che riflette il suo intent. Viene utilizzato per denominare il risultato dei dati corrispondente, in modo che possa essere referenziato nei passaggi successivi.

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

object (Datasource)

Facoltativo. Le origini dati disponibili per rispondere alla domanda.
Campo unione query_type. Il tipo di query da eseguire. query_type può essere solo uno dei seguenti tipi:
looker

object (LookerQuery)

Facoltativo. Una query per recuperare i dati da un'esplorazione di Looker.

DataResult

Dati recuperati.

Rappresentazione JSON 
{
  "name": string,
  "schema": {
    object (Schema)
  },
  "data": [
    {
      object
    }
  ],
  "formattedData": [
    {
      object
    }
  ]
}
Campi
name

string

Facoltativo. Un nome in snake case per il risultato dei dati che riflette i suoi contenuti. Il nome viene utilizzato per passare il risultato per riferimento e funge da indicatore del suo significato.

  • Esempio: "total_sales_by_product"
  • Esempio: "sales_for_product_12345"
schema

object (Schema)

Facoltativo. Lo schema dei dati.
data[]

object (Struct format)

Facoltativo. Il contenuto dei dati. Ogni riga è una struct che corrisponde allo schema. I valori semplici sono rappresentati come stringhe, mentre le strutture nidificate sono rappresentate come elenchi o struct.
formattedData[]

object (Struct format)

Facoltativo. Rappresentazione formattata dei dati, se applicabile. Ogni riga è una struttura che corrisponde direttamente alla riga con lo stesso indice all'interno del campo data. I suoi valori sono rappresentazioni stringa dei dati originali, formattati in base alle specifiche dell'origine dati (ad es. "1234,56 $" per la valuta). Le colonne senza formattazione verranno impostate per impostazione predefinita sulla rappresentazione del valore non elaborato. Se nessuna colonna ha regole di formattazione, questo campo sarà vuoto.

BigQueryJob

Un job BigQuery eseguito dal sistema.

Rappresentazione JSON 
{
  "projectId": string,
  "jobId": string,
  "location": string,
  "destinationTable": {
    object (BigQueryTableReference)
  },
  "schema": {
    object (Schema)
  }
}
Campi
projectId

string

Obbligatorio. Il progetto a cui appartiene il job.

Vedi JobReference.
jobId

string

Obbligatorio. L'ID del job.

Vedi JobReference.
location

string

Facoltativo. La sede di lavoro.

Vedi JobReference.
destinationTable

object (BigQueryTableReference)

Facoltativo. Un riferimento alla tabella di destinazione dei risultati della query del job.

Consulta JobConfigurationQuery.
schema

object (Schema)

Facoltativo. Lo schema dei risultati della query del job.

Vedi JobStatistics2.

MatchedQuery

Un messaggio di query corrispondente indica che l'agente ha trovato una corrispondenza tra una delle query di esempio fornite nel contesto e la domanda attuale. Conterrà anche informazioni aggiuntive durante la procedura di corrispondenza.

Rappresentazione JSON 
{
  "exampleQuery": {
    object (ExampleQuery)
  },
  "queryParameterValues": [
    {
      object (QueryParameterValues)
    }
  ]
}
Campi
exampleQuery

object (ExampleQuery)

La query che è stata abbinata in base a una query di esempio.
queryParameterValues[]

object (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 dal LLM, in base alla query di esempio.

Rappresentazione JSON 
{
  "name": string,
  "value": string
}
Campi
name

string

Obbligatorio. Il nome del parametro.
value

string

Obbligatorio. Il valore del parametro.

AnalysisMessage

Un messaggio prodotto durante l'analisi.

Rappresentazione 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.
}
Campi
Campo unione kind. Indica se questo messaggio contiene la query o uno degli eventi dell'analisi. kind può essere solo uno dei seguenti tipi:
query

object (AnalysisQuery)

Una query di analisi.
progressEvent

object (AnalysisEvent)

Un evento che indica l'avanzamento dell'analisi.

AnalysisQuery

Una query per eseguire un'analisi.

Rappresentazione JSON 
{
  "question": string,
  "dataResultNames": [
    string
  ]
}
Campi
question

string

Facoltativo. Una domanda di analisi per rispondere alla domanda originale dell'utente.
dataResultNames[]

string

Facoltativo. I nomi dei risultati dei dati recuperati in precedenza da analizzare.

AnalysisEvent

Un evento che indica l'avanzamento di un'analisi.

Rappresentazione 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.
}
Campi
Campo unione kind. Il tipo di evento che si è verificato durante l'analisi. kind può essere solo uno dei seguenti tipi:
plannerReasoning

string

Motivazione del pianificatore di generazione del codice Python.
coderInstruction

string

Istruzioni emesse per la generazione del codice.
code

string

Codice generato.
executionOutput

string

Output dell'esecuzione del codice.
executionError

string

Un errore di esecuzione del codice.
resultVegaChartJson

string

Risultato come stringa JSON del grafico Vega.
resultNaturalLanguage

string

Risultato come stringa NL.
resultCsvData

string

Risultato come stringa CSV.
resultReferenceData

string

Risultato come riferimento a un'origine dati.
error

string

Un messaggio di errore generico.

ChartMessage

Un messaggio prodotto durante la generazione del grafico.

Rappresentazione 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.
}
Campi
Campo unione kind. Indica se questo messaggio contiene la query o il risultato della generazione del grafico. kind può essere solo uno dei seguenti tipi:
query

object (ChartQuery)

Una query per generare un grafico.
result

object (ChartResult)

Il risultato di una query di generazione del grafico.

ChartQuery

Una query per generare un grafico.

Rappresentazione JSON 
{
  "instructions": string,
  "dataResultName": string
}
Campi
instructions

string

Facoltativo. Istruzioni in linguaggio naturale per generare il grafico.
dataResultName

string

Facoltativo. Il nome di un risultato di dati recuperato in precedenza da utilizzare nel grafico.

ChartResult

Il risultato di una query di generazione del grafico.

Rappresentazione JSON 
{
  "vegaConfig": {
    object
  },
  "image": {
    object (Blob)
  }
}
Campi
vegaConfig

object (Struct format)

Facoltativo. Una configurazione del grafico Vega generata. Consulta https://vega.github.io/vega/docs/config/
image

object (Blob)

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

string

Obbligatorio. Il tipo MIME standard IANA dei dati del messaggio.
data

string (bytes format)

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 tentava di utilizzare uno strumento. È importante notare che non tutti gli errori sono irreversibili. Molti sono recuperabili e l'agente può utilizzare le informazioni di questo messaggio di errore per correggersi e riprovare la chiamata allo strumento o provare un approccio diverso.

Ad esempio, se una query di dati non va a buon fine, l'agente potrebbe ricevere un ErrorMessage, analizzarlo e poi generare una query corretta.

I client devono fare attenzione a interpretare questo messaggio come un errore definitivo. Può far parte del normale processo iterativo dell'agente di completamento di un'attività. Mostrare questi errori direttamente agli utenti finali senza contesto (ad es. come "errore irreversibile") può essere fuorviante.

Rappresentazione JSON 
{
  "text": string
}
Campi
text

string

Solo output. Il testo dell'errore.

ExampleQueries

Un messaggio contenente query di esempio derivate e create.

Rappresentazione JSON 
{
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
Campi
exampleQueries[]

object (ExampleQuery)

Facoltativo. Un elenco di query di esempio derivate e create, che forniscono esempi di query SQL pertinenti e di uso comune e, facoltativamente, le query in linguaggio naturale corrispondenti. Attualmente utilizzato solo per le origini dati BigQuery.

Citazione

Attribuzioni delle fonti per i contenuti.

Rappresentazione JSON 
{
  "sources": [
    {
      object (CitationSource)
    }
  ],
  "anchors": [
    {
      object (CitationAnchor)
    }
  ]
}
Campi
sources[]

object (CitationSource)

Solo output. Elenco delle fonti citate.
anchors[]

object (CitationAnchor)

Solo output. Elenco degli ancoraggi delle citazioni.

CitationSource

La fonte della citazione.

Rappresentazione 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.
}
Campi
id

string

Solo output. Identificatore univoco dell'origine. Questo ID viene generato dal servizio ed è univoco nell'ambito di un singolo messaggio Citation.
title

string

Solo output. Il titolo della fonte.
Campo unione source_type. L'origine della citazione, che può essere uno dei tipi supportati. source_type può essere solo uno dei seguenti tipi:
uri

string

Solo output. L'URI utilizzato come origine, ad esempio un URL di base web.
exampleQuery

object (ExampleQuery)

Solo output. La query di esempio utilizzata come origine.
glossaryTerm

object (GlossaryTerm)

Solo output. Il termine del glossario utilizzato come origine.

CitationAnchor

L'ancora della citazione.

Rappresentazione 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.
}
Campi
Campo unione anchor_type. L'ancora della citazione, che può essere uno dei tipi supportati. anchor_type può essere solo uno dei seguenti tipi:
textMessageAnchor

object (TextMessageCitationAnchor)

Solo output. Impostato solo se la citazione riguarda un TextMessage.

TextMessageCitationAnchor

Ancora di citazione all'interno di un TextMessage.

Rappresentazione JSON 
{
  "partIndex": integer,
  "startOffsetBytes": integer,
  "endOffsetBytes": integer,
  "sourceIds": [
    string
  ]
}
Campi
partIndex

integer

Solo output. L'indice in base 0 della parte all'interno del campo TextMessage.parts.
startOffsetBytes

integer

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 citata la parola "world", i byte di offset iniziale (inclusi) sono 7 e i byte di offset finale (esclusi) sono 12.
endOffsetBytes

integer

Solo output. L'offset, misurato in byte UTF-8, all'interno della stringa della parte in cui termina la citazione (esclusiva). Esempio: per il testo "Hello, world" in cui viene citata la parola "world", i byte di offset iniziale (inclusi) sono 7 e i byte di offset finale (esclusi) sono 12.
sourceIds[]

string

Solo output. Gli ID delle fonti citate.