Message

Uma mensagem de uma interação entre o utilizador e o sistema.

Representação 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.
}
Campos
timestamp

string (Timestamp format)

Apenas saída. Para mensagens de utilizadores, esta é a hora em que o sistema recebeu a mensagem. Para mensagens do sistema, esta é a hora em que o sistema gerou a mensagem.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
messageId

string

Opcional. ID exclusivo da mensagem na conversa para persistência.
Campo de união kind. O tipo de mensagem. kind só pode ser uma das seguintes opções:
userMessage

object (UserMessage)

Uma mensagem do utilizador que está a interagir com o sistema.
systemMessage

object (SystemMessage)

Uma mensagem do sistema em resposta ao utilizador.

UserMessage

Uma mensagem do utilizador que está a interagir com o sistema.

Representação JSON 
{

  // Union field kind can be only one of the following:
  "text": string
  // End of list of possible types for union field kind.
}
Campos
Campo de união kind. O tipo de conteúdo na mensagem do utilizador. kind só pode ser uma das seguintes opções:
text

string

O texto deve usar este campo em vez de blob.

SystemMessage

Uma mensagem do sistema em resposta ao utilizador. Esta mensagem também pode ser uma mensagem do utilizador como contexto histórico para conversas com várias interações com o sistema.

Representação JSON 
{

  // 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
}
Campos
Campo de união kind. O tipo de conteúdo na mensagem do sistema. kind só pode ser uma das seguintes opções:
text

object (TextMessage)

Uma resposta direta em linguagem natural à mensagem do utilizador.
schema

object (SchemaMessage)

Uma mensagem produzida durante a resolução do esquema.
data

object (DataMessage)

Uma mensagem produzida durante a obtenção de dados.
analysis

object (AnalysisMessage)

Uma mensagem produzida durante a análise.
chart

object (ChartMessage)

Uma mensagem produzida durante a geração do gráfico.
error

object (ErrorMessage)

Uma mensagem de erro.
exampleQueries

object (ExampleQueries)

Opcional. Uma mensagem com exemplos de consultas.
groupId

integer

Identifica o grupo ao qual o evento pertence. Os eventos semelhantes são considerados logicamente relevantes entre si e devem ser apresentados em conjunto na IU.

TextMessage

Uma mensagem de texto multipartes.

Representação JSON 
{
  "parts": [
    string
  ],
  "textType": enum (TextType)
}
Campos
parts[]

string

Opcional. As partes da mensagem.
textType

enum (TextType)

Opcional. O tipo de mensagem de texto.

TextType

O tipo de mensagem de texto.

Enumerações
TEXT_TYPE_UNSPECIFIED O tipo de texto predefinido.
FINAL_RESPONSE O texto é uma resposta final à pergunta do utilizador.
THOUGHT O texto é um plano de raciocínio gerado pela ferramenta de raciocínio.

SchemaMessage

Uma mensagem produzida durante a resolução do esquema.

Representação 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.
}
Campos
Campo de união kind. Se esta mensagem contém a consulta ou o resultado da resolução do esquema. kind só pode ser uma das seguintes opções:
query

object (SchemaQuery)

Uma consulta de resolução de esquemas.
result

object (SchemaResult)

O resultado de uma consulta de resolução de esquemas.

SchemaQuery

Uma consulta para resolver o esquema relevante para a pergunta apresentada.

Representação JSON 
{
  "question": string
}
Campos
question

string

Opcional. A pergunta a enviar ao sistema para resolução do esquema.

SchemaResult

O resultado da resolução do esquema.

Representação JSON 
{
  "datasources": [
    {
      object (Datasource)
    }
  ]
}
Campos
datasources[]

object (Datasource)

Opcional. As origens de dados usadas para resolver a consulta de esquema.

Origem de dados

Uma origem de dados que pode ser usada para responder a perguntas.

