SearchResponse

Messaggio di risposta per il metodo SearchService.Search.

Rappresentazione JSON
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "facets": [
    {
      object (Facet)
    }
  ],
  "totalSize": integer,
  "attributionToken": string,
  "redirectUri": string,
  "nextPageToken": string,
  "correctedQuery": string,
  "summary": {
    object (Summary)
  },
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "naturalLanguageQueryUnderstandingInfo": {
    object (NaturalLanguageQueryUnderstandingInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "searchLinkPromotions": [
    {
      object (SearchLinkPromotion)
    }
  ],
  "semanticState": enum (SemanticState)
}
Campi
results[]

object (SearchResult)

Un elenco di documenti corrispondenti. L'ordine rappresenta il ranking.

facets[]

object (Facet)

Risultati delle sfaccettature richieste dall'utente.

totalSize

integer

Il conteggio totale stimato di articoli corrispondenti indipendentemente dalla paginazione. Il conteggio di results restituito dalla paginazione potrebbe essere inferiore a totalSize corrispondenti.

attributionToken

string

Un token di ricerca univoco. Questo valore deve essere incluso nei log UserEvent risultanti da questa ricerca, il che consente un'attribuzione accurata del rendimento del modello di ricerca. In questo modo è più facile identificare una richiesta durante gli scenari di assistenza clienti.

redirectUri

string

L'URI di una pagina di reindirizzamento definita dal cliente. Se viene attivata l'azione di reindirizzamento, non viene eseguita alcuna ricerca e nella risposta vengono impostati solo redirectUri e attributionToken.

nextPageToken

string

Un token che può essere inviato come SearchRequest.page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

correctedQuery

string

Contiene la query con correzione ortografica, se trovata. Se il tipo di correzione ortografica è AUTOMATIC, i risultati di ricerca si basano su correctedQuery. In caso contrario, per la ricerca viene utilizzata la query originale.

summary

object (Summary)

Un riepilogo nei risultati di ricerca. Questo campo viene restituito solo se è impostato SearchRequest.ContentSearchSpec.summary_spec.

queryExpansionInfo

object (QueryExpansionInfo)

Informazioni sull'espansione della query per i risultati restituiti.

naturalLanguageQueryUnderstandingInfo

object (NaturalLanguageQueryUnderstandingInfo)

Solo output. Informazioni sulla comprensione delle query in linguaggio naturale per i risultati restituiti.

sessionInfo

object (SessionInfo)

Informazioni sulla sessione.

Impostato solo se viene fornito SearchRequest.session. Per maggiori dettagli, consulta la descrizione.

semanticState

enum (SemanticState)

Solo output. Indica lo stato semantico della risposta di ricerca.

Facet

Un risultato di facet.

Rappresentazione JSON
{
  "key": string,
  "values": [
    {
      object (FacetValue)
    }
  ],
  "dynamicFacet": boolean
}
Campi
key

string

La chiave per questo aspetto. Ad esempio, "colors" o "price". Corrisponde a SearchRequest.FacetSpec.FacetKey.key.

values[]

object (FacetValue)

I valori delle sfaccettature per questo campo.

dynamicFacet

boolean

Indica se il facet viene generato dinamicamente.

FacetValue

Un valore di sfaccettatura che contiene i nomi dei valori e il relativo conteggio.

Rappresentazione 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.
}
Campi
count

string (int64 format)

Numero di elementi che hanno questo valore della sfaccettatura.

Campo unione facet_value. Un valore di sfaccettatura che contiene valori. facet_value può essere solo uno dei seguenti tipi:
value

string

Valore di testo di un facet, ad esempio "Nero" per il facet "colori".

interval

object (Interval)

Valore dell'intervallo per un facet, ad esempio [10, 20) per il facet "price". Corrisponde a SearchRequest.FacetSpec.FacetKey.intervals.

QueryExpansionInfo

Informazioni che descrivono l'espansione della query, incluso se si è verificata.

Rappresentazione JSON
{
  "expandedQuery": boolean,
  "pinnedResultCount": string
}
Campi
expandedQuery

boolean

Valore booleano che descrive se si è verificata l'espansione della query.

pinnedResultCount

string (int64 format)

Numero di risultati bloccati. Questo campo viene impostato solo quando si verifica l'espansione e SearchRequest.QueryExpansionSpec.pin_unexpanded_results è impostato su true.

NaturalLanguageQueryUnderstandingInfo

Informazioni che descrivono la comprensione del linguaggio naturale eseguita sulla query di input.

Rappresentazione JSON
{
  "extractedFilters": string,
  "rewrittenQuery": string,
  "classifiedIntents": [
    string
  ],
  "structuredExtractedFilter": {
    object (StructuredExtractedFilter)
  }
}
Campi
extractedFilters

string

I filtri estratti dalla query di input.

rewrittenQuery

string

Query di input riscritta meno i filtri estratti.

classifiedIntents[]

string

Gli intent classificati dalla query di input.

structuredExtractedFilter

