- Representação 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
- Citação
- CitationSource
- CitationAnchor
- TextMessageCitationAnchor
Mensagem de uma interação entre o usuário e o sistema.
| Representação 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 ( |
| Campos | |
|---|---|
timestamp |
Apenas saída. Para mensagens do usuário, é o momento em que o sistema recebeu a mensagem. Para mensagens do sistema, é o horário em que o sistema gerou a mensagem. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: |
messageId |
Opcional. ID exclusivo da mensagem na conversa para persistência. |
| O tipo de mensagem. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
userMessage |
Mensagem do usuário que está interagindo com o sistema. |
systemMessage |
Mensagem do sistema em resposta ao usuário. |
| Fim dos campos mutuamente exclusivos. | |
UserMessage
Mensagem do usuário que está interagindo com o sistema.
| Representação 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. } |
| Campos | |
|---|---|
| O tipo de conteúdo na mensagem do usuário. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
text |
O texto precisa usar esse campo em vez de blob. |
| Fim dos campos mutuamente exclusivos. | |
SystemMessage
Mensagem do sistema em resposta ao usuário. Essa mensagem também pode ser do usuário como contexto histórico para conversas de várias interações com o sistema.
| Representação JSON |
|---|
{ "citation": { object ( |
| Campos | |
|---|---|
citation |
Apenas saída. Informações de citação da mensagem do sistema. |
| O tipo de conteúdo na mensagem do sistema. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
text |
Uma resposta direta em linguagem natural à mensagem do usuário. |
schema |
Uma mensagem produzida durante a resolução do esquema. |
data |
Uma mensagem produzida durante a recuperação de dados. |
analysis |
Uma mensagem gerada durante a análise. |
chart |
Uma mensagem produzida durante a geração de gráficos. |
error |
Uma mensagem de erro. |
exampleQueries |
Opcional. Uma mensagem com exemplos de consultas. |
clarification |
Opcional. Descontinuado: use TextMessage com TextType.FINAL_RESPONSE. Uma mensagem com perguntas de esclarecimento. |
| Fim dos campos mutuamente exclusivos. | |
groupId |
Identifica o grupo a que o evento pertence. Eventos semelhantes são considerados logicamente relevantes entre si e devem ser mostrados juntos na interface. |
TextMessage
Uma mensagem de texto de várias partes.
| Representação JSON |
|---|
{
"parts": [
string
],
"textType": enum ( |
| Campos | |
|---|---|
parts[] |
Opcional. As partes da mensagem. |
textType |
Opcional. O tipo da mensagem de texto. |
thoughtSignature |
Opcional. Uma assinatura opaca para um pensamento, para que ele possa ser reutilizado em solicitações subsequentes. Uma string codificada em base64. |
TextType
O tipo da mensagem de texto.
| Tipos enumerados | |
|---|---|
TEXT_TYPE_UNSPECIFIED |
O tipo de texto padrão. |
FINAL_RESPONSE |
O texto é uma resposta final à pergunta do usuário. |
THOUGHT |
O texto é um pensamento do modelo. |
PROGRESS |
O texto é uma mensagem informativa sobre o progresso do agente, como uma ferramenta sendo invocada. Isso é diferente do processo de raciocínio interno do agente (THOUGHT) e da resposta final ao usuário (FINAL_RESPONSE). Essas mensagens dão insights sobre as ações do agente. |
FOLLOWUP_QUESTIONS |
O texto é uma lista de perguntas complementares sugeridas. Cada item em parts é uma pergunta complementar. |
SchemaMessage
Uma mensagem produzida durante a resolução do esquema.
| Representação JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Campos | |
|---|---|
| Se esta mensagem contém a consulta ou o resultado da resolução do esquema. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
query |
Uma consulta de resolução do esquema. |
result |
O resultado de uma consulta de resolução do esquema. |
| Fim dos campos mutuamente exclusivos. | |
SchemaQuery
Uma consulta para resolver o esquema relevante para a pergunta feita.
| Representação JSON |
|---|
{ "question": string } |
| Campos | |
|---|---|
question |
Opcional. A pergunta a ser enviada ao sistema para resolução do esquema. |
SchemaResult
O resultado da resolução do esquema.
| Representação JSON |
|---|
{
"datasources": [
{
object ( |
| Campos | |
|---|---|
datasources[] |
Opcional. As fontes de dados usadas para resolver a consulta do esquema. |
Datasource
Fonte de dados que pode ser usada para responder a perguntas.
| Representação JSON |
|---|
{ "schema": { object ( |
| Campos | |
|---|---|
schema |
Opcional. É o esquema da fonte de dados. |
structSchema |
Opcional. Uma representação de struct do esquema. Isso é preenchido para fontes de dados com esquemas que não podem ser totalmente representados pelo campo Para fontes de dados do Looker, isso é mapeado para o tipo LookmlModelExplore: https://cloud.google.com/looker/docs/reference/looker-api/latest/types/LookmlModelExplore |
| A referência à fonte de dados. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
bigqueryTableReference |
Referência a uma tabela do BigQuery. |
studioDatasourceId |
Referência a uma fonte de dados do Looker Studio. |
lookerExploreReference |
Referência a uma Análise do Looker. |
alloyDbReference |
Uma referência a um banco de dados do AlloyDB. |
spannerReference |
Uma referência a um banco de dados do Spanner. |
cloudSqlReference |
Uma referência a um banco de dados do Cloud SQL. |
bigtableReference |
Uma referência a uma instância do Bigtable. |
bigqueryPropertyGraphReference |
Uma referência a um gráfico de propriedades do BigQuery. |
firestoreReference |
Uma referência a um banco de dados do Firestore. |
| Fim dos campos mutuamente exclusivos. | |
DataMessage
Uma mensagem produzida durante a recuperação de dados.
| Representação JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Campos | |
|---|---|
| Se esta mensagem contém a consulta, o resultado ou o SQL gerado para a recuperação de dados. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
query |
Uma consulta de recuperação de dados. |
generatedSql |
SQL gerado pelo sistema para recuperar dados. |
result |
Dados recuperados. |
generatedLookerQuery |
Descontinuado: a consulta gerada do Looker agora está em DataQuery.looker. Consulta do Looker gerada pelo sistema para recuperar dados. |
bigQueryJob |
Um job do BigQuery executado pelo sistema para recuperar dados. |
matchedQuery |
Uma consulta preexistente que foi correspondida para recuperar dados. |
| Fim dos campos mutuamente exclusivos. | |
DataQuery
Uma consulta para recuperar dados.
| Representação JSON |
|---|
{ "question": string, "name": string, "datasources": [ { object ( |
| Campos | |
|---|---|
question |
Opcional. Uma pergunta em linguagem natural para responder. |
name |
Opcional. Um nome em formato snake case para a consulta que reflete a intenção dela. É usado para nomear o resultado de dados correspondente e, assim, ser referenciado nas etapas posteriores.
|
datasources[] |
Opcional. As fontes de dados disponíveis para responder a pergunta. |
| O tipo de consulta a ser executada. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
looker |
Opcional. Consulta para recuperar dados de uma Análise do Looker. |
| Fim dos campos mutuamente exclusivos. | |
DataResult
Dados recuperados.
| Representação JSON |
|---|
{
"name": string,
"schema": {
object ( |
| Campos | |
|---|---|
name |
Opcional. Um nome em formato snake case para o resultado de dados que reflete o conteúdo dele. O nome é usado para transmitir o resultado por referência e serve como um indicador do significado dele.
|
schema |
Opcional. O esquema dos dados. |
data[] |
Opcional. O conteúdo dos dados. Cada linha é um struct que corresponde ao esquema. Valores simples são representados como strings, enquanto estruturas aninhadas são representadas como listas ou structs. |
formattedData[] |
Opcional. Representação formatada dos dados, quando aplicável. Cada linha é um struct que corresponde diretamente à linha no mesmo índice dentro do campo |
BigQueryJob
Um job do BigQuery executado pelo sistema.
| Representação JSON |
|---|
{ "projectId": string, "jobId": string, "location": string, "destinationTable": { object ( |
| Campos | |
|---|---|
projectId |
Obrigatório. O projeto a que o job pertence. Consulte JobReference. |
jobId |
Obrigatório. O ID do job. Consulte JobReference. |
location |
Opcional. O local do job. Consulte JobReference. |
destinationTable |
Opcional. Uma referência à tabela de destino dos resultados da consulta do job. Consulte JobConfigurationQuery. |
schema |
Opcional. O esquema dos resultados da consulta do job. Consulte JobStatistics2. |
MatchedQuery
Uma query message correspondente representa que o agente identificou uma das consultas de exemplo fornecidas no contexto como aplicável à pergunta atual. Ele também vai conter outras informações durante o processo de correspondência.
| Representação JSON |
|---|
{ "exampleQuery": { object ( |
| Campos | |
|---|---|
exampleQuery |
A consulta que foi correspondida com base em uma consulta de exemplo. |
queryParameterValues[] |
Os valores extraídos para os parâmetros de consulta. |
QueryParameterValues
Uma mensagem de valores de parâmetro de consulta representa os valores dos parâmetros de consulta que foram extraídos da pergunta do usuário pelo LLM, com base na consulta de exemplo.
| Representação JSON |
|---|
{ "name": string, "value": string } |
| Campos | |
|---|---|
name |
Obrigatório. O nome do parâmetro. |
value |
Obrigatório. O valor do parâmetro. |
AnalysisMessage
Uma mensagem gerada durante a análise.
| Representação JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Campos | |
|---|---|
| Se esta mensagem contém a consulta ou um dos eventos da análise. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
query |
Uma consulta de análise. |
progressEvent |
Um evento que indica o progresso da análise. |
| Fim dos campos mutuamente exclusivos. | |
AnalysisQuery
Consulta para realizar uma análise.
| Representação JSON |
|---|
{ "question": string, "dataResultNames": [ string ] } |
| Campos | |
|---|---|
question |
Opcional. Uma pergunta de análise para ajudar a responder a pergunta original do usuário. |
dataResultNames[] |
Opcional. Os nomes dos resultados de dados recuperados anteriormente para análise. |
AnalysisEvent
Evento que indica o progresso de uma análise.
| Representação 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. } |
| Campos | |
|---|---|
| O tipo de evento que ocorreu durante a análise. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
plannerReasoning |
Raciocínio do planejador de codegen do Python. |
coderInstruction |
Instruções para geração de código. |
code |
Código gerado. |
executionOutput |
Saída da execução de código. |
executionError |
Um erro da execução de código. |
resultVegaChartJson |
Resultado como uma string JSON de gráfico Vega. |
resultNaturalLanguage |
Resultado como string em linguagem natural. |
resultCsvData |
Resultado como string CSV. |
resultReferenceData |
Resultado como uma referência a uma fonte de dados. |
error |
Uma mensagem de erro genérica. |
| Fim dos campos mutuamente exclusivos. | |
ChartMessage
Uma mensagem produzida durante a geração de gráficos.
| Representação JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Campos | |
|---|---|
| Se esta mensagem contém a consulta ou o resultado da geração do gráfico. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
query |
Consulta para gerar um gráfico. |
result |
O resultado de uma consulta de geração de gráficos. |
| Fim dos campos mutuamente exclusivos. | |
ChartQuery
Consulta para gerar um gráfico.
| Representação JSON |
|---|
{ "instructions": string, "dataResultName": string } |
| Campos | |
|---|---|
instructions |
Opcional. Instruções em linguagem natural para gerar o gráfico. |
dataResultName |
Opcional. O nome de um resultado de dados recuperado anteriormente para usar no gráfico. |
ChartResult
O resultado de uma consulta de geração de gráficos.
| Representação JSON |
|---|
{
"vegaConfig": {
object
},
"image": {
object ( |
| Campos | |
|---|---|
vegaConfig |
Opcional. Uma configuração de gráfico Vega gerada. Consulte https://vega.github.io/vega/docs/config/ |
image |
Opcional. Uma renderização do gráfico, se isso foi solicitado no contexto. |
Blob
Um blob de dados com um tipo MIME.
| Representação JSON |
|---|
{ "mimeType": string, "data": string } |
| Campos | |
|---|---|
mimeType |
Obrigatório. O tipo MIME padrão da IANA dos dados da mensagem. |
data |
Obrigatório. Os dados representados como bytes. Uma string codificada em base64. |
ErrorMessage
Uma mensagem de erro de uma chamada de ferramenta. Esta mensagem é usada para representar um erro que ocorreu enquanto um agente tentava usar uma ferramenta. É importante observar que nem todos os erros são terminais. Muitos são recuperáveis, e o agente pode usar as informações dessa mensagem de erro para se autocorrigir e tentar novamente a chamada de ferramenta ou tentar uma abordagem diferente.
Por exemplo, se uma consulta de dados falhar, o agente poderá receber um ErrorMessage, analisá-lo e gerar uma consulta corrigida.
Os clientes devem ter cuidado ao interpretar essa mensagem como uma falha definitiva. Isso pode fazer parte do processo normal e iterativo do agente para concluir uma tarefa. Mostrar esses erros diretamente aos usuários finais sem contexto (por exemplo, como uma "falha grave") pode ser enganoso.
| Representação JSON |
|---|
{ "text": string } |
| Campos | |
|---|---|
text |
Apenas saída. O texto do erro. |
ExampleQueries
Uma mensagem que contém exemplos de consultas derivadas e criadas.
| Representação JSON |
|---|
{
"exampleQueries": [
{
object ( |
| Campos | |
|---|---|
exampleQueries[] |
Opcional. Uma lista de exemplos de consultas derivadas e criadas, com exemplos de consultas SQL relevantes e usadas com frequência e as consultas correspondentes em linguagem natural, se disponíveis. No momento, usado apenas para fontes de dados do BigQuery. |
ClarificationMessage
Descontinuado: use TextMessage com TextType.FINAL_RESPONSE. Uma mensagem com perguntas para ajudar a esclarecer a consulta do usuário. Isso é retornado quando o sistema não consegue responder à pergunta do usuário com confiança.
| Representação JSON |
|---|
{
"questions": [
{
object ( |
| Campos | |
|---|---|
questions[] |
Obrigatório. Descontinuado: a mensagem pai foi descontinuada. Um conjunto de perguntas de esclarecimento para fazer ao usuário. |
ClarificationQuestion
Descontinuado: use TextMessage com TextType.FINAL_RESPONSE. Representa uma única pergunta ao usuário para ajudar a esclarecer a consulta.
| Representação JSON |
|---|
{ "question": string, "selectionMode": enum ( |
| Campos | |
|---|---|
question |
Obrigatório. Descontinuado: a mensagem pai foi descontinuada. A pergunta em linguagem natural que será feita ao usuário. |
selectionMode |
Obrigatório. Descontinuado: a mensagem pai foi descontinuada. O modo de seleção para esta pergunta. |
options[] |
Obrigatório. Descontinuado: a mensagem pai foi descontinuada. Uma lista de opções distintas para o usuário escolher. O número de opções é limitado a no máximo 5. |
clarificationQuestionType |
Opcional. Descontinuado: a mensagem pai foi descontinuada. O tipo de pergunta de esclarecimento. |
SelectionMode
Descontinuado: a mensagem pai foi descontinuada. O modo de seleção para a pergunta de esclarecimento.
| Tipos enumerados | |
|---|---|
SELECTION_MODE_UNSPECIFIED |
Descontinuado: a mensagem pai foi descontinuada. Modo de seleção não especificado. |
SINGLE_SELECT |
Descontinuado: a mensagem pai foi descontinuada. O usuário só pode selecionar uma opção. |
MULTI_SELECT |
Descontinuado: a mensagem pai foi descontinuada. O usuário pode selecionar várias opções. |
ClarificationQuestionType
Descontinuado: a mensagem pai foi descontinuada. O tipo de pergunta de esclarecimento. Esse tipo enumerado pode ser estendido com novos valores no futuro.
| Tipos enumerados | |
|---|---|
CLARIFICATION_QUESTION_TYPE_UNSPECIFIED |
Descontinuado: a mensagem pai foi descontinuada. Tipo de pergunta de esclarecimento não especificado. |
FILTER_VALUES |
Descontinuado: a mensagem pai foi descontinuada. A pergunta de esclarecimento é para valores de filtro. |
FIELDS |
Descontinuado: a mensagem pai foi descontinuada. A pergunta de esclarecimento é para campos de dados. Esse é um termo genérico que abrange colunas SQL, campos do Looker (dimensões/medidas) ou propriedades de estrutura de dados aninhadas. |
Citação
Atribuições de origem para o conteúdo.
| Representação JSON |
|---|
{ "sources": [ { object ( |
| Campos | |
|---|---|
sources[] |
Apenas saída. Lista das fontes citadas. |
anchors[] |
Apenas saída. Lista de âncoras das citações. |
CitationSource
A origem da citação.
| Representação 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 ( |
| Campos | |
|---|---|
id |
Apenas saída. Identificador exclusivo da origem. Esse ID é gerado pelo serviço e é exclusivo no escopo de uma única mensagem |
title |
Apenas saída. O título da fonte. |
| A fonte da citação, que pode ser um dos tipos aceitos. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
uri |
Apenas saída. O URI usado como origem, como um URL de embasamento na Web. |
exampleQuery |
Apenas saída. A consulta de exemplo usada como origem. |
glossaryTerm |
Apenas saída. O termo do glossário usado como origem. |
| Fim dos campos mutuamente exclusivos. | |
CitationAnchor
A âncora da citação.
| Representação JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"textMessageAnchor": {
object ( |
| Campos | |
|---|---|
| A âncora da citação, que pode ser um dos tipos aceitos. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
textMessageAnchor |
Apenas saída. Definido apenas se a citação for para uma TextMessage. |
| Fim dos campos mutuamente exclusivos. | |
TextMessageCitationAnchor
Âncora de citação em uma TextMessage.
| Representação JSON |
|---|
{ "partIndex": integer, "startOffsetBytes": integer, "endOffsetBytes": integer, "sourceIds": [ string ] } |
| Campos | |
|---|---|
partIndex |
Apenas saída. O índice baseado em 0 da parte no campo TextMessage.parts. |
startOffsetBytes |
Apenas saída. O deslocamento, medido em bytes UTF-8, dentro da string de parte em que a citação começa (inclusive). Exemplo: para o texto "Hello, world", em que "world" é citado, os bytes de deslocamento inicial (inclusive) são 7 e os bytes de deslocamento final (exclusivo) são 12. |
endOffsetBytes |
Apenas saída. O deslocamento, medido em bytes UTF-8, dentro da string de parte em que a citação termina (exclusiva). Exemplo: para o texto "Hello, world", em que "world" é citado, os bytes de deslocamento inicial (inclusive) são 7 e os bytes de deslocamento final (exclusivo) são 12. |
sourceIds[] |
Apenas saída. Os IDs das fontes citadas. |