SearchResponse

Message de réponse pour la méthode SearchService.Search.

Représentation 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)
    }
  ]
}
Champs
results[]

object (SearchResult)

Liste des documents correspondants. L'ordre représente le classement.
facets[]

object (Facet)

Résultats des facettes demandées par l'utilisateur.
guidedSearchResult

object (GuidedSearchResult)

Résultat de recherche guidée.
totalSize

integer

Estimation du nombre total d'éléments correspondants, quelle que soit la pagination. Le nombre de results renvoyé par la pagination peut être inférieur au totalSize correspondant.
attributionToken

string

Jeton de recherche unique. Il doit être inclus dans les journaux UserEvent résultant de cette recherche, ce qui permet d'attribuer précisément les performances du modèle de recherche. Cela permet également d'identifier une demande lors des scénarios d'assistance client.
redirectUri

string

URI d'une page de redirection définie par le client. Si une action de redirection est déclenchée, aucune recherche n'est effectuée, et seuls redirectUri et attributionToken sont définis dans la réponse.
nextPageToken

string

Jeton pouvant être envoyé en tant que SearchRequest.page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.
correctedQuery

string

Contient la requête corrigée par le correcteur orthographique, le cas échéant. Si le type de correction orthographique est AUTOMATIC, les résultats de recherche sont basés sur correctedQuery. Sinon, la requête d'origine est utilisée pour la recherche.
suggestedQuery

string

Requête corrigée avec un faible degré de confiance, également appelée "Voulez-vous dire". Par rapport à correctedQuery, ce champ est défini lorsque SpellCorrector a renvoyé une réponse, mais que le remplacement de la page entière n'est pas déclenché, car la correction est peu fiable (par exemple, inversée, car il existe des correspondances de la requête d'origine dans le corpus de documents).
summary

object (Summary)

Un résumé dans les résultats de recherche. Ce champ n'est renvoyé que si SearchRequest.ContentSearchSpec.summary_spec est défini.
appliedControls[]

string

Contrôles appliqués dans le cadre du service Control.
geoSearchDebugInfo[]

object (GeoSearchDebugInfo)
queryExpansionInfo

object (QueryExpansionInfo)

Informations sur l'expansion de la requête pour les résultats renvoyés.
naturalLanguageQueryUnderstandingInfo

object (NaturalLanguageQueryUnderstandingInfo)

Informations sur la compréhension des requêtes en langage naturel pour les résultats renvoyés.
sessionInfo

object (SessionInfo)

Informations sur la session.

Défini uniquement si SearchRequest.session est fourni. Pour en savoir plus, consultez sa description.
oneBoxResults[]

object (OneBoxResult)

Liste des résultats One Box. Il peut y avoir plusieurs résultats OneBox de différents types.

Attribut

Résultat d'attribut.

Représentation JSON 
{
  "key": string,
  "values": [
    {
      object (FacetValue)
    }
  ],
  "dynamicFacet": boolean
}
Champs
key

string

Clé de cet attribut. Par exemple, "colors" ou "price". Il correspond à SearchRequest.FacetSpec.FacetKey.key.
values[]

object (FacetValue)

Valeurs d'attribut pour ce champ.
dynamicFacet

boolean

Indique si le facette est générée de manière dynamique.

FacetValue

Valeur de facette contenant les noms des valeurs et leur nombre.

Représentation 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.
}
Champs
count

string (int64 format)

Nombre d'articles associés à cette valeur d'attribut.
Champ d'union facet_value. Valeur de facette contenant des valeurs. facet_value ne peut être qu'un des éléments suivants :
value

string

Valeur textuelle d'un attribut, par exemple "Noir" pour l'attribut "couleurs".
interval

object (Interval)

Valeur d'intervalle pour un facette, par exemple [10, 20) pour la facette "prix". Il correspond à SearchRequest.FacetSpec.FacetKey.intervals.

GuidedSearchResult

Résultat de recherche guidée. La recherche guidée aide les utilisateurs à affiner les résultats de recherche et à identifier leurs besoins réels à partir de résultats de recherche plus larges.