Representação JSON 
{
  "schema": {
    object (Schema)
  },

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

object (Schema)

Opcional. O esquema da origem de dados.
Campo de união reference. A referência à origem de dados. reference só pode ser uma das seguintes opções:
bigqueryTableReference

object (BigQueryTableReference)

Uma referência a uma tabela do BigQuery.
studioDatasourceId

string

Uma referência a uma origem de dados do Looker Studio.
lookerExploreReference

object (LookerExploreReference)

Uma referência a uma opção Explorar do Looker.

DataMessage

Uma mensagem produzida durante a obtenção de dados.

Representação JSON 
{

  // Union field kind can be only one of the following:
  "query": {
    object (DataQuery)
  },
  "generatedSql": string,
  "result": {
    object (DataResult)
  },
  "generatedLookerQuery": {
    object (LookerQuery)
  },
  "bigQueryJob": {
    object (BigQueryJob)
  }
  // End of list of possible types for union field kind.
}
Campos
Campo de união kind. Se esta mensagem contém a consulta, o resultado ou o SQL gerado para a obtenção de dados. kind só pode ser uma das seguintes opções:
query

object (DataQuery)

Uma consulta de obtenção de dados.
generatedSql

string

SQL gerado pelo sistema para obter dados.
result

object (DataResult)

Dados obtidos.
generatedLookerQuery
(deprecated)

object (LookerQuery)

Consulta do Looker gerada pelo sistema para obter dados. DESCONTINUADO: a consulta do Looker gerada encontra-se agora em DataQuery.looker.
bigQueryJob

object (BigQueryJob)

Uma tarefa do BigQuery executada pelo sistema para obter dados.

DataQuery

Uma consulta para obter dados.

Representação 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.
}
Campos
question

string

Opcional. Uma pergunta em linguagem natural para responder.
name

string

Opcional. Um nome em snake case para a consulta que reflete a respetiva intenção. É usado para dar um nome ao resultado dos dados correspondente, para que possa ser referenciado em passos posteriores.

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

object (Datasource)

Opcional. As origens de dados disponíveis para responder à pergunta.
Campo de união query_type. O tipo de consulta a executar. query_type só pode ser uma das seguintes opções:
looker

object (LookerQuery)

Opcional. Uma consulta para obter dados de uma exploração do Looker.

LookerQuery

Uma consulta para obter dados de uma função Explorar do Looker. Consulte o artigo Execute uma consulta inline.

Representação JSON 
{
  "model": string,
  "explore": string,
  "fields": [
    string
  ],
  "filters": [
    {
      object (Filter)
    }
  ],
  "sorts": [
    string
  ],
  "limit": string
}
Campos
model

string

Obrigatório. O modelo do LookML usado para gerar a consulta.
explore

string

Obrigatório. A análise detalhada do LookML usada para gerar a consulta.
fields[]

string

Opcional. Os campos a obter a partir da funcionalidade Explorar.
filters[]

object (Filter)

Opcional. Os filtros a aplicar à análise detalhada.
sorts[]

string

Opcional. As ordenações a aplicar à exploração.
limit

string

Opcional. Limite na consulta.

Filtro

Um filtro de consulta do Looker.

Representação JSON 
{
  "field": string,
  "value": string
}
Campos
field

string

Obrigatório. O campo a filtrar.
value

string

Obrigatório. O campo de valor f pelo qual filtrar.

DataResult

Dados obtidos.

Representação JSON 
{
  "name": string,
  "schema": {
    object (Schema)
  },
  "data": [
    {
      object
    }
  ]
}
Campos
name

string

Opcional. Um nome em snake_case para o resultado de dados que reflete o respetivo conteúdo. O nome é usado para transmitir o resultado por referência e serve como um sinal sobre o seu significado.

  • Exemplo: "total_sales_by_product"
  • Exemplo: "sales_for_product_12345"
schema

object (Schema)

Opcional. O esquema dos dados.
data[]

object (Struct format)

Opcional. O conteúdo dos dados. Cada linha é uma struct que corresponde ao esquema. Os valores simples são representados como strings, enquanto as estruturas aninhadas são representadas como listas ou structs.

BigQueryJob

Uma tarefa do BigQuery executada pelo sistema.

Representação JSON 
{
  "projectId": string,
  "jobId": string,
  "location": string,
  "destinationTable": {
    object (BigQueryTableReference)
  },
  "schema": {
    object (Schema)
  }
}
Campos
projectId

string

Obrigatório. O projeto ao qual a tarefa pertence.

Consulte JobReference.
jobId

string

Obrigatório. O ID da tarefa.

Consulte JobReference.
location

string

Opcional. A localização do trabalho.

Consulte JobReference.
destinationTable

object (BigQueryTableReference)

