Method: projects.locations.chat

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

Solicitud HTTP


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

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

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 
{
  "project": string,
  "messages": [
    {
      object (Message)
    }
  ],

  // 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.
}
Campos
project
(deprecated)

string

Opcional. Es el proyecto de Google Cloud que se usará para la cuota y la facturación.
messages[]

object (Message)

Obligatorio. Es el contenido de la conversación actual.
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)

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.

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,
  "credentials": {
    object (Credentials)
  },
  "contextVersion": enum (ContextVersion)
}
Campos
dataAgent

string

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

object (Credentials)

Opcional. Son las credenciales que se usarán cuando se llame a la fuente de datos de Looker.

Actualmente, admite credenciales basadas en tokens de OAuth y claves de API, como se describe en Autenticación con un SDK.
contextVersion

enum (ContextVersion)

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

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

string

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