object (StructuredExtractedFilter)

I filtri estratti dalla query di input rappresentati in forma strutturata.

StructuredExtractedFilter

I filtri estratti dalla query di input rappresentati in forma strutturata.

Rappresentazione JSON
{
  "expression": {
    object (Expression)
  }
}
Campi
expression

object (Expression)

L'espressione che indica il filtro estratto dalla query di input in formato strutturato. Può trattarsi di un'espressione semplice che indica un singolo vincolo di stringa, numerico o di geolocalizzazione oppure di un'espressione composta, ovvero una combinazione di più espressioni collegate utilizzando gli operatori logici (OR e AND).

Espressione

L'espressione che indica il filtro estratto dalla query di input.

Rappresentazione 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.
}
Campi
Campo unione expr. Il tipo di espressione. expr può essere solo uno dei seguenti tipi:
stringConstraint

object (StringConstraint)

Espressione di vincolo della stringa.

numberConstraint

object (NumberConstraint)

Espressione di vincolo numerico.

geolocationConstraint

object (GeolocationConstraint)

Espressione del vincolo di geolocalizzazione.

andExpr

object (AndExpression)

Operatore composto logico "And" che collega più espressioni.

orExpr

object (OrExpression)

Operatore composto logico "Or" che collega più espressioni.

StringConstraint

Espressione di vincolo di un campo stringa.

Rappresentazione JSON
{
  "fieldName": string,
  "values": [
    string
  ],
  "querySegment": string
}
Campi
fieldName

string

nome del campo stringa definito nello schema.

values[]

string

Valori del campo stringa. Il record verrà restituito solo se il valore del campo corrisponde a uno dei valori specificati qui.

querySegment

string

Identifica le parole chiave all'interno della query di ricerca che corrispondono a un filtro.

NumberConstraint

Espressione di vincolo di un campo numerico. Esempio: price < 100.

Rappresentazione JSON
{
  "fieldName": string,
  "comparison": enum (Comparison),
  "value": number,
  "querySegment": string
}
Campi
fieldName

string

nome del campo numerico come definito nello schema.

comparison

enum (Comparison)

L'operazione di confronto eseguita tra il valore del campo e il valore specificato nel vincolo.

value

number

Il valore specificato nel vincolo numerico.

querySegment

string

Identifica le parole chiave all'interno della query di ricerca che corrispondono a un filtro.

Confronto

L'operazione di confronto eseguita.

Enum
COMPARISON_UNSPECIFIED Operatore di confronto non definito.
EQUALS Indica l'operatore di uguaglianza =.
LESS_THAN_EQUALS Indica l'operatore minore o uguale a <=.
LESS_THAN Indica un operatore inferiore a <.
GREATER_THAN_EQUALS Indica l'operatore maggiore o uguale a >=.
GREATER_THAN Indica l'operatore maggiore di >.

GeolocationConstraint

Vincolo di un campo di geolocalizzazione. Nome del campo di geolocalizzazione definito nello schema.

Rappresentazione JSON
{
  "fieldName": string,
  "address": string,
  "latitude": number,
  "longitude": number,
  "radiusInMeters": number
}
Campi
fieldName

string

Il nome del campo di geolocalizzazione definito nello schema.

address

string

L'indirizzo di riferimento dedotto dalla query di input. La vicinanza dell'indirizzo di riferimento al campo di geolocalizzazione verrà utilizzata per filtrare i risultati.

latitude

number

La latitudine della geolocalizzazione dedotta dalla query di input.

longitude

number

La longitudine della geolocalizzazione dedotta dalla query di input.

radiusInMeters

number

Il raggio in metri intorno all'indirizzo. Il record viene restituito se la posizione del campo di geolocalizzazione si trova all'interno del raggio.

AndExpression

Operatore logico And.

Rappresentazione JSON
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
Campi
expressions[]

object (Expression)

Le espressioni unite con l'operatore AND.

OrExpression

Operatore logico Or.

Rappresentazione JSON
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
Campi
expressions[]

object (Expression)

Le espressioni unite con l'operatore OR.

SessionInfo

Informazioni sulla sessione.

Rappresentazione JSON
{
  "name": string,
  "queryId": string
}
Campi
name

string

Il nome della sessione. Se viene utilizzata la modalità di sessione automatica (quando SearchRequest.session termina con "-"), questo campo contiene il nome della sessione appena generato.

queryId

string

ID query corrispondente a questa chiamata API di ricerca. Una sessione può avere più turni, ognuno con un ID query univoco.

Se specifichi il nome della sessione e questo ID query nella chiamata API Answer, la generazione della risposta avviene nel contesto dei risultati di ricerca di questa chiamata di ricerca.

SemanticState

Stato semantico della risposta di ricerca.

Enum
SEMANTIC_STATE_UNSPECIFIED Valore predefinito. Non deve essere utilizzato.
DISABLED La ricerca semantica è stata disattivata per questa risposta di ricerca.
ENABLED La ricerca semantica è stata abilitata per questa risposta di ricerca.