- Representación 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
- CitationSource
- CitationAnchor
- TextMessageCitationAnchor
Es un mensaje de una interacción entre el usuario y el sistema.
| Representación 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 |
Solo salida. En el caso de los mensajes del usuario, es la hora en la que el sistema recibió el mensaje. En el caso de los mensajes del sistema, esta es la hora en la que el sistema generó el mensaje. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
messageId |
Opcional. Es el ID único del mensaje en la conversación para conservarla. |
| Es el tipo de mensaje. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
userMessage |
Es un mensaje del usuario que interactúa con el sistema. |
systemMessage |
Es un mensaje del sistema en respuesta al usuario. |
| Fin de los campos mutuamente excluyentes. | |
UserMessage
Es un mensaje del usuario que interactúa con el sistema.
| Representación 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 | |
|---|---|
| Es el tipo de contenido del mensaje del usuario. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
text |
El texto debe usar este campo en lugar de BLOB. |
| Fin de los campos mutuamente excluyentes. | |
SystemMessage
Es un mensaje del sistema en respuesta al usuario. Este mensaje también puede ser un mensaje del usuario como contexto histórico para las conversaciones de varios turnos con el sistema.
| Representación JSON |
|---|
{ "citation": { object ( |
| Campos | |
|---|---|
citation |
Solo salida. Información de citas para el mensaje del sistema. |
| Es el tipo de contenido del mensaje del sistema. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
text |
Es una respuesta directa en lenguaje natural al mensaje del usuario. |
schema |
Es un mensaje que se produce durante la resolución del esquema. |
data |
Es un mensaje que se produce durante la recuperación de datos. |
analysis |
Es un mensaje que se produce durante el análisis. |
chart |
Es un mensaje que se produce durante la generación del gráfico. |
error |
Es un mensaje de error. |
exampleQueries |
Es opcional. Un mensaje que contiene consultas de ejemplo. |
clarification |
Es opcional. Obsoleto: Usa TextMessage con TextType.FINAL_RESPONSE en su lugar. Un mensaje con preguntas aclaratorias. |
| Fin de los campos mutuamente excluyentes. | |
groupId |
Identifica el grupo al que pertenece el evento. Se considera que los eventos similares son lógicamente pertinentes entre sí y deben mostrarse juntos en la IU. |
TextMessage
Es un mensaje de texto de varias partes.
| Representación JSON |
|---|
{
"parts": [
string
],
"textType": enum ( |
| Campos | |
|---|---|
parts[] |
Opcional. Son las partes del mensaje. |
textType |
Es opcional. Es el tipo de mensaje de texto. |
thoughtSignature |
Es opcional. Es una firma opaca para un pensamiento, de modo que se pueda reutilizar en solicitudes posteriores. Es una cadena codificada en Base64. |
TextType
Es el tipo de mensaje de texto.
| Enums | |
|---|---|
TEXT_TYPE_UNSPECIFIED |
Es el tipo de texto predeterminado. |
FINAL_RESPONSE |
El texto es una respuesta final a la pregunta del usuario. |
THOUGHT |
El texto es un pensamiento del modelo. |
PROGRESS |
El texto es un mensaje informativo sobre el progreso del agente, como la invocación de una herramienta. Esto es distinto del proceso de pensamiento interno del agente (THOUGHT) y de la respuesta final al usuario (FINAL_RESPONSE). Estos mensajes proporcionan información sobre las acciones del agente. |
FOLLOWUP_QUESTIONS |
El texto es una lista de preguntas adicionales sugeridas. Cada elemento de parts es una pregunta de seguimiento. |
SchemaMessage
Es un mensaje que se produce durante la resolución del esquema.
| Representación 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 | |
|---|---|
| Indica si este mensaje contiene la consulta o el resultado de la resolución del esquema. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
query |
Es una consulta de resolución de esquema. |
result |
Es el resultado de una consulta de resolución de esquema. |
| Fin de los campos mutuamente excluyentes. | |
SchemaQuery
Es una consulta para resolver el esquema pertinente a la pregunta planteada.
| Representación JSON |
|---|
{ "question": string } |
| Campos | |
|---|---|
question |
Opcional. Es la pregunta que se enviará al sistema para la resolución del esquema. |
SchemaResult
Es el resultado de la resolución del esquema.
| Representación JSON |
|---|
{
"datasources": [
{
object ( |
| Campos | |
|---|---|
datasources[] |
Opcional. Son las fuentes de datos que se usan para resolver la consulta de esquema. |
Datasource
Es una fuente de datos que se puede usar para responder preguntas.
| Representación JSON |
|---|
{ "schema": { object ( |
| Campos | |
|---|---|
schema |
Opcional. Es el esquema de la fuente de datos. |
structSchema |
Es opcional. Es una representación de struct del esquema. Se propaga para fuentes de datos con esquemas que no se pueden representar por completo con el campo En el caso de las fuentes de datos de Looker, esto se asigna al tipo LookmlModelExplore: https://cloud.google.com/looker/docs/reference/looker-api/latest/types/LookmlModelExplore |
| Es la referencia a la fuente de datos. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
bigqueryTableReference |
Es una referencia a una tabla de BigQuery. |
studioDatasourceId |
Es una referencia a una fuente de datos de Looker Studio. |
lookerExploreReference |
Es una referencia a una exploración de Looker. |
alloyDbReference |
Es una referencia a una base de datos de AlloyDB. |
spannerReference |
Es una referencia a una base de datos de Spanner. |
cloudSqlReference |
Es una referencia a una base de datos de Cloud SQL. |
bigtableReference |
Es una referencia a una instancia de Bigtable. |
bigqueryPropertyGraphReference |
Es una referencia a un grafo de propiedades de BigQuery. |
firestoreReference |
Es una referencia a una base de datos de Firestore. |
| Fin de los campos mutuamente excluyentes. | |
DataMessage
Es un mensaje que se produce durante la recuperación de datos.
| Representación 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 | |
|---|---|
| Indica si este mensaje contiene la consulta, el resultado o el SQL generado para la recuperación de datos. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
query |
Es una consulta de recuperación de datos. |
generatedSql |
Es el código SQL que genera el sistema para recuperar datos. |
result |
Son datos recuperados. |
generatedLookerQuery |
Obsoleto: La consulta de Looker generada ahora se encuentra en DataQuery.looker. Es la consulta de Looker que genera el sistema para recuperar datos. |
bigQueryJob |
Es un trabajo de BigQuery que ejecuta el sistema para recuperar datos. |
matchedQuery |
Es una consulta preexistente que se hizo coincidir para recuperar datos. |
| Fin de los campos mutuamente excluyentes. | |
DataQuery
Es una consulta para recuperar datos.
| Representación JSON |
|---|
{ "question": string, "name": string, "datasources": [ { object ( |
| Campos | |
|---|---|
question |
Opcional. Es una pregunta en lenguaje natural que se debe responder. |
name |
Opcional. Nombre en minúsculas con guiones bajos para la consulta que refleja su intención. Se usa para nombrar el resultado de datos correspondiente, de modo que se pueda hacer referencia a él en pasos posteriores.
|
datasources[] |
Opcional. Son las fuentes de datos disponibles para responder la pregunta. |
| Es el tipo de consulta que se ejecutará. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
looker |
Es opcional. Es una consulta para recuperar datos de una exploración de Looker. |
| Fin de los campos mutuamente excluyentes. | |
DataResult
Son datos recuperados.
| Representación JSON |
|---|
{
"name": string,
"schema": {
object ( |
| Campos | |
|---|---|
name |
Opcional. Es un nombre en minúsculas con guiones bajos para el resultado de datos que refleja su contenido. El nombre se usa para pasar el resultado por referencia y sirve como indicador de su significado.
|
schema |
Opcional. Es el esquema de los datos. |
data[] |
Opcional. Es el contenido de los datos. Cada fila es una struct que coincide con el esquema. Los valores simples se representan como cadenas, mientras que las estructuras anidadas se representan como listas o structs. |
formattedData[] |
Es opcional. Es la representación con formato de los datos, cuando corresponde. Cada fila es un struct que corresponde directamente a la fila en el mismo índice dentro del campo |
BigQueryJob
Es un trabajo de BigQuery que ejecuta el sistema.
| Representación JSON |
|---|
{ "projectId": string, "jobId": string, "location": string, "destinationTable": { object ( |
| Campos | |
|---|---|
projectId |
Obligatorio. Es el proyecto al que pertenece el trabajo. Consulta JobReference. |
jobId |
Obligatorio. Es el ID del trabajo. Consulta JobReference. |
location |
Opcional. Es la ubicación del trabajo. Consulta JobReference. |
destinationTable |
Opcional. Es una referencia a la tabla de destino de los resultados de la consulta del trabajo. Consulta JobConfigurationQuery. |
schema |
Opcional. Es el esquema de los resultados de la consulta del trabajo. Consulta JobStatistics2. |
MatchedQuery
Un mensaje de consulta coincidente representa que el agente coincidió con una de las consultas de ejemplo proporcionadas en el contexto como aplicable a la pregunta actual. También contendrá información adicional durante el proceso de coincidencia.
| Representación JSON |
|---|
{ "exampleQuery": { object ( |
| Campos | |
|---|---|
exampleQuery |
Es la consulta que coincidió con una consulta de ejemplo. |
queryParameterValues[] |
Son los valores extraídos de los parámetros de consulta. |
QueryParameterValues
Un mensaje de valores de parámetros de consulta representa los valores de los parámetros de consulta que el LLM extrajo de la pregunta del usuario, según la consulta de ejemplo.
| Representación JSON |
|---|
{ "name": string, "value": string } |
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del parámetro. |
value |
Obligatorio. El valor del parámetro. |
AnalysisMessage
Es un mensaje que se produce durante el análisis.
| Representación 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 | |
|---|---|
| Indica si este mensaje contiene la búsqueda o uno de los eventos del análisis. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
query |
Es una consulta de análisis. |
progressEvent |
Es un evento que indica el progreso del análisis. |
| Fin de los campos mutuamente excluyentes. | |
AnalysisQuery
Es una consulta para realizar un análisis.
| Representación JSON |
|---|
{ "question": string, "dataResultNames": [ string ] } |
| Campos | |
|---|---|
question |
Opcional. Es una pregunta de análisis que ayuda a responder la pregunta original del usuario. |
dataResultNames[] |
Opcional. Son los nombres de los resultados de datos recuperados anteriormente que se usarán para el análisis. |
AnalysisEvent
Es un evento que indica el progreso de un análisis.
| Representación 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 | |
|---|---|
| Es el tipo de evento que ocurrió durante el análisis. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
plannerReasoning |
Es el razonamiento del planificador para la generación de código de Python. |
coderInstruction |
Son las instrucciones que se emiten para la generación de código. |
code |
Es el código generado. |
executionOutput |
Es el resultado de la ejecución del código. |
executionError |
Es un error de la ejecución del código. |
resultVegaChartJson |
Es el resultado como cadena JSON del gráfico de Vega. |
resultNaturalLanguage |
Es el resultado como una cadena NL. |
resultCsvData |
Es el resultado como una cadena CSV. |
resultReferenceData |
Es el resultado como referencia a una fuente de datos. |
error |
Es un mensaje de error genérico. |
| Fin de los campos mutuamente excluyentes. | |
ChartMessage
Es un mensaje que se produce durante la generación del gráfico.
| Representación 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 | |
|---|---|
| Indica si este mensaje contiene la consulta o el resultado de la generación del gráfico. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
query |
Es una consulta para generar un gráfico. |
result |
Es el resultado de una consulta de generación de gráficos. |
| Fin de los campos mutuamente excluyentes. | |
ChartQuery
Es una consulta para generar un gráfico.
| Representación JSON |
|---|
{ "instructions": string, "dataResultName": string } |
| Campos | |
|---|---|
instructions |
Opcional. Son las instrucciones en lenguaje natural para generar el gráfico. |
dataResultName |
Opcional. Es el nombre de un resultado de datos recuperado previamente para usar en el gráfico. |
ChartResult
Es el resultado de una consulta de generación de gráficos.
| Representación JSON |
|---|
{
"vegaConfig": {
object
},
"image": {
object ( |
| Campos | |
|---|---|
vegaConfig |
Opcional. Es un parámetro de configuración del gráfico generado de Vega. Consulta https://vega.github.io/vega/docs/config/ |
image |
Opcional. Es una renderización del gráfico si se solicitó en el contexto. |
BLOB
Es un BLOB de datos con un tipo de MIME.
| Representación JSON |
|---|
{ "mimeType": string, "data": string } |
| Campos | |
|---|---|
mimeType |
Obligatorio. Es el tipo de MIME estándar de IANA de los datos del mensaje. |
data |
Obligatorio. Son los datos representados como bytes. Es una cadena codificada en base64. |
ErrorMessage
Es un mensaje de error de una llamada a la herramienta. Este mensaje se usa para representar un error que se produjo mientras un agente intentaba usar una herramienta. Es importante tener en cuenta que no todos los errores son terminales. Muchos son recuperables, y el agente puede usar la información de este mensaje de error para autocorregirse y volver a intentar la llamada a la herramienta o probar un enfoque diferente.
Por ejemplo, si falla una consulta de datos, el agente podría recibir un ErrorMessage, analizarlo y, luego, generar una consulta corregida.
Los clientes deben tener cuidado al interpretar este mensaje como un error definitivo. Puede ser parte del proceso iterativo normal del agente para completar una tarea. Mostrar estos errores directamente a los usuarios finales sin contexto (p.ej., como una "falla grave") puede ser engañoso.
| Representación JSON |
|---|
{ "text": string } |
| Campos | |
|---|---|
text |
Solo salida. Es el texto del error. |
ExampleQueries
Un mensaje que contiene consultas de ejemplo derivadas y creadas.
| Representación JSON |
|---|
{
"exampleQueries": [
{
object ( |
| Campos | |
|---|---|
exampleQueries[] |
Es opcional. Es una lista de consultas de ejemplo derivadas y creadas, que proporciona ejemplos de consultas en SQL relevantes y de uso frecuente, y sus consultas en lenguaje natural correspondientes, que pueden estar presentes de forma opcional. Actualmente, solo se usa para las fuentes de datos de BigQuery. |
ClarificationMessage
Obsoleto: Usa TextMessage con TextType.FINAL_RESPONSE en su lugar. Un mensaje con preguntas para ayudar a aclarar la consulta del usuario. Se devuelve cuando el sistema no puede responder con confianza la pregunta del usuario.
| Representación JSON |
|---|
{
"questions": [
{
object ( |
| Campos | |
|---|---|
questions[] |
Obligatorio. Obsoleto: El mensaje superior está obsoleto. Es un lote de preguntas aclaratorias para hacerle al usuario. |
ClarificationQuestion
Obsoleto: Usa TextMessage con TextType.FINAL_RESPONSE en su lugar. Representa una sola pregunta al usuario para ayudar a aclarar su consulta.
| Representación JSON |
|---|
{ "question": string, "selectionMode": enum ( |
| Campos | |
|---|---|
question |
Obligatorio. Obsoleto: El mensaje superior está obsoleto. Es la pregunta en lenguaje natural que se le hará al usuario. |
selectionMode |
Obligatorio. Obsoleto: El mensaje superior está obsoleto. Es el modo de selección para esta pregunta. |
options[] |
Obligatorio. Obsoleto: El mensaje superior está obsoleto. Es una lista de opciones distintas para que el usuario elija. La cantidad de opciones se limita a un máximo de 5. |
clarificationQuestionType |
Es opcional. Obsoleto: El mensaje superior está obsoleto. Es el tipo de pregunta aclaratoria. |
SelectionMode
Obsoleto: El mensaje superior está obsoleto. Es el modo de selección de la pregunta de aclaración.
| Enums | |
|---|---|
SELECTION_MODE_UNSPECIFIED |
Obsoleto: El mensaje superior está obsoleto. Modo de selección sin especificar. |
SINGLE_SELECT |
Obsoleto: El mensaje superior está obsoleto. El usuario solo puede seleccionar una opción. |
MULTI_SELECT |
Obsoleto: El mensaje superior está obsoleto. El usuario puede seleccionar varias opciones. |
ClarificationQuestionType
Obsoleto: El mensaje superior está obsoleto. Es el tipo de pregunta aclaratoria. Este enum se puede extender con valores nuevos en el futuro.
| Enums | |
|---|---|
CLARIFICATION_QUESTION_TYPE_UNSPECIFIED |
Obsoleto: El mensaje superior está obsoleto. Tipo de pregunta aclaratoria no especificado. |
FILTER_VALUES |
Obsoleto: El mensaje superior está obsoleto. La pregunta de aclaración es para los valores de filtro. |
FIELDS |
Obsoleto: El mensaje superior está obsoleto. La pregunta de aclaración es para los campos de datos. Este es un término genérico que abarca las columnas de SQL, los campos de Looker (dimensiones o mediciones) o las propiedades de la estructura de datos anidados. |
Cita
Atribuciones de fuentes para el contenido.
| Representación JSON |
|---|
{ "sources": [ { object ( |
| Campos | |
|---|---|
sources[] |
Solo salida. Lista de las fuentes que se citan. |
anchors[] |
Solo salida. Es la lista de los textos de anclaje de las citas. |
CitationSource
Es la fuente de la cita.
| Representación 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 |
Solo salida. Es el identificador único de la fuente. Este ID lo genera el servicio y es único dentro del alcance de un solo mensaje de |
title |
Solo salida. Es el título de la fuente. |
| La fuente de la cita, que puede ser uno de los tipos admitidos. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
uri |
Solo salida. Es el URI que se usa como fuente, como una URL de fundamentación web. |
exampleQuery |
Solo salida. Es la consulta de ejemplo que se usa como fuente. |
glossaryTerm |
Solo salida. Es el término del glosario que se usa como fuente. |
| Fin de los campos mutuamente excluyentes. | |
CitationAnchor
Es el texto de anclaje de la cita.
| Representación 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 | |
|---|---|
| Es el ancla de la cita, que puede ser uno de los tipos admitidos. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
textMessageAnchor |
Solo salida. Solo se establece si la cita es para un TextMessage. |
| Fin de los campos mutuamente excluyentes. | |
TextMessageCitationAnchor
Ancla de cita dentro de un TextMessage.
| Representación JSON |
|---|
{ "partIndex": integer, "startOffsetBytes": integer, "endOffsetBytes": integer, "sourceIds": [ string ] } |
| Campos | |
|---|---|
partIndex |
Solo salida. Es el índice basado en 0 de la parte dentro del campo TextMessage.parts. |
startOffsetBytes |
Solo salida. Es el desplazamiento, medido en bytes UTF-8, dentro de la cadena de la parte en la que comienza la cita (inclusive). Ejemplo: Para el texto "Hello, world" en el que se cita "world", los bytes de desplazamiento de inicio (inclusive) son 7 y los bytes de desplazamiento de finalización (exclusivo) son 12. |
endOffsetBytes |
Solo salida. Es el desplazamiento, medido en bytes UTF-8, dentro de la cadena de la parte en la que finaliza la cita (exclusivo). Ejemplo: Para el texto "Hello, world" en el que se cita "world", los bytes de desplazamiento de inicio (inclusive) son 7 y los bytes de desplazamiento de finalización (exclusivo) son 12. |
sourceIds[] |
Solo salida. Son los IDs de las fuentes que se citan. |