SearchResponse

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

Représentation 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)
    }
  ]
}
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.
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.
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.
queryExpansionInfo

object (QueryExpansionInfo)

Informations sur l'expansion de la requête 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.

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.

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

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.