- Representação JSON
- Mensagem do usuário
- Mensagem do Sistema
- Mensagem de texto
- Mensagem de esquema
- SchemaQuery
- SchemaResult
- Fonte de dados
- Mensagem de dados
- Consulta de dados
- Resultado de dados
- Consulta do Looker
- Filtro
- Trabalho do BigQuery
- AnáliseMensagem
- AnáliseConsulta
- AnáliseEvento
- Mensagem do gráfico
- Consulta de gráfico
- Resultado do gráfico
- Gota
- Mensagem de erro
Uma mensagem de uma interação entre o usuário e o sistema.
Representação JSON |
---|
{ "timestamp": string, "messageId": string, // Union field |
Campos | |
---|---|
timestamp | Somente saída. Para mensagens do usuário, este é o horário em que o sistema recebeu a mensagem. Para mensagens do sistema, este é o horário em que o sistema gerou a mensagem. Utiliza RFC 3339, onde a saída gerada será sempre normalizada em Z e usará 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: |
messageId | Opcional. ID exclusivo da mensagem na conversa para persistência. |
Campo de união kind . O tipo da mensagem. kind pode ser apenas um dos seguintes: | |
userMessage | Uma mensagem do usuário que está interagindo com o sistema. |
systemMessage | Uma mensagem do sistema em resposta ao usuário. |
Mensagem do usuário
Uma mensagem do usuário que está interagindo com o sistema.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
kind de campo de união. O tipo de conteúdo na mensagem do usuário. kind pode ser apenas um dos seguintes: | |
text | O texto deve usar este campo em vez de blob. |
Mensagem do Sistema
Uma mensagem do sistema em resposta ao usuário. Esta mensagem também pode ser uma mensagem do usuário como contexto histórico para conversas multiturn com o sistema.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união kind . O tipo de conteúdo na mensagem do sistema. kind pode ser apenas um dos seguintes: | |
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 produzida durante a análise. |
chart | Uma mensagem produzida durante a geração do gráfico. |
error | Uma mensagem de erro. |
Mensagem de texto
Uma mensagem de texto com várias partes.
Representação JSON |
---|
{ "parts": [ string ] } |
Campos | |
---|---|
parts[] | Somente saída. As partes da mensagem. |
Mensagem de esquema
Uma mensagem produzida durante a resolução do esquema.
Representação JSON |
---|
{ // Union field |
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 um dos seguintes: | |
query | Uma consulta de resolução de esquema. |
result | O resultado de uma consulta de resolução de esquema. |
SchemaQuery
Uma consulta para resolver o esquema relevante à questão colocada.
Representação JSON |
---|
{ "question": string } |
Campos | |
---|---|
question | Somente saída. A pergunta deve ser enviada ao sistema para resolução do esquema. |
SchemaResult
O resultado da resolução do esquema.
Representação JSON |
---|
{
"datasources": [
{
object ( |
Campos | |
---|---|
datasources[] | Somente saída. As fontes de dados usadas para resolver a consulta de esquema. |
Fonte de dados
Uma fonte de dados que pode ser usada para responder perguntas.
Representação JSON |
---|
{ "schema": { object ( |
Campos | |
---|---|
schema | Somente saída. O esquema da fonte de dados. |
reference de campo da União. A referência à fonte de dados. reference pode ser apenas uma das seguintes: | |
bigqueryTableReference | Uma referência a uma tabela do BigQuery. |
studioDatasourceId | Uma referência a uma fonte de dados do Looker Studio. |
lookerExploreReference | Uma referência a uma exploração do Looker. |
Mensagem de dados
Uma mensagem produzida durante a recuperação de dados.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união kind . Se esta mensagem contém a consulta, o resultado ou o SQL gerado para a recuperação de dados. kind pode ser apenas um dos seguintes: | |
query | Uma consulta de recuperação de dados. |
generatedSql | SQL gerado pelo sistema para recuperar dados. |
result | Dados recuperados. |
generatedLookerQuery | Looker Consulta gerada pelo sistema para recuperar dados. |
bigQueryJob | Um trabalho do BigQuery executado pelo sistema para recuperar dados. |
Consulta de dados
Uma consulta para recuperar dados.
Representação JSON |
---|
{
"name": string,
"question": string,
"datasources": [
{
object ( |
Campos | |
---|---|
name | Somente saída. Um nome em caixa alta para a consulta que reflete sua intenção. É usado para nomear o resultado de dados correspondente, para que possa ser referenciado em etapas posteriores. Exemplo: "total_vendas_por_produto" Exemplo: "vendas_para_produto_12345" |
question | Somente saída. A pergunta a ser respondida. |
datasources[] | Somente saída. As fontes de dados disponíveis para responder à pergunta. |
Resultado de dados
Dados recuperados.
Representação JSON |
---|
{
"name": string,
"schema": {
object ( |
Campos | |
---|---|
name | Somente saída. Um nome em caixa-snake para o resultado de dados que reflete seu conteúdo. O nome é usado para passar o resultado por referência e serve como um sinal sobre seu significado. Exemplo: "total_vendas_por_produto" Exemplo: "vendas_para_produto_12345" |
schema | Somente saída. O esquema dos dados. |
data[] | Somente saída. O conteúdo dos dados. Cada linha é uma estrutura que corresponde ao esquema. Valores simples são representados como strings, enquanto estruturas aninhadas são representadas como listas ou estruturas. |
Consulta do Looker
Uma consulta para recuperar dados de um Looker Explore. Consulte Executar Consulta Inline .
Representação JSON |
---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
Campos | |
---|---|
model | Obrigatório. O modelo LookML usado para gerar a consulta. |
explore | Obrigatório. O LookML explorer usado para gerar a consulta. |
fields[] | Opcional. Os campos a serem recuperados do explore. |
filters[] | Opcional. Os filtros a serem aplicados à exploração. |
sorts[] | Opcional. Os tipos a serem aplicados à exploração. |
limit | Opcional. Limite na consulta. |
Filtro
Um filtro de consulta do Looker.
Representação JSON |
---|
{ "field": string, "value": string } |
Campos | |
---|---|
field | Obrigatório. Campo para filtrar. |
value | Obrigatório. O valor do campo f a ser filtrado. |
Trabalho do BigQuery
Um trabalho do BigQuery executado pelo sistema.
Representação JSON |
---|
{ "projectId": string, "jobId": string, "location": string, "destinationTable": { object ( |
Campos | |
---|---|
projectId | Obrigatório. O projeto ao qual a tarefa pertence. Veja JobReference . |
jobId | Obrigatório. O ID do trabalho. Veja JobReference . |
location | Opcional. A localização do trabalho. Veja JobReference . |
destinationTable | Somente saída. Uma referência à tabela de destino dos resultados da consulta da tarefa. Veja JobConfigurationQuery . |
schema | Somente saída. O esquema dos resultados da consulta da tarefa. Veja JobStatistics2 . |
AnáliseMensagem
Uma mensagem produzida durante a análise.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união kind . Se esta mensagem contém a consulta ou um dos eventos da análise. kind pode ser apenas um dos seguintes: | |
query | Uma consulta de análise. |
progressEvent | Um evento que indica o progresso da análise. |
AnáliseConsulta
Uma consulta para executar uma análise.
Representação JSON |
---|
{ "question": string, "dataResultNames": [ string ] } |
Campos | |
---|---|
question | Somente saída. Uma pergunta de análise para ajudar a responder à pergunta original do usuário. |
dataResultNames[] | Somente saída. Os nomes dos resultados de dados recuperados anteriormente para análise. |
AnáliseEvento
Um evento que indica o progresso de uma análise.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união kind . O tipo de evento que ocorreu durante a análise. kind pode ser apenas um dos seguintes: | |
plannerReasoning | Raciocínio do planejador de codegen em Python. |
coderInstruction | Instruções emitidas para geração de código. |
code | Código gerado. |
executionOutput | Saída da execução do código. |
executionError | Um erro de execução do código. |
resultVegaChartJson | Resultado como string JSON do gráfico Vega. |
resultNaturalLanguage | Resultado como string NL. |
resultCsvData | Resultado como string CSV. |
resultReferenceData | Resultado como referência a uma fonte de dados. |
error | Uma mensagem de erro genérica. |
Mensagem do gráfico
Uma mensagem produzida durante a geração do gráfico.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
kind de campo de união. Se esta mensagem contém a consulta ou o resultado da geração do gráfico, kind pode ser apenas um dos seguintes: | |
query | Uma consulta para gerar um gráfico. |
result | O resultado de uma consulta de geração de gráfico. |
Consulta de gráfico
Uma consulta para gerar um gráfico.
Representação JSON |
---|
{ "instructions": string, "dataResultName": string } |
Campos | |
---|---|
instructions | Somente saída. Instruções em linguagem natural para gerar o gráfico. |
dataResultName | Somente saída. O nome de um resultado de dados recuperado anteriormente a ser usado no gráfico. |
Resultado do gráfico
O resultado de uma consulta de geração de gráfico.
Representação JSON |
---|
{
"vegaConfig": {
object
},
"image": {
object ( |
Campos | |
---|---|
vegaConfig | Somente saída. 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 solicitado no contexto. |
Gota
Um blob de dados com um tipo MIME.
Representação JSON |
---|
{ "mimeType": string, "data": string } |
Campos | |
---|---|
mimeType | Obrigatório. O tipo MIME padrão IANA dos dados da mensagem. |
data | Obrigatório. Os dados são representados como bytes. Uma string codificada em base64. |
Mensagem de erro
Uma mensagem de erro.
Representação JSON |
---|
{ "text": string } |
Campos | |
---|---|
text | Somente saída. O texto do erro. |
- Representação JSON
- Mensagem do usuário
- Mensagem do Sistema
- Mensagem de texto
- Mensagem de esquema
- SchemaQuery
- SchemaResult
- Fonte de dados
- Mensagem de dados
- Consulta de dados
- Resultado de dados
- Consulta do Looker
- Filtro
- Trabalho do BigQuery
- AnáliseMensagem
- AnáliseConsulta
- AnáliseEvento
- Mensagem do gráfico
- Consulta de gráfico
- Resultado do gráfico
- Gota
- Mensagem de erro
Uma mensagem de uma interação entre o usuário e o sistema.
Representação JSON |
---|
{ "timestamp": string, "messageId": string, // Union field |
Campos | |
---|---|
timestamp | Somente saída. Para mensagens do usuário, este é o horário em que o sistema recebeu a mensagem. Para mensagens do sistema, este é o horário em que o sistema gerou a mensagem. Utiliza RFC 3339, onde a saída gerada será sempre normalizada em Z e usará 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: |
messageId | Opcional. ID exclusivo da mensagem na conversa para persistência. |
Campo de união kind . O tipo da mensagem. kind pode ser apenas um dos seguintes: | |
userMessage | Uma mensagem do usuário que está interagindo com o sistema. |
systemMessage | Uma mensagem do sistema em resposta ao usuário. |
Mensagem do usuário
Uma mensagem do usuário que está interagindo com o sistema.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
kind de campo de união. O tipo de conteúdo na mensagem do usuário. kind pode ser apenas um dos seguintes: | |
text | O texto deve usar este campo em vez de blob. |
Mensagem do Sistema
Uma mensagem do sistema em resposta ao usuário. Esta mensagem também pode ser uma mensagem do usuário como contexto histórico para conversas multiturn com o sistema.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união kind . O tipo de conteúdo na mensagem do sistema. kind pode ser apenas um dos seguintes: | |
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 produzida durante a análise. |
chart | Uma mensagem produzida durante a geração do gráfico. |
error | Uma mensagem de erro. |
Mensagem de texto
Uma mensagem de texto com várias partes.
Representação JSON |
---|
{ "parts": [ string ] } |
Campos | |
---|---|
parts[] | Somente saída. As partes da mensagem. |
Mensagem de esquema
Uma mensagem produzida durante a resolução do esquema.
Representação JSON |
---|
{ // Union field |
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 um dos seguintes: | |
query | Uma consulta de resolução de esquema. |
result | O resultado de uma consulta de resolução de esquema. |
SchemaQuery
Uma consulta para resolver o esquema relevante à questão colocada.
Representação JSON |
---|
{ "question": string } |
Campos | |
---|---|
question | Somente saída. A pergunta deve ser enviada ao sistema para resolução do esquema. |
SchemaResult
O resultado da resolução do esquema.
Representação JSON |
---|
{
"datasources": [
{
object ( |
Campos | |
---|---|
datasources[] | Somente saída. As fontes de dados usadas para resolver a consulta de esquema. |
Fonte de dados
Uma fonte de dados que pode ser usada para responder perguntas.
Representação JSON |
---|
{ "schema": { object ( |
Campos | |
---|---|
schema | Somente saída. O esquema da fonte de dados. |
reference de campo da União. A referência à fonte de dados. reference pode ser apenas uma das seguintes: | |
bigqueryTableReference | Uma referência a uma tabela do BigQuery. |
studioDatasourceId | Uma referência a uma fonte de dados do Looker Studio. |
lookerExploreReference | Uma referência a uma exploração do Looker. |
Mensagem de dados
Uma mensagem produzida durante a recuperação de dados.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união kind . Se esta mensagem contém a consulta, o resultado ou o SQL gerado para a recuperação de dados. kind pode ser apenas um dos seguintes: | |
query | Uma consulta de recuperação de dados. |
generatedSql | SQL gerado pelo sistema para recuperar dados. |
result | Dados recuperados. |
generatedLookerQuery | Looker Consulta gerada pelo sistema para recuperar dados. |
bigQueryJob | Um trabalho do BigQuery executado pelo sistema para recuperar dados. |
Consulta de dados
Uma consulta para recuperar dados.
Representação JSON |
---|
{
"name": string,
"question": string,
"datasources": [
{
object ( |
Campos | |
---|---|
name | Somente saída. Um nome em caixa alta para a consulta que reflete sua intenção. É usado para nomear o resultado de dados correspondente, para que possa ser referenciado em etapas posteriores. Exemplo: "total_vendas_por_produto" Exemplo: "vendas_para_produto_12345" |
question | Somente saída. A pergunta a ser respondida. |
datasources[] | Somente saída. As fontes de dados disponíveis para responder à pergunta. |
Resultado de dados
Dados recuperados.
Representação JSON |
---|
{
"name": string,
"schema": {
object ( |
Campos | |
---|---|
name | Somente saída. Um nome em caixa-snake para o resultado de dados que reflete seu conteúdo. O nome é usado para passar o resultado por referência e serve como um sinal sobre seu significado. Exemplo: "total_vendas_por_produto" Exemplo: "vendas_para_produto_12345" |
schema | Somente saída. O esquema dos dados. |
data[] | Somente saída. O conteúdo dos dados. Cada linha é uma estrutura que corresponde ao esquema. Valores simples são representados como strings, enquanto estruturas aninhadas são representadas como listas ou estruturas. |
Consulta do Looker
Uma consulta para recuperar dados de um Looker Explore. Consulte Executar Consulta Inline .
Representação JSON |
---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
Campos | |
---|---|
model | Obrigatório. O modelo LookML usado para gerar a consulta. |
explore | Obrigatório. O LookML explorer usado para gerar a consulta. |
fields[] | Opcional. Os campos a serem recuperados do explore. |
filters[] | Opcional. Os filtros a serem aplicados à exploração. |
sorts[] | Opcional. Os tipos a serem aplicados à exploração. |
limit | Opcional. Limite na consulta. |
Filtro
Um filtro de consulta do Looker.
Representação JSON |
---|
{ "field": string, "value": string } |
Campos | |
---|---|
field | Obrigatório. Campo para filtrar. |
value | Obrigatório. O valor do campo f a ser filtrado. |
Trabalho do BigQuery
Um trabalho do BigQuery executado pelo sistema.
Representação JSON |
---|
{ "projectId": string, "jobId": string, "location": string, "destinationTable": { object ( |
Campos | |
---|---|
projectId | Obrigatório. O projeto ao qual a tarefa pertence. Veja JobReference . |
jobId | Obrigatório. O ID do trabalho. Veja JobReference . |
location | Opcional. A localização do trabalho. Veja JobReference . |
destinationTable | Somente saída. Uma referência à tabela de destino dos resultados da consulta da tarefa. Veja JobConfigurationQuery . |
schema | Somente saída. O esquema dos resultados da consulta da tarefa. Veja JobStatistics2 . |
AnáliseMensagem
Uma mensagem produzida durante a análise.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união kind . Se esta mensagem contém a consulta ou um dos eventos da análise. kind pode ser apenas um dos seguintes: | |
query | Uma consulta de análise. |
progressEvent | Um evento que indica o progresso da análise. |
AnáliseConsulta
Uma consulta para executar uma análise.
Representação JSON |
---|
{ "question": string, "dataResultNames": [ string ] } |
Campos | |
---|---|
question | Somente saída. Uma pergunta de análise para ajudar a responder à pergunta original do usuário. |
dataResultNames[] | Somente saída. Os nomes dos resultados de dados recuperados anteriormente para análise. |
AnáliseEvento
Um evento que indica o progresso de uma análise.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união kind . O tipo de evento que ocorreu durante a análise. kind pode ser apenas um dos seguintes: | |
plannerReasoning | Raciocínio do planejador de codegen em Python. |
coderInstruction | Instruções emitidas para geração de código. |
code | Código gerado. |
executionOutput | Saída da execução do código. |
executionError | Um erro de execução do código. |
resultVegaChartJson | Resultado como string JSON do gráfico Vega. |
resultNaturalLanguage | Resultado como string NL. |
resultCsvData | Resultado como string CSV. |
resultReferenceData | Resultado como referência a uma fonte de dados. |
error | Uma mensagem de erro genérica. |
Mensagem do gráfico
Uma mensagem produzida durante a geração do gráfico.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
kind de campo de união. Se esta mensagem contém a consulta ou o resultado da geração do gráfico, kind pode ser apenas um dos seguintes: | |
query | Uma consulta para gerar um gráfico. |
result | O resultado de uma consulta de geração de gráfico. |
Consulta de gráfico
Uma consulta para gerar um gráfico.
Representação JSON |
---|
{ "instructions": string, "dataResultName": string } |
Campos | |
---|---|
instructions | Somente saída. Instruções em linguagem natural para gerar o gráfico. |
dataResultName | Somente saída. O nome de um resultado de dados recuperado anteriormente a ser usado no gráfico. |
Resultado do gráfico
O resultado de uma consulta de geração de gráfico.
Representação JSON |
---|
{
"vegaConfig": {
object
},
"image": {
object ( |
Campos | |
---|---|
vegaConfig | Somente saída. 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 solicitado no contexto. |
Gota
Um blob de dados com um tipo MIME.
Representação JSON |
---|
{ "mimeType": string, "data": string } |
Campos | |
---|---|
mimeType | Obrigatório. O tipo MIME padrão IANA dos dados da mensagem. |
data | Obrigatório. Os dados são representados como bytes. Uma string codificada em base64. |
Mensagem de erro
Uma mensagem de erro.
Representação JSON |
---|
{ "text": string } |
Campos | |
---|---|
text | Somente saída. O texto do erro. |