Method: projects.locations.collections.engines.servingConfigs.answer

Es el método de respuesta a la consulta.

Solicitud HTTP


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

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
servingConfig

string

Obligatorio. Es el nombre del recurso de la configuración de entrega de 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 de agentes 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. Es la consulta del usuario actual.
session

string

Es el nombre del recurso de sesión. No requerido.

Cuando no se configura el campo de sesión, la API se encuentra 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 nuevo ID.
safetySpec

object (SafetySpec)

Especificación del modelo
relatedQuestionsSpec

object (RelatedQuestionsSpec)

Es la especificación de preguntas relacionadas.
groundingSpec

object (GroundingSpec)

Es opcional. Es la especificación de fundamentación.
answerGenerationSpec

object (AnswerGenerationSpec)

Es la especificación de generación de respuestas.
searchSpec

object (SearchSpec)

Es la especificación de servingConfigs.search.
queryUnderstandingSpec

object (QueryUnderstandingSpec)

Es la especificación de comprensión de la búsqueda.
asynchronousMode
(deprecated)

boolean

Obsoleto: Este campo está obsoleto. Se admitirá la API de Streaming Answer.

Control del modo asíncrono.

Si está habilitado, la respuesta se devolverá 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

Es 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 debe cambiar si el visitante se conecta o desconecta del sitio web.

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 128 caracteres. De lo contrario, se devuelve un error INVALID_ARGUMENT.
userLabels

map (key: string, value: string)

Las etiquetas de usuario que se aplican 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 en minúscula, números, 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 en varios recursos.
  • Las claves deben empezar 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. Es la especificación para el 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.