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 pedidas pelo utilizador.
totalSize

integer

A contagem total estimada de itens correspondentes, independentemente da paginação. A quantidade de results devolvida pela paginação pode ser inferior à quantidade de totalSize que corresponde.
attributionToken

string

Um token de pesquisa único. Isto deve ser incluído nos registos UserEvent resultantes desta pesquisa, o que permite uma atribuição precisa do desempenho do modelo de pesquisa. Isto também ajuda a identificar um pedido durante os cenários de apoio técnico ao cliente.
redirectUri

string

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

string

Um token que pode ser enviado como SearchRequest.page_token para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.
correctedQuery

string

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

object (Summary)

Um resumo como parte dos resultados da pesquisa. Este campo só é devolvido se SearchRequest.ContentSearchSpec.summary_spec estiver definido.
queryExpansionInfo

object (QueryExpansionInfo)

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

object (SessionInfo)

Informações da sessão.

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

Atributo

Um resultado de atributo.

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

string

A chave desta faceta. Por exemplo, "colors" ou "price". Corresponde a SearchRequest.FacetSpec.FacetKey.key.
values[]

object (FacetValue)

Os valores da faceta para este campo.
dynamicFacet

boolean

Se o aspeto é gerado dinamicamente.

FacetValue

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

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 artigos que têm este valor de faceta.
Campo de união facet_value. Um valor de faceta que contém valores. facet_value só pode ser uma das seguintes opções:
value

string

Valor de texto de uma faceta, como "Preto" para a faceta "cores".
interval

object (Interval)

Valor do intervalo para uma faceta, como [10, 20) para a faceta "price". Corresponde a SearchRequest.FacetSpec.FacetKey.intervals.

QueryExpansionInfo

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

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

boolean

Valor booleano que descreve se ocorreu a expansão da consulta.
pinnedResultCount

string (int64 format)

Número de resultados fixados. Este campo só é definido quando ocorre a expansão e SearchRequest.QueryExpansionSpec.pin_unexpanded_results está definido como verdadeiro.

SessionInfo

Informações sobre a sessão.

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

string

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

string

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

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