Représentation JSON 
{
  "refinementAttributes": [
    {
      object (RefinementAttribute)
    }
  ],
  "followUpQuestions": [
    string
  ]
}
Champs
refinementAttributes[]

object (RefinementAttribute)

Liste des attributs d'affinage classés.
followUpQuestions[]

string

Questions complémentaires suggérées.

RefinementAttribute

Attribut utile pour affiner les résultats de recherche.

Représentation JSON 
{
  "attributeKey": string,
  "attributeValue": string
}
Champs
attributeKey

string

Clé d'attribut utilisée pour affiner les résultats. Par exemple, "movie_type".
attributeValue

string

valeur d'attribut utilisée pour affiner les résultats. Par exemple, "drama".

GeoSearchDebugInfo

Informations de débogage spécifiques aux problèmes de géocodage direct liés à la recherche de géolocalisation.

Représentation JSON 
{
  "originalAddressQuery": string,
  "errorMessage": string
}
Champs
originalAddressQuery

string

Adresse à partir de laquelle l'ingestion du géocodage direct a généré des problèmes.
errorMessage

string

Erreur produite.

QueryExpansionInfo

Informations décrivant l'expansion de la requête, y compris si elle a eu lieu.

Représentation JSON 
{
  "expandedQuery": boolean,
  "pinnedResultCount": string
}
Champs
expandedQuery

boolean

Booléen indiquant si l'extension de la requête a eu lieu.
pinnedResultCount

string (int64 format)

Nombre de résultats épinglés. Ce champ n'est défini que lorsque l'expansion a lieu et que SearchRequest.QueryExpansionSpec.pin_unexpanded_results est défini sur "true".

NaturalLanguageQueryUnderstandingInfo

Informations décrivant la compréhension du langage naturel effectuée sur la requête saisie.

Représentation JSON 
{
  "extractedFilters": string,
  "rewrittenQuery": string,
  "classifiedIntents": [
    string
  ],
  "structuredExtractedFilter": {
    object (StructuredExtractedFilter)
  }
}
Champs
extractedFilters

string

Filtres extraits de la requête d'entrée.
rewrittenQuery

string

Requête d'entrée réécrite sans les filtres extraits.
classifiedIntents[]

string

Intents classifiés à partir de la requête saisie.
structuredExtractedFilter

object (StructuredExtractedFilter)

Filtres extraits de la requête d'entrée, représentés sous forme structurée.

StructuredExtractedFilter

Filtres extraits de la requête d'entrée, représentés sous forme structurée.

Représentation JSON 
{
  "expression": {
    object (Expression)
  }
}
Champs
expression

object (Expression)

Expression désignant le filtre extrait de la requête d'entrée sous une forme structurée. Il peut s'agir d'une expression simple désignant une seule contrainte de chaîne, numérique ou de géolocalisation, ou d'une expression composée qui est une combinaison de plusieurs expressions connectées à l'aide d'opérateurs logiques (OR et AND).

Expression

Expression désignant le filtre extrait de la requête d'entrée.

Représentation 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.
}
Champs
Champ d'union expr. Type d'expression. expr ne peut être qu'un des éléments suivants :
stringConstraint

object (StringConstraint)

Expression de contrainte de chaîne.
numberConstraint

object (NumberConstraint)

Expression de contrainte numérique.
geolocationConstraint

object (GeolocationConstraint)

Expression de contrainte de géolocalisation.
andExpr

object (AndExpression)

Opérateur composé logique "And" reliant plusieurs expressions.
orExpr

object (OrExpression)

Opérateur composé "Or" logique reliant plusieurs expressions.

StringConstraint

Expression de contrainte d'un champ de chaîne.

Représentation JSON 
{
  "fieldName": string,
  "values": [
    string
  ],
  "querySegment": string
}
Champs
fieldName

string

Nom du champ de chaîne tel qu'il est défini dans le schéma.
values[]

string

