SearchResponse

Antwortnachricht für die Methode SearchService.Search.

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

object (SearchResult)

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

object (Facet)

Ergebnisse der vom Nutzer angeforderten Facetten.
guidedSearchResult

object (GuidedSearchResult)

Suchergebnis mit Anleitung.
totalSize

integer

Die geschätzte Gesamtzahl übereinstimmender Elemente unabhängig von der Paginierung. Die Anzahl der von der Paginierung zurückgegebenen results kann geringer sein als die Anzahl der übereinstimmenden totalSize.
attributionToken

string

Ein eindeutiges Suchtoken. Es sollte in den UserEvent-Logs enthalten sein, die aus dieser Suche resultieren, was eine genaue Attribution der Leistung des Suchmodells ermöglicht. So kann eine Anfrage auch in Kundensupportszenarien leichter identifiziert werden.
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. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.
correctedQuery

string

Enthält die korrigierte Abfrage, falls sie gefunden wurde. Wenn der Typ der Rechtschreibkorrektur AUTOMATIC ist, basieren die Suchergebnisse auf „correctedQuery“. Andernfalls wird die ursprüngliche Anfrage für die Suche verwendet.
suggestedQuery

string

Korrigierte Anfrage mit niedrigem Konfidenzwert, auch „Meintest du“-Anfrage genannt. Im Vergleich zu „correctedQuery“ wird dieses Feld festgelegt, wenn SpellCorrector eine Antwort zurückgegeben hat, FPR(full page replacement) jedoch nicht ausgelöst wird, weil die Korrektur eine geringe Wahrscheinlichkeit hat(z. B. umgekehrt, weil es Übereinstimmungen der ursprünglichen Anfrage im Dokumentkorpus gibt).
summary

object (Summary)

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

string

Kontrollen, die im Rahmen des Control-Dienstes angewendet werden.
geoSearchDebugInfo[]

object (GeoSearchDebugInfo)
queryExpansionInfo

object (QueryExpansionInfo)

Informationen zur Abfrageerweiterung für die zurückgegebenen Ergebnisse.
naturalLanguageQueryUnderstandingInfo

object (NaturalLanguageQueryUnderstandingInfo)

Informationen zur Interpretation von Anfragen in natürlicher Sprache 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.
oneBoxResults[]

object (OneBoxResult)

Eine Liste mit One-Box-Ergebnissen. Es kann mehrere One-Box-Ergebnisse unterschiedlicher Typen geben.

Facette

Ein Attributergebnis.

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

string

Der Schlüssel für dieses Attribut. Beispiel: "colors" oder "price". Es entspricht SearchRequest.FacetSpec.FacetKey.key.
values[]

object (FacetValue)

Die Attributwerte 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. „Schwarz“ für die Facette „Farben“.
interval

object (Interval)

Intervallwert für ein Facet, z. B. [10, 20) für das Facet „price“. Es entspricht SearchRequest.FacetSpec.FacetKey.intervals.

GuidedSearchResult

Suchergebnis mit Anleitung. Die geführte Suche hilft Nutzern, die Suchergebnisse einzugrenzen und aus einer breiten Auswahl an Suchergebnissen die für sie relevanten zu finden.

JSON-Darstellung 
{
  "refinementAttributes": [
    {
      object (RefinementAttribute)
    }
  ],
  "followUpQuestions": [
    string
  ]
}
Felder
refinementAttributes[]

object (RefinementAttribute)

Eine Liste der nach Rang geordneten Attributen für die Verfeinerung.
followUpQuestions[]

string

Vorgeschlagene Folgefragen

RefinementAttribute

Nützliches Attribut für die Verfeinerung von Suchergebnissen.

JSON-Darstellung 
{
  "attributeKey": string,
  "attributeValue": string
}
Felder
attributeKey

string

Attributschlüssel, der zum Eingrenzen der Ergebnisse verwendet wird. Beispiel: "movie_type".
attributeValue

