SearchResponse

Mensaje de respuesta del 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)

Lista de documentos coincidentes. El orden representa la clasificación.

facets[]

object (Facet)

Resultados de las facetas solicitadas por el usuario.

totalSize

integer

El recuento total estimado de elementos coincidentes, independientemente de la paginación. El recuento de results devuelto por la paginación puede ser inferior al de totalSize que coincida.

attributionToken

string

Un token de búsqueda único. Esto debe incluirse en los UserEvent registros resultantes de esta búsqueda, lo que permite atribuir con precisión el rendimiento del modelo de búsqueda. Esto también ayuda a identificar una solicitud durante las situaciones de asistencia al cliente.

redirectUri

string

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

nextPageToken

string

Token que se puede enviar como SearchRequest.page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

correctedQuery

string

Contiene la consulta con la ortografía corregida, si se ha encontrado. Si el tipo de corrección ortográfica es AUTOMATIC, los resultados de búsqueda se basan en correctedQuery. De lo contrario, se usa la consulta original para la búsqueda.

summary

object (Summary)

Un resumen como parte de los resultados de búsqueda. Este campo solo se devuelve si se ha definido SearchRequest.ContentSearchSpec.summary_spec.

queryExpansionInfo

object (QueryExpansionInfo)

Información sobre la ampliación de la consulta de los resultados devueltos.

sessionInfo

object (SessionInfo)

Información de la sesión.

Solo se define si se proporciona SearchRequest.session. Consulta su descripción para obtener más información.

Faceta

Un resultado de faceta.

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

string

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

values[]

object (FacetValue)

Valores de las facetas de este campo.

dynamicFacet

boolean

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

FacetValue

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)

Número de elementos que tienen este valor de faceta.

Campo de unión facet_value. Un valor de facet que contiene valores. facet_value solo puede ser una de estas dos opciones:
value

string

Valor de texto de una faceta, como "Negro" para la faceta "Colores".

interval

object (Interval)

Valor del intervalo de una faceta, como [10, 20) para la faceta "price". Coincide con SearchRequest.FacetSpec.FacetKey.intervals.

QueryExpansionInfo

Información que describe la ampliación de consultas, incluido si se ha producido o no.

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

boolean

Valor booleano que describe si se ha ampliado la consulta.

pinnedResultCount

string (int64 format)

Número de resultados fijados. Este campo solo se definirá cuando se produzca una expansión y SearchRequest.QueryExpansionSpec.pin_unexpanded_results tenga el valor true.

SessionInfo

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

ID de consulta que corresponde a esta llamada a la API de búsqueda. Una sesión puede tener varias interacciones, cada una con un ID de consulta único.

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