Method: projects.locations.dataStores.servingConfigs.answer

Método answer de la consulta.

Solicitud HTTP

POST https://discoveryengine.googleapis.com/v1beta/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:answer

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

Parámetros de ruta

Parámetros
servingConfig

string

Obligatorio. El nombre del recurso de la configuración de entrega servingConfigs.search, como projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config o projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config.

O el nombre del recurso de la configuración de entrega del motor del agente, como projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer. (se usa cuando enableAgentInvocation se establece en verdadero y tienes configurado un motor del agente AI_MODE personalizado)

Este campo se usa para identificar el nombre de la configuración de entrega, el conjunto de modelos que se usan para realizar la búsqueda.

Cuerpo de la solicitud

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

Representación JSON 
{
  "query": {
    object (Query)
  },
  "session": string,
  "safetySpec": {
    object (SafetySpec)
  },
  "relatedQuestionsSpec": {
    object (RelatedQuestionsSpec)
  },
  "groundingSpec": {
    object (GroundingSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },
  "searchSpec": {
    object (SearchSpec)
  },
  "queryUnderstandingSpec": {
    object (QueryUnderstandingSpec)
  },
  "asynchronousMode": boolean,
  "userPseudoId": string,
  "userLabels": {
    string: string,
    ...
  },
  "endUserSpec": {
    object (EndUserSpec)
  }
}
Campos
query

object (Query)

Obligatorio. Consulta del usuario actual.
session

string

El nombre del recurso de la sesión. No requerido.

Cuando no se establece el campo de sesión, la API está en modo sin sesión.

Admitimos el modo de sesión automática: los usuarios pueden usar el símbolo comodín - como ID de sesión. Se generará y asignará automáticamente un ID nuevo.
safetySpec

object (SafetySpec)

Especificación del modelo.
relatedQuestionsSpec

object (RelatedQuestionsSpec)

Especificación de preguntas relacionadas.
groundingSpec

object (GroundingSpec)

Es opcional. Especificación de Grounding.
answerGenerationSpec

object (AnswerGenerationSpec)

Especificación de generación de respuestas.
searchSpec

object (SearchSpec)

Especificación de servingConfigs.search.
queryUnderstandingSpec

object (QueryUnderstandingSpec)

Especificación de comprensión de consultas.
asynchronousMode
(deprecated)

boolean

Obsoleto: Este campo ya no está disponible. Se admitirá la API de transmisión de respuestas.

Control del modo asíncrono.

Si está habilitado, la respuesta se mostrará con el nombre del recurso de respuesta o sesión sin la respuesta final. Los usuarios de la API deben realizar el sondeo para obtener el estado más reciente de la respuesta o la sesión llamando al método ConversationalSearchService.GetAnswer o ConversationalSearchService.GetSession.
userPseudoId

string

Un identificador único para hacer un seguimiento de los visitantes. Por ejemplo, esto se podría implementar con una cookie HTTP, que debería poder identificar de forma única a un visitante en un solo dispositivo. Este identificador único no debería cambiar si el visitante accede al sitio web o sale de él.

Este campo NO debe tener un valor fijo, como unknown_visitor.

El campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 128 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.
userLabels

map (key: string, value: string)

Las etiquetas de usuario aplicadas a un recurso deben cumplir con 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 la codificación UTF-8 y se permiten los 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.
endUserSpec

object (EndUserSpec)

Es opcional. Especificación del usuario final.

Cuerpo de la respuesta

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

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 servingConfig:

  • discoveryengine.servingConfigs.answer

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