string

Attributwert, mit dem die Ergebnisse eingegrenzt werden. Beispiel: "drama".

GeoSearchDebugInfo

Debug-Informationen speziell zu Problemen mit dem Forward Geocoding, die durch die Geolokationssuche entstehen.

JSON-Darstellung 
{
  "originalAddressQuery": string,
  "errorMessage": string
}
Felder
originalAddressQuery

string

Die Adresse, bei der beim Forward Geocoding Probleme aufgetreten sind.
errorMessage

string

Der aufgetretene Fehler.

QueryExpansionInfo

Informationen zur Suchanfragenerweiterung, einschließlich der Angabe, ob eine Erweiterung stattgefunden hat.

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

boolean

Boolescher Wert, der angibt, ob die Suchanfrage erweitert wurde.
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.

NaturalLanguageQueryUnderstandingInfo

Informationen dazu, welche Verarbeitung in natürlicher Sprache für die Eingabeabfrage durchgeführt wurde.

JSON-Darstellung 
{
  "extractedFilters": string,
  "rewrittenQuery": string,
  "classifiedIntents": [
    string
  ],
  "structuredExtractedFilter": {
    object (StructuredExtractedFilter)
  }
}
Felder
extractedFilters

string

Die Filter, die aus der Eingabeabfrage extrahiert wurden.
rewrittenQuery

string

Die neu formulierte Eingabeabfrage ohne die extrahierten Filter.
classifiedIntents[]

string

Die klassifizierten Intentionen aus der Eingabeanfrage.
structuredExtractedFilter

object (StructuredExtractedFilter)

Die Filter, die aus der Eingabeabfrage extrahiert wurden, in strukturierter Form.

StructuredExtractedFilter

Die Filter, die aus der Eingabeabfrage extrahiert wurden, in strukturierter Form.

JSON-Darstellung 
{
  "expression": {
    object (Expression)
  }
}
Felder
expression

object (Expression)

Der Ausdruck, der den Filter angibt, der in strukturierter Form aus der Eingabeabfrage extrahiert wurde. Es kann sich um einen einfachen Ausdruck handeln, der eine einzelne String-, numerische oder geografische Einschränkung angibt, oder um einen zusammengesetzten Ausdruck, der eine Kombination aus mehreren Ausdrücken ist, die mit logischen Operatoren (OR und AND) verbunden sind.

Ausdruck

Der Ausdruck, der den aus der Eingabeabfrage extrahierten Filter angibt.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld expr. Der Ausdruckstyp. Für expr ist nur einer der folgenden Werte zulässig:
stringConstraint

object (StringConstraint)

Ausdruck für die String-Einschränkung.
numberConstraint

object (NumberConstraint)

Numerischer Einschränkungsausdruck.
geolocationConstraint

object (GeolocationConstraint)

Ausdruck für die Einschränkung der geografischen Position.
andExpr

object (AndExpression)

Logischer zusammengesetzter „And“-Operator, der mehrere Ausdrücke verbindet.
orExpr

object (OrExpression)

Logischer „Oder“-Operator, der mehrere Ausdrücke verbindet.

StringConstraint

Einschränkungsausdruck eines Stringfelds.

JSON-Darstellung 
{
  "fieldName": string,
  "values": [
    string
  ],
  "querySegment": string
}
Felder
fieldName

string

Name des Stringfelds, wie im Schema definiert.
values[]

string

Werte des Stringfelds. Der Datensatz wird nur zurückgegeben, wenn der Feldwert mit einem der hier angegebenen Werte übereinstimmt.
querySegment

string

Gibt die Keywords in der Suchanfrage an, die mit einem Filter übereinstimmen.

NumberConstraint

Einschränkungsausdruck eines Zahlenfelds. Beispiel: price < 100.

JSON-Darstellung 
{
  "fieldName": string,
  "comparison": enum (Comparison),
  "value": number,
  "querySegment": string
}
Felder
fieldName

