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 solicitadas pelo usuário.
guidedSearchResult

object (GuidedSearchResult)

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

string

Consulta corrigida com baixa confiança, também conhecida como consulta "Você quis dizer". Comparado com "correctedQuery", esse campo é definido quando o SpellCorrector retorna uma resposta, mas a FPR(substituição de página inteira) não é acionada porque a correção tem baixa confiança(por exemplo, invertida porque há correspondências da consulta original no corpus do documento).
summary

object (Summary)

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

string

Controles aplicados como parte do serviço de controle.
geoSearchDebugInfo[]

object (GeoSearchDebugInfo)
queryExpansionInfo

object (QueryExpansionInfo)

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

object (NaturalLanguageQueryUnderstandingInfo)

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

object (OneBoxResult)

Uma lista de resultados do OneBox. Pode haver 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 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.

GuidedSearchResult

Resultado da pesquisa guiada. A pesquisa guiada ajuda o usuário a refinar os resultados e restringir a pesquisa para encontrar o que ele realmente precisa.

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

object (RefinementAttribute)

Uma lista de atributos de refinamento classificados.
followUpQuestions[]

string

Perguntas complementares 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 a problemas de geocodificação direta decorrentes da Pesquisa de geolocalização.

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

string

O endereço em que a ingestão de geocodificação direta gerou problemas.
errorMessage

string

O erro produzido.

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".

NaturalLanguageQueryUnderstandingInfo

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

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

string

Os filtros extraídos da consulta de entrada.
rewrittenQuery

string

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

string

Os objetivos classificados da consulta de entrada.
structuredExtractedFilter

object (StructuredExtractedFilter)

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

StructuredExtractedFilter

Os filtros 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 extraído da consulta de entrada de forma estruturada. Pode ser uma expressão simples que denota uma única string, restrição numérica ou de geolocalização ou uma expressão composta, que é uma combinação de várias expressões conectadas usando operadores lógicos (OR e AND).

Expressão

A expressão que denota o filtro 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 pode ser apenas de um dos tipos a seguir:
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 "E" que conecta várias expressões.
orExpr

object (OrExpression)

Operador composto lógico "Or" que conecta 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 registro só será retornado 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.

Tipos enumerados
COMPARISON_UNSPECIFIED Operador de comparação indefinido.
EQUALS Denota o operador de igualdade =.
LESS_THAN_EQUALS Denota o operador menor que ou igual a <=.
LESS_THAN Indica o operador "menor que" (<).
GREATER_THAN_EQUALS Denota o operador maior ou igual a >=.
GREATER_THAN Denota o operador "maior que" >.

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

O endereço de referência que foi inferido da consulta de entrada. A proximidade do endereço de referência ao campo de geolocalização será usada para filtrar os resultados.
latitude

number

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

number

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

number

O raio em metros ao redor do endereço. O registro será retornado se o local 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 unidas com AND.

OrExpression

Operador lógico Or.

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

object (Expression)

As expressões que foram combinadas com OR.

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.

OneBoxResult

OneBoxResult é um contêiner para todos os resultados de um tipo específico que queremos mostrar de maneira diferente na UI.

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

enum (OneBoxType)

O tipo de resultado de uma caixa.
searchResults[]

object (SearchResult)

Os resultados da pesquisa para esta caixa do Google.

OneBoxType

O tipo de resultado de uma caixa.

Tipos enumerados
ONE_BOX_TYPE_UNSPECIFIED Valor padrão. Não pode ser usado.
PEOPLE Uma caixa de resultados contém resultados de pessoas.
ORGANIZATION Uma caixa de resultados contém resultados da organização.
SLACK Uma caixa de resultados contém resultados de folga.
KNOWLEDGE_GRAPH Um resultado do OneBox contém respostas da pesquisa do Mapa de informações.