Valeurs du champ de chaîne. L'enregistrement ne sera renvoyé que si la valeur du champ correspond à l'une des valeurs spécifiées ici.
querySegment

string

Identifie les mots clés de la requête de recherche qui correspondent à un filtre.

NumberConstraint

Expression de contrainte d'un champ numérique. Exemple : prix < 100.

Représentation JSON 
{
  "fieldName": string,
  "comparison": enum (Comparison),
  "value": number,
  "querySegment": string
}
Champs
fieldName

string

Nom du champ numérique tel qu'il est défini dans le schéma.
comparison

enum (Comparison)

Opération de comparaison effectuée entre la valeur du champ et celle spécifiée dans la contrainte.
value

number

Valeur spécifiée dans la contrainte numérique.
querySegment

string

Identifie les mots clés de la requête de recherche qui correspondent à un filtre.

Comparaison

Opération de comparaison effectuée.

Enums
COMPARISON_UNSPECIFIED Opérateur de comparaison non défini.
EQUALS Indique l'opérateur d'égalité =.
LESS_THAN_EQUALS Indique l'opérateur inférieur ou égal à <=.
LESS_THAN Indique l'opérateur "inférieur à" <.
GREATER_THAN_EQUALS Indique l'opérateur supérieur ou égal à >=.
GREATER_THAN Désigne l'opérateur supérieur à >.

GeolocationConstraint

Contrainte d'un champ de géolocalisation. Nom du champ de géolocalisation tel qu'il est défini dans le schéma.

Représentation JSON 
{
  "fieldName": string,
  "address": string,
  "latitude": number,
  "longitude": number,
  "radiusInMeters": number
}
Champs
fieldName

string

Nom du champ de géolocalisation tel qu'il est défini dans le schéma.
address

string

Adresse de référence déduite de la requête saisie. La proximité de l'adresse de référence par rapport au champ de géolocalisation sera utilisée pour filtrer les résultats.
latitude

number

Latitude de la géolocalisation déduite de la requête saisie.
longitude

number

Longitude de la géolocalisation déduite de la requête saisie.
radiusInMeters

number

Rayon en mètres autour de l'adresse. L'enregistrement est renvoyé si la position du champ de géolocalisation se trouve dans le rayon.

AndExpression

Opérateur logique And.

Représentation JSON 
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
Champs
expressions[]

object (Expression)

Expressions combinées avec un opérateur AND.

OrExpression

Opérateur logique Or.

Représentation JSON 
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
Champs
expressions[]

object (Expression)

Expressions combinées avec un opérateur OR.

SessionInfo

Informations sur la session.

Représentation JSON 
{
  "name": string,
  "queryId": string
}
Champs
name

string

Nom de la session. Si le mode de session automatique est utilisé (lorsque SearchRequest.session se termine par "-"), ce champ contient le nom de session nouvellement généré.
queryId

string

ID de requête correspondant à cet appel de l'API Search. Une session peut comporter plusieurs tours, chacun avec un ID de requête unique.

En spécifiant le nom de la session et cet ID de requête dans l'appel de l'API Answer, la réponse est générée dans le contexte des résultats de recherche de cet appel de recherche.

OneBoxResult

OneBoxResult est un conteneur pour tous les résultats d'un type spécifique que nous souhaitons afficher différemment dans l'UI.

Représentation JSON 
{
  "oneBoxType": enum (OneBoxType),
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Champs
oneBoxType

enum (OneBoxType)

Type de résultat OneBox.
searchResults[]

object (SearchResult)

Résultats de recherche pour cette OneBox.

OneBoxType

Type de résultat OneBox.

Enums
ONE_BOX_TYPE_UNSPECIFIED Valeur par défaut. Ne doit pas être utilisé.
PEOPLE Un encadré de résultats contient des résultats de personnes.
ORGANIZATION Un encadré de résultats contient les résultats de l'organisation.
SLACK Un résultat de boîte contient des résultats Slack.
KNOWLEDGE_GRAPH Un résultat OneBox contient des réponses de recherche Knowledge Graph.