SearchResponse

Mensaje de respuesta para el método SearchService.Search.

Representación JSON
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "facets": [
    {
      object (Facet)
    }
  ],
  "totalSize": integer,
  "attributionToken": string,
  "redirectUri": string,
  "nextPageToken": string,
  "correctedQuery": string,
  "summary": {
    object (Summary)
  },
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "searchLinkPromotions": [
    {
      object (SearchLinkPromotion)
    }
  ]
}
Campos
results[]

object (SearchResult)

Es una lista de documentos coincidentes. El orden representa la clasificación.

facets[]

object (Facet)

Son los resultados de las facetas solicitadas por el usuario.

totalSize

integer

Es el recuento total estimado de artículos coincidentes, sin importar la paginación. El recuento de results que devuelve la paginación puede ser menor que el de totalSize que coincide.

attributionToken

string

Es un token de búsqueda único. Esto se debe incluir en los registros de UserEvent que resulten de esta búsqueda, lo que permite una atribución precisa del rendimiento del modelo de búsqueda. Esto también ayuda a identificar una solicitud durante las situaciones de asistencia al cliente.

redirectUri

string

Es el URI de una página de redireccionamiento definida por el cliente. Si se activa la acción de redireccionamiento, no se realiza ninguna búsqueda y solo se configuran redirectUri y attributionToken en la respuesta.

nextPageToken

string

Es un token que se puede enviar como SearchRequest.page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

correctedQuery

string

Contiene la consulta corregida ortográficamente, si se encuentra. Si el tipo de corrección ortográfica es AUTOMATIC, los resultados de la búsqueda se basan en correctedQuery. De lo contrario, se usa la búsqueda original.

summary

object (Summary)

Es un resumen que forma parte de los resultados de la búsqueda. Este campo solo se devuelve si se configura SearchRequest.ContentSearchSpec.summary_spec.

queryExpansionInfo

object (QueryExpansionInfo)

Es la información de expansión de la búsqueda para los resultados devueltos.

sessionInfo

object (SessionInfo)

Es la información de la sesión.

Solo se establece si se proporciona SearchRequest.session. Consulta la descripción para obtener más detalles.

Faceta

Es un resultado de faceta.

Representación JSON
{
  "key": string,
  "values": [
    {
      object (FacetValue)
    }
  ],
  "dynamicFacet": boolean
}
Campos
key

string

Es la clave de esta faceta. Por ejemplo, "colors" o "price". Coincide con SearchRequest.FacetSpec.FacetKey.key.

values[]

object (FacetValue)

Son los valores de faceta para este campo.

dynamicFacet

boolean

Indica si la faceta se genera de forma dinámica.

FacetValue

Es un valor de faceta que contiene nombres de valores y su recuento.

Representación JSON
{
  "count": string,

  // Union field facet_value can be only one of the following:
  "value": string,
  "interval": {
    object (Interval)
  }
  // End of list of possible types for union field facet_value.
}
Campos
count

string (int64 format)

Es la cantidad de elementos que tienen este valor de faceta.

Campo de unión facet_value. Es un valor de faceta que contiene valores. facet_value puede ser solo uno de los siguientes:
value

string

Es el valor de texto de una faceta, como "Negro" para la faceta "colores".

interval

object (Interval)

Es el valor del intervalo para una faceta, como [10, 20) para la faceta "precio". Coincide con SearchRequest.FacetSpec.FacetKey.intervals.

QueryExpansionInfo

Es información que describe la búsqueda expandida, incluido si se produjo la expansión.

Representación JSON
{
  "expandedQuery": boolean,
  "pinnedResultCount": string
}
Campos
expandedQuery

boolean

Es un valor booleano que describe si se produjo la búsqueda expandida.

pinnedResultCount

string (int64 format)

Cantidad de resultados fijados. Este campo solo se establecerá cuando se produzca la expansión y SearchRequest.QueryExpansionSpec.pin_unexpanded_results se establezca como verdadero.

SessionInfo

Es información sobre la sesión.

Representación JSON
{
  "name": string,
  "queryId": string
}
Campos
name

string

Nombre de la sesión. Si se usa el modo de sesión automática (cuando SearchRequest.session termina con "-"), este campo contiene el nombre de la sesión recién generada.

queryId

string

Es el ID de la búsqueda que corresponde a esta llamada a la API de Search. Una sesión puede tener varios turnos, cada uno con un ID de búsqueda único.

Si especificas el nombre de la sesión y este ID de búsqueda en la llamada a la API de Answer, la generación de la respuesta se realizará en el contexto de los resultados de la búsqueda de esta llamada de búsqueda.