Message

Uma mensagem de uma interação entre o usuário 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 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: "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 pode ser apenas de um dos tipos a seguir:
userMessage

object (UserMessage)

Uma mensagem do usuário que está interagindo com o sistema.
systemMessage

object (SystemMessage)

Uma mensagem do sistema em resposta ao usuário.

UserMessage

Uma mensagem do usuário que está interagindo 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 usuário. kind pode ser apenas de um dos tipos a seguir:
text

string

O texto precisa usar esse campo em vez de blob.

SystemMessage

Uma 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 rodadas 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)
  }
  // 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 pode ser apenas de um dos tipos a seguir:
text

object (TextMessage)

Uma resposta direta em linguagem natural à mensagem do usuário.
schema

object (SchemaMessage)

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

object (DataMessage)

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

object (AnalysisMessage)

Uma mensagem gerada durante a análise.
chart

object (ChartMessage)

Uma mensagem produzida durante a geração de gráficos.
error

object (ErrorMessage)

Uma mensagem de erro.
groupId

integer

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
  ]
}
Campos
parts[]

string

Opcional. As partes da mensagem.

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 pode ser apenas de um dos tipos a seguir:
query

object (SchemaQuery)

Uma consulta de resolução de esquema.
result

object (SchemaResult)

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

SchemaQuery

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

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

string

Opcional. A pergunta a ser enviada ao sistema para resolução de esquema.

SchemaResult

O resultado da resolução do esquema.

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

object (Datasource)

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

Fonte de dados

Uma fonte 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 fonte de dados.
Campo de união reference. A referência à fonte de dados. reference pode ser apenas de um dos tipos a seguir:
bigqueryTableReference

object (BigQueryTableReference)

Uma referência a uma tabela do BigQuery.
studioDatasourceId

string

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

object (LookerExploreReference)

Uma referência a uma Análise do Looker.

DataMessage

Uma mensagem produzida durante a recuperaçã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 extração de dados. kind pode ser apenas de um dos tipos a seguir:
query

object (DataQuery)

Uma consulta de recuperação de dados.
generatedSql

string

SQL gerado pelo sistema para recuperar dados.
result

object (DataResult)

Dados recuperados.
generatedLookerQuery

object (LookerQuery)

Consulta do Looker gerada pelo sistema para recuperar dados.
bigQueryJob

object (BigQueryJob)

Um job do BigQuery executado pelo sistema para recuperar dados.

DataQuery

Uma consulta para recuperar dados.

Representação JSON 
{
  "question": string,
  "name": string,
  "datasources": [
    {
      object (Datasource)
    }
  ]
}
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 intenção dela. Ele é usado para nomear o resultado de dados correspondente, para que possa ser referenciado em etapas posteriores.

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

object (Datasource)

Opcional. As fontes de dados disponíveis para responder à pergunta.

DataResult

Dados recuperados.

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 conteúdo dele. O nome é usado para transmitir o resultado por referência e serve como um indicador do significado dele.

  • 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. Valores simples são representados como strings, enquanto estruturas aninhadas são representadas como listas ou structs.

LookerQuery

Uma consulta para recuperar dados de uma Análise do Looker. Consulte Executar 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 LookML usado para gerar a consulta.
explore

string

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

string

Opcional. Os campos a serem recuperados da análise detalhada.
filters[]

object (Filter)

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

string

Opcional. As classificações a serem aplicadas à análise.
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 ser filtrado.
value

string

Obrigatório. O campo de valor para filtrar.

BigQueryJob

Um job do BigQuery executado pelo sistema.

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

string

Obrigatório. O projeto a que o job pertence.

Consulte JobReference.
jobId

string

Obrigatório. O ID do job.

Consulte JobReference.
location

string

Opcional. O local do job.

Consulte JobReference.
destinationTable

object (BigQueryTableReference)

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

Consulte JobConfigurationQuery.
schema

object (Schema)

Opcional. O esquema dos resultados da consulta do job.

Consulte JobStatistics2.

AnalysisMessage

Uma mensagem gerada 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 pode ser apenas de um dos tipos a seguir:
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 usuário.
dataResultNames[]

string

Opcional. Os nomes dos resultados de dados recuperados anteriormente para análise.

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 pode ser apenas de um dos tipos a seguir:
plannerReasoning

string

Raciocínio do planejador de codegen do Python.
coderInstruction

string

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

string

Código gerado.
executionOutput

string

Saída da execução do código.
executionError

string

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

string

Resultado como uma string JSON de gráfico do Vega.
resultNaturalLanguage

string

Resultado como string em linguagem natural.
resultCsvData

string

Resultado como string CSV.
resultReferenceData

string

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

string

Uma mensagem de erro genérica.

ChartMessage

Uma mensagem produzida durante a geração de gráficos.

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 pode ser apenas de um dos tipos a seguir:
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 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 (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 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

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.

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

string

Apenas saída. O texto do erro.