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

Completa la entrada del usuario con sugerencias de palabras clave avanzadas.

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
completionConfig

string

Obligatorio. Es el nombre del recurso completionConfig del almacén de datos principal o del motor 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 con 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. Es la entrada de escritura anticipada que se usa para recuperar sugerencias. La longitud máxima es de 128 caracteres.

La búsqueda no puede estar vacía para la mayoría de los tipos de sugerencias. Si está vacío, se muestra un error INVALID_ARGUMENT. La excepción es cuando suggestionTypes solo contiene el tipo RECENT_SEARCH, la búsqueda puede ser una cadena vacía. Esta se denomina función de "prefijo cero", que devuelve las búsquedas recientes del usuario dada la consulta vacía.
queryModel

string

Especifica el modelo de consulta de autocompletado, que solo se aplica al SuggestionType QUERY. Esto 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 el usuario
  • search-history: Se usan sugerencias generadas a partir del historial de llamadas a la API de SearchService.Search. No lo uses cuando no haya tráfico para la API de Search.
  • user-event: Se usan sugerencias generadas a partir de eventos de búsqueda importados por el usuario.
  • document-completable: Se usan sugerencias tomadas directamente de los campos de documentos importados por el usuario y marcados como completables.

Valores predeterminados:

  • document es el modelo predeterminado para los almacenes de datos normales.
  • search-history es el modelo predeterminado para los almacenes de datos de la búsqueda en sitios.
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 accede al sitio web o sale de él.

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. Es la información sobre el usuario final.

Debe ser la misma información del 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 búsqueda completa. Incluso si se establece como verdadero, si hay sugerencias que coinciden con la búsqueda completa, se muestran esas sugerencias y no se muestran sugerencias de cola.
boostSpec

object (BoostSpec)

Opcional. Es la especificación para potenciar las sugerencias que coinciden con la condición.
suggestionTypes[]

enum (SuggestionType)

Opcional. Son los tipos de sugerencias que se devolverán. Si está vacío o no se especifica, se devuelven sugerencias de búsqueda. Por el momento, solo se admite un tipo de sugerencia.
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

Opcional. Es la especificación de cada tipo de sugerencia.
experimentIds[]

string

Opcional. Son los IDs de los experimentos para esta solicitud.

Cuerpo de la respuesta

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

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/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 Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso completionConfig:

  • discoveryengine.completionConfigs.completeQuery

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