Method: projects.locations.dataStores.completeQuery

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

Solicitud HTTP

GET https://discoveryengine.googleapis.com/v1/{dataStore=projects/*/locations/*/dataStores/*}:completeQuery

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

Parámetros de ruta

Parámetros
dataStore

string

Obligatorio. Nombre del recurso del almacén de datos superior para el que se realiza la finalización, como projects/*/locations/global/collections/default_collection/dataStores/default_data_store.

Los parámetros de consulta

Parámetros
query

string

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

string

Especifica el modelo de datos de autocompletado. 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 128 caracteres. De lo contrario, se devuelve un error INVALID_ARGUMENT.
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.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

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

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/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 dataStore:

  • discoveryengine.dataStores.completeQuery

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