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

Método de respuesta a la consulta.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
servingConfig

string

Obligatorio. Nombre del recurso de la configuración de publicación de la búsqueda servingConfigs, como projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config o projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config. Este campo se usa para identificar el nombre de la configuración de servicio, el conjunto de modelos que se usan para hacer la búsqueda.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan 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

Nombre de recurso de la sesión. No es obligatorio.

Si no se define el campo de sesión, la API estará 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á un nuevo ID automáticamente.
safetySpec

object (SafetySpec)

Especificación del modelo.
relatedQuestionsSpec

object (RelatedQuestionsSpec)

Especificación de las preguntas relacionadas.
groundingSpec

object (GroundingSpec)

Opcional. Especificación de la fundamentación.
answerGenerationSpec

object (AnswerGenerationSpec)

Especificación de generación de respuestas.
searchSpec

object (SearchSpec)

especificación de servingConfigs.search.
queryUnderstandingSpec

object (QueryUnderstandingSpec)

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

boolean

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

Control del modo asíncrono.

Si está habilitada, la respuesta se devolverá con el nombre del recurso de respuesta o sesión sin la respuesta final. Los usuarios de la API deben hacer 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

Identificador único para hacer un seguimiento de los visitantes. Por ejemplo, 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 inicia o cierra sesión en el 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 aplicadas a un recurso deben cumplir los siguientes requisitos:

  • Cada recurso puede tener varias etiquetas, hasta un máximo de 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, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se pueden utilizar caracteres internacionales.
  • La parte de la clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave con varios recursos.
  • Las claves deben empezar por una letra minúscula o un carácter internacional.

Consulta más información en el documento de Google Cloud.
endUserSpec

object (EndUserSpec)

Opcional. Especificación del usuario final.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, en el cuerpo de la respuesta se incluye una instancia de AnswerQueryResponse.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

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

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso servingConfig:

  • discoveryengine.servingConfigs.answer

Para obtener más información, consulta la documentación de gestión de identidades y accesos.