Method: projects.locations.collections.engines.conversations.converse

Convierte una conversación.

Solicitud HTTP

POST https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}:converse

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

Parámetros de ruta

Parámetros
name

string

Obligatorio. El nombre del recurso de la conversación que se obtendrá. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId}. Usa projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/- para activar el modo de sesión automática, que crea automáticamente una conversación nueva dentro de una sesión conversations.converse.

Cuerpo de la solicitud

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

Representación JSON 
{
  "query": {
    object (TextInput)
  },
  "servingConfig": string,
  "conversation": {
    object (Conversation)
  },
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  },
  "summarySpec": {
    object (SummarySpec)
  },
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  }
}
Campos
query

object (TextInput)

Obligatorio. Es la entrada actual del usuario.
servingConfig

string

Es el nombre del recurso de la configuración de publicación que se usará. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId} Si no se establece, se usará la configuración de publicación predeterminada.
conversation

object (Conversation)

Es la conversación que usará la sesión automática. Se ignorará el campo name, ya que asignamos automáticamente un nombre nuevo a la conversación en la sesión automática.
userLabels

map (key: string, value: string)

Las etiquetas de usuario que se aplican a un recurso deben cumplir los siguientes requisitos:

  • Cada recurso puede tener varias etiquetas, hasta 64.
  • Cada etiqueta debe ser un par clave-valor.
  • Las claves tienen una longitud mínima de 1 carácter y una longitud máxima de 63 caracteres, y no pueden estar vacías. Los valores pueden estar vacíos y tener una longitud máxima de 63 caracteres.
  • Las claves y los valores solo pueden contener letras minúsculas, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar codificación UTF-8 y se permiten caracteres internacionales.
  • La porción de clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave con varios recursos.
  • Las claves deben comenzar con una letra en minúscula o un carácter internacional.

Consulta el documento de Google Cloud para obtener más detalles.
summarySpec

object (SummarySpec)

Es una especificación para configurar el resumen que se muestra en la respuesta.
filter

string

La sintaxis del filtro consta de un lenguaje de expresión para la construcción de un predicado de uno o más campos de los documentos que se filtran. La expresión de filtro distingue mayúsculas de minúsculas. Se usará para filtrar los resultados de la búsqueda, lo que puede afectar la respuesta del resumen.

Si este campo no se reconoce, se muestra un INVALID_ARGUMENT.

El filtrado en Vertex AI Search se realiza asignando la clave de filtro LHS a una propiedad de clave definida en el backend de Vertex AI Search. El cliente define esta asignación en su esquema. Por ejemplo, un cliente de medios podría tener un campo "name" en su esquema. En este caso, el filtro se vería de la siguiente manera: filter --> name:'ANY("king kong")'

Para obtener más información sobre el filtrado, incluida la sintaxis y los operadores de filtro, consulta Filtro.
boostSpec

object (BoostSpec)

Es una especificación de aumento para aumentar ciertos documentos en los resultados de la búsqueda, lo que puede afectar la respuesta de la conversación. Para obtener más información sobre el aumento, consulta Aumento.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ConverseConversationResponse.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

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

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • discoveryengine.conversations.converse

Para obtener más información, consulta la documentación de IAM.