Opcional. Uma referência à tabela de destino dos resultados da consulta da tarefa.

Consulte JobConfigurationQuery.
schema

object (Schema)

Opcional. O esquema dos resultados da consulta da tarefa.

Consulte JobStatistics2.

AnalysisMessage

Uma mensagem produzida durante a análise.

Representação 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.
}
Campos
Campo de união kind. Se esta mensagem contém a consulta ou um dos eventos da análise. kind só pode ser uma das seguintes opções:
query

object (AnalysisQuery)

Uma consulta de análise.
progressEvent

object (AnalysisEvent)

Um evento que indica o progresso da análise.

AnalysisQuery

Uma consulta para realizar uma análise.

Representação JSON 
{
  "question": string,
  "dataResultNames": [
    string
  ]
}
Campos
question

string

Opcional. Uma pergunta de análise para ajudar a responder à pergunta original do utilizador.
dataResultNames[]

string

Opcional. Os nomes dos resultados de dados obtidos anteriormente para analisar.

AnalysisEvent

Um evento que indica o progresso de uma análise.

Representação 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.
}
Campos
Campo de união kind. O tipo de evento que ocorreu durante a análise. kind só pode ser uma das seguintes opções:
plannerReasoning

string

Raciocínio do planeador de geração de código Python.
coderInstruction

string

Instruções emitidas para a geração de código.
code

string

Código gerado.
executionOutput

string

Resultado da execução de código.
executionError

string

Um erro da execução de código.
resultVegaChartJson

string

Resultado como string JSON do gráfico Vega.
resultNaturalLanguage

string

Resultado como string de NL.
resultCsvData

string

Resultado como string CSV.
resultReferenceData

string

Resultado como referência a uma origem de dados.
error

string

Uma mensagem de erro genérica.

ChartMessage

Uma mensagem produzida durante a geração do gráfico.

Representação 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.
}
Campos
Campo de união kind. Se esta mensagem contém a consulta ou o resultado da geração do gráfico. kind só pode ser uma das seguintes opções:
query

object (ChartQuery)

Uma consulta para gerar um gráfico.
result

object (ChartResult)

O resultado de uma consulta de geração de gráficos.

ChartQuery

Uma consulta para gerar um gráfico.

Representação JSON 
{
  "instructions": string,
  "dataResultName": string
}
Campos
instructions

string

Opcional. Instruções em linguagem natural para gerar o gráfico.
dataResultName

string

Opcional. O nome de um resultado de dados obtido 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 (Blob)
  }
}
Campos
vegaConfig

object (Struct format)

Opcional. Uma configuração de gráfico Vega gerada. Consulte https://vega.github.io/vega/docs/config/
image

object (Blob)

Opcional. Uma representação do gráfico, se tal tiver sido pedido no contexto.

Blob

Um blob de dados com um tipo MIME.

Representação JSON 
{
  "mimeType": string,
  "data": string
}
Campos
mimeType

string

Obrigatório. O tipo MIME padrão da IANA dos dados da mensagem.
data

string (bytes format)

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 ter em atenção que nem todos os erros são terminais. Muitos são recuperáveis e o agente pode usar as informações desta mensagem de erro para se corrigir automaticamente e tentar novamente a chamada de ferramenta ou experimentar uma abordagem diferente.

Por exemplo, se uma consulta de dados falhar, o agente pode receber um ErrorMessage, analisá-lo e, em seguida, gerar uma consulta corrigida.

Os clientes devem ter cuidado ao interpretar esta mensagem como uma falha definitiva. Pode fazer parte do processo normal e iterativo do agente para concluir uma tarefa. A apresentação destes erros diretamente aos utilizadores finais sem contexto (por exemplo, como uma "falha grave") pode ser enganadora.

Representação JSON 
{
  "text": string
}
Campos
text

string

Apenas saída. O texto do erro.

ExampleQueries

Uma mensagem que contém consultas de exemplo derivadas e criadas.

Representação JSON 
{
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
Campos
exampleQueries[]

object (ExampleQuery)

Opcional. Uma lista de consultas de exemplo derivadas e criadas, que fornece exemplos de consultas SQL relevantes e usadas com frequência, e as respetivas consultas de linguagem natural, opcionalmente presentes. Atualmente, apenas é usado para origens de dados do BigQuery.