Method: projects.locations.chat

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

Solicitud HTTP


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

Las URLs utilizan la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Valor superior de la solicitud de chat. Patrón: projects/{project}/locations/{location}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan 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. El proyecto de Google Cloud que se usará para la cuota y la facturación.
messages[]

object (Message)

Obligatorio. Contenido de la conversación actual.
Campo de unión context_provider. Proveedor de contexto de la solicitud de chat. Puede ser inline_context, que es un contexto proporcionado en línea 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 mediante conversation_id y agent_id. context_provider solo puede ser una de estas dos opciones:
inlineContext

object (Context)

Opcional. Contexto insertado de la solicitud de chat. Úsalo para chatear sin estado (sin persistencia de conversación gestionada y sin un agente) pasando todo el contexto de forma insertada.
conversationReference

object (ConversationReference)

Opcional. Referencia a una conversación persistente y al contexto del agente. Úsalo para chatear con un agente mediante la persistencia de conversaciones gestionada.
dataAgentContext

object (DataAgentContext)

Opcional. Contexto de la solicitud de chat. Úsala para chatear con un agente sin estado, sin persistencia de conversación gestionada.
clientManagedResourceContext

object (ClientManagedResourceContext)

Opcional. Contexto con recursos gestionados por el cliente. Es posible que algunos clientes no usen recursos gestionados por GDA, como conversaciones y agentes, sino que creen y gestionen sus propios recursos de conversaciones y agentes.

Cuerpo de la respuesta

Si la solicitud se completa 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 el Authentication Overview.

ConversationReference

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 mediante un agente de datos.

DataAgentContext

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

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

string

Obligatorio. Nombre del recurso de agente de datos.
credentials

object (Credentials)

Opcional. Las credenciales que se deben usar al llamar a la fuente de datos de Looker.

Actualmente, admite tanto tokens de OAuth como credenciales basadas en claves de API, tal como se describe en el artículo Autenticación con un SDK.
contextVersion

enum (ContextVersion)

Opcional. Versión del contexto que va a usar DCS (por ejemplo, STAGING o PUBLISHED).

ContextVersion

Lista de versiones de contexto admitidas por DCS. Hay dos versiones del contexto. Esto se hace para mantener el control de versiones del agente de datos.

Enumeraciones
CONTEXT_VERSION_UNSPECIFIED No especificado o no reconocido.
STAGING Con esta versión, DCS usará el contexto de staging 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

Contexto con recursos gestionados por el cliente. Es posible que algunos clientes no usen recursos gestionados por GDA, como conversaciones y agentes, sino que creen y gestionen sus propios recursos de conversaciones y agentes.

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

object (Context)

Obligatorio. Contexto de la solicitud de chat. Úsalo para chatear sin la conversación gestionada por la API GDA y la persistencia del agente pasando todo el contexto de forma insertada.
conversationId

string

Opcional. ID de la conversación gestionada por el cliente.
agentId

string

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