Method: projects.locations.collections.engines.completionConfig.completeQuery

Completa la información introducida por el usuario con sugerencias de palabras clave avanzadas.

Solicitud HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:completeQuery

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

Parámetros de ruta

Parámetros
completionConfig

string

Obligatorio. El valor de completionConfig del nombre del recurso de almacén de datos o buscador superior para el que se realiza la finalización, como projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

Representación JSON 
{
  "query": string,
  "queryModel": string,
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "includeTailSuggestions": boolean,
  "boostSpec": {
    object (BoostSpec)
  },
  "suggestionTypes": [
    enum (SuggestionType)
  ],
  "suggestionTypeSpecs": [
    {
      object (SuggestionTypeSpec)
    }
  ],
  "experimentIds": [
    string
  ]
}
Campos
query

string

Obligatorio. La entrada de escritura predictiva que se ha usado para obtener las sugerencias. La longitud máxima es de 128 caracteres.

La consulta no puede estar vacía en la mayoría de los tipos de sugerencias. Si está vacío, se devuelve un error INVALID_ARGUMENT. La excepción es cuando suggestionTypes solo contiene el tipo RECENT_SEARCH, en cuyo caso la consulta puede ser una cadena vacía. Se trata de la función "prefijo cero", que devuelve las consultas que ha buscado recientemente el usuario cuando se le proporciona una consulta vacía.
queryModel

string

Especifica el modelo de consulta de autocompletar, que solo se aplica al tipo de sugerencia QUERY. Esta opción anula cualquier modelo especificado en la sección Configuración > Autocompletar de la consola de Cloud. Valores admitidos actualmente:

  • document: usar sugerencias generadas a partir de documentos importados por los usuarios.
  • search-history: se usan sugerencias generadas a partir del historial de llamadas a la API SearchService.Search. No la uses cuando no haya tráfico para la API Search.
  • user-event: se usan sugerencias generadas a partir de eventos de búsqueda importados por los usuarios.
  • document-completable: se usan sugerencias tomadas directamente de los campos de documentos importados por los usuarios que están marcados como completables.

Valores predeterminados:

  • document es el modelo predeterminado de los almacenes de datos normales.
  • search-history es el modelo predeterminado de los almacenes de datos de búsqueda en el sitio.
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.

Debe ser el mismo identificador que UserEvent.user_pseudo_id y SearchRequest.user_pseudo_id.

El campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 128.
userInfo

object (UserInfo)

Opcional. Información sobre el usuario final.

Debe ser la misma información de identificador que UserEvent.user_info y SearchRequest.user_info.
includeTailSuggestions

boolean

Indica si se deben devolver sugerencias de cola si no hay sugerencias que coincidan con la consulta completa. Aunque se le asigne el valor "true", si hay sugerencias que coincidan con la consulta completa, se devolverán esas sugerencias y no se devolverán sugerencias de cola.
boostSpec

object (BoostSpec)

Opcional. Especificación para mejorar las sugerencias que coincidan con la condición.
suggestionTypes[]

enum (SuggestionType)

Opcional. Tipos de sugerencias que se devolverán. Si no se especifica o se deja en blanco, se devuelven sugerencias de consulta. Por el momento, solo se admite un tipo de sugerencia.
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

Opcional. Especificación de cada tipo de sugerencia.
experimentIds[]

string

Opcional. IDs de experimentos de esta solicitud.

Cuerpo de la respuesta

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

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
  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/discoveryengine.complete_query
  • https://www.googleapis.com/auth/discoveryengine.assist.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 completionConfig:

  • discoveryengine.completionConfigs.completeQuery

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