string

Name des numerischen Felds, wie im Schema definiert.
comparison

enum (Comparison)

Der Vergleichsvorgang, der zwischen dem Feldwert und dem im Constraint angegebenen Wert ausgeführt wird.
value

number

Der im numerischen Constraint angegebene Wert.
querySegment

string

Gibt die Keywords in der Suchanfrage an, die mit einem Filter übereinstimmen.

Vergleich

Der durchgeführte Vergleichsvorgang.

Enums
COMPARISON_UNSPECIFIED Vergleichsoperator nicht definiert.
EQUALS Gleichheitsoperator =.
LESS_THAN_EQUALS Gibt den Operator „kleiner als oder gleich“ (<=) an.
LESS_THAN Gibt an, dass der Wert kleiner als < ist.
GREATER_THAN_EQUALS Gibt den Operator „größer als oder gleich“ (>=) an.
GREATER_THAN Gibt den Operator „größer als“ (>) an.

GeolocationConstraint

Einschränkung eines Geolocation-Felds. Name des Geolocation-Felds, wie im Schema definiert.

JSON-Darstellung 
{
  "fieldName": string,
  "address": string,
  "latitude": number,
  "longitude": number,
  "radiusInMeters": number
}
Felder
fieldName

string

Der Name des Standortfelds, wie im Schema definiert.
address

string

Die Referenzadresse, die aus der Eingabeanfrage abgeleitet wurde. Die Nähe der Referenzadresse zum Geolocation-Feld wird verwendet, um die Ergebnisse zu filtern.
latitude

number

Der Breitengrad der Geolokalisierung, die aus der Eingabeanfrage abgeleitet wurde.
longitude

number

Der Längengrad der aus der Eingabeanfrage abgeleiteten geografischen Position.
radiusInMeters

number

Der Radius in Metern um die Adresse. Der Datensatz wird zurückgegeben, wenn sich der Standort des Geolocation-Felds innerhalb des Radius befindet.

AndExpression

Logischer And-Operator.

JSON-Darstellung 
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
Felder
expressions[]

object (Expression)

Die Ausdrücke, die mit AND verknüpft wurden.

OrExpression

Logischer Or-Operator.

JSON-Darstellung 
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
Felder
expressions[]

object (Expression)

Die Ausdrücke, die mit OR verknüpft wurden.

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 mit „-“ endet), enthält dieses Feld den neu generierten Sitzungsnamen.
queryId

string

Die Abfrage-ID, die diesem Search API-Aufruf entspricht. Eine Sitzung kann mehrere Turns mit jeweils einer eindeutigen Abfrage-ID haben.

Wenn Sie den Sitzungsnamen und diese Anfrage-ID im Answer API-Aufruf angeben, erfolgt die Antwortgenerierung im Kontext der Suchergebnisse aus diesem Suchaufruf.

OneBoxResult

OneBoxResult ist ein Container für alle Ergebnisse eines bestimmten Typs, die wir in der Benutzeroberfläche unterschiedlich darstellen möchten.

JSON-Darstellung 
{
  "oneBoxType": enum (OneBoxType),
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Felder
oneBoxType

enum (OneBoxType)

Der Typ des One-Box-Ergebnisses.
searchResults[]

object (SearchResult)

Die Suchergebnisse für dieses One-Box-Ergebnis.

OneBoxType

Der Typ des One-Box-Ergebnisses.

Enums
ONE_BOX_TYPE_UNSPECIFIED Standardwert. Sollte nicht verwendet werden.
PEOPLE Ein Feld enthält Ergebnisse für Personensuche.
ORGANIZATION Ein Feld enthält Organisationsergebnisse.
SLACK Ein Feld enthält Slack-Ergebnisse.
KNOWLEDGE_GRAPH Ein OneBox-Ergebnis enthält Knowledge Graph-Suchantworten.