Method: projects.locations.chat

Responde una pregunta sobre datos generando un flujo de objetos Message.

Solicitud HTTP

POST https://geminidataanalytics.googleapis.com/v1/{parent=projects/*/locations/*}:chat

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el valor principal de la solicitud de chat. Patrón: projects/{project}/locations/{location}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "credentials": {
    object (Credentials)
  },
  "thinkingMode": enum (ThinkingMode),
  "model": enum (Model),

  // Union field context_provider can be only one of the following:
  "inlineContext": {
    object (Context)
  },
  "conversationReference": {
    object (ConversationReference)
  },
  "dataAgentContext": {
    object (DataAgentContext)
  },
  "clientManagedResourceContext": {
    object (ClientManagedResourceContext)
  }
  // End of list of possible types for union field context_provider.

  // Union field datasource_settings can be only one of the following:
  "lookerSettings": {
    object (LookerSettings)
  }
  // End of list of possible types for union field datasource_settings.
}
Campos
messages[]

object (Message)

Obligatorio. Es el contenido de la conversación actual.
credentials

object (Credentials)

Es opcional. Son las credenciales que se usarán cuando se llame a las fuentes de datos especificadas en el contexto.

Este campo se puede usar para proporcionar credenciales para varias fuentes de datos. Por ejemplo, cuando te conectas a Looker, actualmente admite credenciales basadas en tokens de OAuth y claves de API, como se describe en Autenticación con un SDK.
thinkingMode

enum (ThinkingMode)

Es opcional. Es el modo de pensamiento que se usará para el bucle del agente. El valor predeterminado es THINKING_MODE_UNSPECIFIED si no se especifica.
model

enum (Model)

Es opcional. Es el modelo que se usará para el bucle del agente cuando se procese la solicitud. Este parámetro de configuración solo tiene efecto cuando no se establece context.options.model.
Campo de unión context_provider. Es el proveedor de contexto para la solicitud de chat. Puede ser inline_context, que es un contexto proporcionado de forma intercalada en la solicitud; data_agent, que es una referencia a un recurso de agente de datos; o conversation_reference, que es una referencia a una conversación y un contexto persistentes que usan conversation_id y agent_id. context_provider puede ser solo uno de los siguientes:
inlineContext

object (Context)

Opcional. Es el contexto intercalado para la solicitud de chat. Úsalo para chatear sin estado (sin persistencia de conversación administrada y sin un agente) pasando todo el contexto de forma intercalada.
conversationReference

object (ConversationReference)

Opcional. Es una referencia a una conversación persistente y al contexto del agente. Úsalo para chatear con un agente con la persistencia de conversación administrada.
dataAgentContext

object (DataAgentContext)

Opcional. Es el contexto de la solicitud de chat. Úsalo para chatear con un agente sin estado, sin persistencia de conversación administrada.
clientManagedResourceContext

object (ClientManagedResourceContext)

Es opcional. Es el contexto con recursos administrados por el cliente. Es posible que algunos clientes no usen los recursos administrados por la GDA, incluidas las conversaciones y los agentes, sino que creen y administren sus propios recursos de conversaciones y agentes.
Campo de unión datasource_settings. Son parámetros de configuración opcionales para personalizar el comportamiento de la solicitud, específicos de la fuente de datos de destino. datasource_settings puede ser solo uno de los parámetros siguientes:
lookerSettings

object (LookerSettings)

Es opcional. Es la configuración específica de Looker.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contiene un flujo de instancias de Message.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

ConversationReference

Es una referencia a una conversación persistente y al contexto del agente.

Representación JSON 
{
  "conversation": string,
  "dataAgentContext": {
    object (DataAgentContext)
  }
}
Campos
conversation

string

Obligatorio. Nombre del recurso de conversación. Formato: projects/{project}/locations/{location}/conversations/{conversationId}
dataAgentContext

object (DataAgentContext)

Obligatorio. Contexto de la solicitud de chat con un agente de datos.

DataAgentContext

Contexto de la solicitud de chat con un agente de datos.

Representación JSON 
{
  "dataAgent": string,
  "contextVersion": enum (ContextVersion)
}
Campos
dataAgent

string

Obligatorio. Es el nombre del recurso del agente de datos.
contextVersion

enum (ContextVersion)

Es opcional. Versión del contexto que usará DCS (p. ej., ALMACENAMIENTO EN ETAPA DE PRUEBAS, PUBLICADO)

