SearchResponse

Antwortnachricht für die Methode SearchService.Search.

JSON-Darstellung
{
  "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)
    }
  ]
}
Felder
results[]

object (SearchResult)

Eine Liste der übereinstimmenden Dokumente. Die Reihenfolge entspricht dem Ranking.

facets[]

object (Facet)

Ergebnisse der vom Nutzer angeforderten Facetten

totalSize

integer

Die geschätzte Gesamtanzahl übereinstimmender Elemente unabhängig von der Paginierung. Die Anzahl der von der Paginierung zurückgegebenen results kann geringer sein als die totalSize der Übereinstimmungen.

attributionToken

string

Ein eindeutiges Suchtoken. Es sollte in den UserEvent-Logs enthalten sein, die für diese Suche generiert werden. Damit lässt sich die Leistung des Suchmodells genau zuordnen. Außerdem kann eine Anfrage so leichter identifiziert werden, wenn Kunden Support benötigen.

redirectUri

string

Der URI einer vom Kunden definierten Weiterleitungsseite. Wenn eine Weiterleitungsaktion ausgelöst wird, wird keine Suche durchgeführt und in der Antwort werden nur redirectUri und attributionToken festgelegt.

nextPageToken

string

Ein Token, das als SearchRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wird dieses Feld weggelassen, gibt es keine nachfolgenden Seiten.

correctedQuery

string

Enthält die rechtschreibkorrigierte Anfrage, sofern gefunden. Wenn der Typ der Rechtschreibkorrektur AUTOMATIC lautet, basieren die Suchergebnisse auf der „correctedQuery“. Andernfalls wird die ursprüngliche Anfrage für die Suche verwendet.

summary

object (Summary)

Eine Zusammenfassung als Teil der Suchergebnisse. Dieses Feld wird nur zurückgegeben, wenn SearchRequest.ContentSearchSpec.summary_spec festgelegt ist.

queryExpansionInfo

object (QueryExpansionInfo)

Informationen zur Suchanfragenerweiterung für die zurückgegebenen Ergebnisse

sessionInfo

object (SessionInfo)

Informationen zur Sitzung

Wird nur festgelegt, wenn SearchRequest.session angegeben ist. Weitere Informationen finden Sie in der Beschreibung.

Facet

Ein Facettenergebnis

JSON-Darstellung
{
  "key": string,
  "values": [
    {
      object (FacetValue)
    }
  ],
  "dynamicFacet": boolean
}
Felder
key

string

Der Schlüssel für diese Facette. Beispiel: "colors" oder "price". Entspricht SearchRequest.FacetSpec.FacetKey.key.

values[]

object (FacetValue)

Die Facettenwerte für dieses Feld

dynamicFacet

boolean

Gibt an, ob die Facette dynamisch generiert wird

FacetValue

Ein Facettenwert, der Wertnamen und deren Anzahl enthält

JSON-Darstellung
{
  "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.
}
Felder
count

string (int64 format)

Anzahl der Elemente mit diesem Facettenwert

Union-Feld facet_value. Ein Facettenwert, der Werte enthält. Für facet_value ist nur einer der folgenden Werte zulässig:
value

string

Textwert einer Facette, z. B. „black“ für die Facette „colors“

interval

object (Interval)

Intervallwert für eine Facette, z. B. [10, 20] für die Facette „price“. Entspricht SearchRequest.FacetSpec.FacetKey.intervals.

QueryExpansionInfo

Informationen zur Suchanfragenerweiterung, einschließlich, ob eine Erweiterung erfolgt ist

JSON-Darstellung
{
  "expandedQuery": boolean,
  "pinnedResultCount": string
}
Felder
expandedQuery

boolean

Boolescher Wert, der angibt, ob eine Suchanfragenerweiterung erfolgt ist

pinnedResultCount

string (int64 format)

Anzahl der angepinnten Ergebnisse. Dieses Feld wird nur festgelegt, wenn eine Erweiterung erfolgt und SearchRequest.QueryExpansionSpec.pin_unexpanded_results auf „true“ gesetzt ist.

SessionInfo

Informationen zur Sitzung

JSON-Darstellung
{
  "name": string,
  "queryId": string
}
Felder
name

string

Name der Sitzung. Wenn der automatische Sitzungsmodus verwendet wird (wenn SearchRequest.session auf „-“ endet), enthält dieses Feld den neu generierten Sitzungsnamen.

queryId

string

Die Abfrage-ID für diesen Search API-Aufruf. Eine Sitzung kann aus mehrere Runden mit jeweils einer eindeutigen Abfrage-ID bestehen.

Wenn Sie den Sitzungsnamen und diese Abfrage-ID im Answer API-Aufruf angeben, erfolgt die Antwortgenerierung im Kontext der Suchergebnisse für diesen Suchaufruf.