SearchResponse

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

Representação JSON 
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "facets": [
    {
      object (Facet)
    }
  ],
  "guidedSearchResult": {
    object (GuidedSearchResult)
  },
  "totalSize": integer,
  "attributionToken": string,
  "redirectUri": string,
  "nextPageToken": string,
  "correctedQuery": string,
  "suggestedQuery": string,
  "summary": {
    object (Summary)
  },
  "appliedControls": [
    string
  ],
  "geoSearchDebugInfo": [
    {
      object (GeoSearchDebugInfo)
    }
  ],
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "naturalLanguageQueryUnderstandingInfo": {
    object (NaturalLanguageQueryUnderstandingInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "oneBoxResults": [
    {
      object (OneBoxResult)
    }
  ],
  "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.
guidedSearchResult

object (GuidedSearchResult)

Resultado da pesquisa guiada.
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.
suggestedQuery

string

Consulta corrigida com confiança baixa, também conhecida como consulta "Quis dizer". Em comparação com correctedQuery, este campo é definido quando o SpellCorrector devolveu uma resposta, mas o FPR(substituição da página completa) não é acionado porque a correção tem um nível de confiança baixo(por exemplo, foi revertida porque existem correspondências da consulta original no corpus de documentos).
summary

object (Summary)

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

string

Controlos aplicados como parte do serviço de controlo.
geoSearchDebugInfo[]

object (GeoSearchDebugInfo)
queryExpansionInfo

object (QueryExpansionInfo)

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

object (NaturalLanguageQueryUnderstandingInfo)

Informações de compreensão de consultas de linguagem natural 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.
oneBoxResults[]

object (OneBoxResult)

Uma lista de resultados da caixa Um. Podem existir vários resultados da caixa única de diferentes tipos.

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.

GuidedSearchResult

Resultado da pesquisa guiada. A pesquisa guiada ajuda o utilizador a refinar os resultados da pesquisa e a restringir as suas necessidades reais a partir de resultados da pesquisa mais amplos.

Representação JSON 
{
  "refinementAttributes": [
    {
      object (RefinementAttribute)
    }
  ],
  "followUpQuestions": [
    string
  ]
}
Campos
refinementAttributes[]

object (RefinementAttribute)

Uma lista de atributos de refinamento classificados.
followUpQuestions[]

string

Perguntas de seguimento sugeridas.

RefinementAttribute

Atributo útil para refinamentos de resultados da pesquisa.

Representação JSON 
{
  "attributeKey": string,
  "attributeValue": string
}
Campos
attributeKey

string

chave de atributo usada para refinar os resultados. Por exemplo, "movie_type".
attributeValue

string

valor do atributo usado para refinar os resultados. Por exemplo, "drama".

GeoSearchDebugInfo

Informações de depuração especificamente relacionadas com problemas de geocodificação direta resultantes da pesquisa de geolocalização.

Representação JSON 
{
  "originalAddressQuery": string,
  "errorMessage": string
}
Campos
originalAddressQuery

string

A morada a partir da qual a ingestão de geocodificação direta produziu problemas.
errorMessage

string

O erro produzido.

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.

NaturalLanguageQueryUnderstandingInfo

Informações que descrevem a compreensão de linguagem natural realizada na consulta de entrada.

Representação JSON 
{
  "extractedFilters": string,
  "rewrittenQuery": string,
  "classifiedIntents": [
    string
  ],
  "structuredExtractedFilter": {
    object (StructuredExtractedFilter)
  }
}
Campos
extractedFilters

string

Os filtros que foram extraídos da consulta de entrada.
rewrittenQuery

string

Consulta de entrada reescrita menos os filtros extraídos.
classifiedIntents[]

string

As intenções classificadas da consulta de entrada.
structuredExtractedFilter

object (StructuredExtractedFilter)

Os filtros que foram extraídos da consulta de entrada representados de forma estruturada.

StructuredExtractedFilter

Os filtros que foram extraídos da consulta de entrada representados de forma estruturada.

Representação JSON 
{
  "expression": {
    object (Expression)
  }
}
Campos
expression

object (Expression)

A expressão que denota o filtro que foi extraído da consulta de entrada de forma estruturada. Pode ser uma expressão simples que denote uma única restrição de string, numérica ou de geolocalização, ou uma expressão composta, que é uma combinação de várias expressões ligadas através de operadores lógicos (OU e E).

Expressão

A expressão que denota o filtro que foi extraído da consulta de entrada.

Representação JSON 
{

  // Union field expr can be only one of the following:
  "stringConstraint": {
    object (StringConstraint)
  },
  "numberConstraint": {
    object (NumberConstraint)
  },
  "geolocationConstraint": {
    object (GeolocationConstraint)
  },
  "andExpr": {
    object (AndExpression)
  },
  "orExpr": {
    object (OrExpression)
  }
  // End of list of possible types for union field expr.
}
Campos
Campo de união expr. O tipo de expressão. expr só pode ser uma das seguintes opções:
stringConstraint

object (StringConstraint)

Expressão de restrição de string.
numberConstraint

object (NumberConstraint)

Expressão de restrição numérica.
geolocationConstraint

object (GeolocationConstraint)

Expressão de restrição de geolocalização.
andExpr

object (AndExpression)

Operador composto lógico "And" que liga várias expressões.
orExpr

object (OrExpression)

Operador composto lógico "Ou" que liga várias expressões.

StringConstraint

Expressão de restrição de um campo de string.

Representação JSON 
{
  "fieldName": string,
  "values": [
    string
  ],
  "querySegment": string
}
Campos
fieldName

string

nome do campo de string, conforme definido no esquema.
values[]

string

Valores do campo de string. O registo só é devolvido se o valor do campo corresponder a um dos valores especificados aqui.
querySegment

string

Identifica as palavras-chave na consulta de pesquisa que correspondem a um filtro.

NumberConstraint

Expressão de restrição de um campo numérico. Exemplo: price < 100.

Representação JSON 
{
  "fieldName": string,
  "comparison": enum (Comparison),
  "value": number,
  "querySegment": string
}
Campos
fieldName

string

nome do campo numérico, conforme definido no esquema.
comparison

enum (Comparison)

A operação de comparação realizada entre o valor do campo e o valor especificado na restrição.
value

number

O valor especificado na restrição numérica.
querySegment

string

Identifica as palavras-chave na consulta de pesquisa que correspondem a um filtro.

Comparação

A operação de comparação que foi realizada.

Enumerações
COMPARISON_UNSPECIFIED Operador de comparação indefinido.
EQUALS Denota o operador de igualdade =.
LESS_THAN_EQUALS Denota o operador menor ou igual a <=.
LESS_THAN Denota um operador inferior a <.
GREATER_THAN_EQUALS Denota o operador >= superior ou igual a.
GREATER_THAN Indica o operador de superior a >.

GeolocationConstraint

Restrição de um campo de geolocalização. Nome do campo de geolocalização conforme definido no esquema.

Representação JSON 
{
  "fieldName": string,
  "address": string,
  "latitude": number,
  "longitude": number,
  "radiusInMeters": number
}
Campos
fieldName

string

O nome do campo de geolocalização, conforme definido no esquema.
address

string

A morada de referência que foi inferida a partir da consulta de entrada. A proximidade da morada de referência ao campo de geolocalização é usada para filtrar os resultados.
latitude

number

A latitude da geolocalização inferida a partir da consulta de entrada.
longitude

number

A longitude da geolocalização inferida a partir da consulta de entrada.
radiusInMeters

number

O raio em metros em redor da morada. O registo é devolvido se a localização do campo de geolocalização estiver dentro do raio.

AndExpression

Operador lógico And.

Representação JSON 
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
Campos
expressions[]

object (Expression)

As expressões que foram associadas por E.

OrExpression

Operador lógico Or.

Representação JSON 
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
Campos
expressions[]

object (Expression)

As expressões que foram unidas com OR.

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.

OneBoxResult

OneBoxResult é um contentor para todos os resultados de um tipo específico que queremos apresentar na IU de forma diferente.

Representação JSON 
{
  "oneBoxType": enum (OneBoxType),
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Campos
oneBoxType

enum (OneBoxType)

O tipo de resultado da caixa única.
searchResults[]

object (SearchResult)

Os resultados da pesquisa para esta caixa única.

OneBoxType

O tipo de resultado da caixa única.

Enumerações
ONE_BOX_TYPE_UNSPECIFIED Valor predefinido. Não deve ser usado.
PEOPLE Um resultado de caixa contém resultados de pessoas.
ORGANIZATION Um resultado de caixa contém resultados da organização.
SLACK Um resultado da caixa contém resultados com folga.
KNOWLEDGE_GRAPH Um resultado de caixa contém respostas de pesquisa do Gráfico de Conhecimento.