ContextVersion

Es la lista de versiones de contexto compatibles con DCS. Hay dos versiones del contexto. Esto es para mantener el control de versiones del agente de datos.

Enums
CONTEXT_VERSION_UNSPECIFIED Sin especificar o no reconocido.
STAGING Con esta versión, DCS usará el contexto de etapa de pruebas más reciente para el agente de datos.
PUBLISHED Con esta versión, DCS usará el contexto publicado más reciente para el agente de datos.

ClientManagedResourceContext

Es el contexto con recursos administrados por el cliente. Es posible que algunos clientes no usen los recursos administrados por la GDA, incluidas las conversaciones y los agentes, sino que creen y administren sus propios recursos de conversaciones y agentes.

Representación JSON 
{
  "inlineContext": {
    object (Context)
  },
  "conversationId": string,
  "agentId": string
}
Campos
inlineContext

object (Context)

Obligatorio. Es el contexto de la solicitud de chat. Úsalo para chatear sin persistencia de conversación administrada por la API de GDA ni persistencia de agente pasando todo el contexto de forma intercalada.
conversationId

string

Es opcional. Es el ID de conversación administrado por el cliente.
agentId

string

Es opcional. Es el ID del agente administrado por el cliente.

LookerSettings

Es el mensaje para conservar la configuración personalizada específica de Looker.

Representación JSON 
{
  "enableDevMode": boolean
}
Campos
enableDevMode

boolean

Es opcional. Indica si se debe operar en el modo de desarrollo de Looker. Si es verdadero, la sesión de la API cambiará al espacio de trabajo "dev", lo que permitirá la interacción con los cambios de LookML en la rama de desarrollo del usuario. Si se establece como falso o no se establece, la sesión permanece en el estado predeterminado (modo de producción). Consulta https://cloud.google.com/looker/docs/dev-mode-prod-mode.

Credenciales

Representa diferentes formas de especificación de credenciales.

Representación JSON 
{

  // Union field kind can be only one of the following:
  "oauth": {
    object (OAuthCredentials)
  }
  // End of list of possible types for union field kind.
}
Campos
Campo de unión kind. Es el tipo de credenciales. kind puede ser solo uno de los parámetros siguientes:
oauth

object (OAuthCredentials)

Son las credenciales de OAuth.

OAuthCredentials

Representa las credenciales de OAuth.

Representación JSON 
{

  // Union field kind can be only one of the following:
  "secret": {
    object (SecretBased)
  },
  "token": {
    object (TokenBased)
  }
  // End of list of possible types for union field kind.
}
Campos
Campo de unión kind. Es el tipo de credenciales de OAuth. kind puede ser solo uno de los parámetros siguientes:
secret

object (SecretBased)

Son credenciales de OAuth basadas en secretos.
token

object (TokenBased)

Son credenciales de OAuth basadas en tokens.

SecretBased

Nombre del Secret que contiene el token de acceso. Representa las credenciales de OAuth basadas en secretos.

Representación JSON 
{
  "clientId": string,
  "clientSecret": string
}
Campos
clientId

string

Obligatorio. Es un ID de cliente de OAuth.
clientSecret

string

Obligatorio. Es el secreto del cliente de OAuth.

TokenBased

Obtén más información sobre los tokens de acceso de Looker aquí: https://developers.looker.com/api/advanced-usage/looker-api-oauth

Representación JSON 
{
  "accessToken": string
}
Campos
accessToken

string

Obligatorio. Nombre del Secret que contiene el token de acceso.

ThinkingMode

Es el modo de pensamiento del agente.

Enums
THINKING_MODE_UNSPECIFIED Modo de pensamiento no especificado. El agente usará el modo PENSAMIENTO de forma predeterminada, excepto para el usuario de BigQuery, que usará el modo RÁPIDO de forma predeterminada.
FAST Modo rápido, responde rápidamente.
THINKING Modo de pensamiento, resuelve problemas complejos.

Modelo

Es la selección del modelo para el agente de los usuarios de BigQuery.

Enums
MODEL_UNSPECIFIED No se especificó ningún modelo. Se puede usar un modelo de vista previa o uno que no sea de vista previa.
LATEST_GA_MODEL Usa el modelo que no sea de vista previa más actualizado. Esto puede restringir ciertos parámetros de configuración a nivel de la solicitud.