SearchResponse

Mensagem de resposta para o método SearchService.Search.

Representação 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)

Uma lista de documentos correspondentes. A ordem representa a classificação.
facets[]

object (Facet)

Resultados das facetas solicitadas pelo usuário.
totalSize

integer

A contagem total estimada de itens correspondentes, independentemente da paginação. A contagem de results retornada pela paginação pode ser menor que a totalSize correspondente.
attributionToken

string

Um token de pesquisa exclusivo. Isso precisa ser incluído nos registros UserEvent resultantes dessa pesquisa, o que permite a atribuição precisa da performance do modelo de pesquisa. Isso também ajuda a identificar uma solicitação durante os cenários de suporte ao cliente.
redirectUri

string

O URI de uma página de redirecionamento definida pelo cliente. Se a ação de redirecionamento for acionada, nenhuma pesquisa será realizada, e apenas redirectUri e attributionToken serão definidos na resposta.
nextPageToken

string

Um token que pode ser enviado como SearchRequest.page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.
correctedQuery

string

Contém a consulta com grafia corrigida, se encontrada. Se o tipo de correção ortográfica for AUTOMATIC, os resultados da pesquisa serão baseados em "correctedQuery". Caso contrário, a consulta original será usada para a pesquisa.
summary

object (Summary)

Um resumo como parte dos resultados da pesquisa. Esse campo só será retornado se SearchRequest.ContentSearchSpec.summary_spec estiver definido.
queryExpansionInfo

object (QueryExpansionInfo)

Informações de expansão de consulta para os resultados retornados.
sessionInfo

object (SessionInfo)

Informações da sessão.

Só é definido se SearchRequest.session for fornecido. Consulte a descrição para mais detalhes.

Atributo

Um resultado de atributo.

Representação JSON 
{
  "key": string,
  "values": [
    {
      object (FacetValue)
    }
  ],
  "dynamicFacet": boolean
}
Campos
key

string

A chave desse atributo. Por exemplo, "colors" ou "price". Ele corresponde a SearchRequest.FacetSpec.FacetKey.key.
values[]

object (FacetValue)

Os valores de atributo para este campo.
dynamicFacet

boolean

Indica se o refinamento é gerado dinamicamente.

FacetValue

Um valor de faceta que contém nomes de valores e a contagem deles.

Representação 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 itens que têm esse valor de atributo.
Campo de união facet_value. Um valor de faceta que contém valores. facet_value pode ser apenas de um dos tipos a seguir:
value

string

Valor de texto de um atributo, como "Preto" para o atributo "cores".
interval

object (Interval)

Valor do intervalo para um atributo, como [10, 20) para o atributo "price". Ele corresponde a SearchRequest.FacetSpec.FacetKey.intervals.

QueryExpansionInfo

Informações que descrevem a expansão de consulta, incluindo se ela ocorreu.

Representação JSON 
{
  "expandedQuery": boolean,
  "pinnedResultCount": string
}
Campos
expandedQuery

boolean

Booleano que descreve se a expansão de consulta ocorreu.
pinnedResultCount

string (int64 format)

Número de resultados fixados. Esse campo só será definido quando a expansão ocorrer e SearchRequest.QueryExpansionSpec.pin_unexpanded_results estiver definido como "true".

SessionInfo

Informações sobre a sessão.

Representação JSON 
{
  "name": string,
  "queryId": string
}
Campos
name

string

Nome da sessão. Se o modo de sessão automática for usado (quando SearchRequest.session termina com "-"), esse campo vai conter o nome da sessão recém-gerada.
queryId

string

ID da consulta que corresponde a esta chamada da API Search. Uma sessão pode ter vários turnos, cada um com um ID de consulta exclusivo.

Ao especificar o nome da sessão e esse ID de consulta na chamada da API Answer, a geração de respostas acontece no contexto dos resultados da pesquisa dessa chamada.