REST Resource: projects.locations.evaluations

Ressource: Evaluation

Eine Auswertung ist eine einzelne Ausführung (oder ein einzelner Lauf) eines Auswertungsprozesses. Es enthält den Status der Auswertung und die resultierenden Daten.

JSON-Darstellung 
{
  "name": string,
  "evaluationSpec": {
    object (EvaluationSpec)
  },
  "qualityMetrics": {
    object (QualityMetrics)
  },
  "state": enum (State),
  "error": {
    object (Status)
  },
  "createTime": string,
  "endTime": string,
  "errorSamples": [
    {
      object (Status)
    }
  ]
}
Felder
name

string

ID. Der vollständige Ressourcenname des Evaluation im Format projects/{project}/locations/{location}/evaluations/{evaluation}.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
evaluationSpec

object (EvaluationSpec)

Erforderlich. Die Spezifikation der Auswertung.
qualityMetrics

object (QualityMetrics)

Nur Ausgabe. Die von der Bewertung erstellten Messwerte, gemittelt über alle SampleQuery in der SampleQuerySet.

Wird nur ausgefüllt, wenn der Status der Auswertung „SUCCEEDED“ lautet.
state

enum (State)

Nur Ausgabe. Der Status der Bewertung.
error

object (Status)

Nur Ausgabe. Der Fehler, der bei der Auswertung aufgetreten ist. Wird nur ausgefüllt, wenn der Status der Auswertung „FAILED“ lautet.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung von Evaluation

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für den Abschluss von Evaluation.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
errorSamples[]

object (Status)

Nur Ausgabe. Ein Beispiel für Fehler, die bei der Verarbeitung der Anfrage aufgetreten sind.

EvaluationSpec

Beschreibt die Spezifikation der Auswertung.

JSON-Darstellung 
{
  "querySetSpec": {
    object (QuerySetSpec)
  },

  // Union field search_spec can be only one of the following:
  "searchRequest": {
    object (SearchRequest)
  }
  // End of list of possible types for union field search_spec.
}
Felder
querySetSpec

object (QuerySetSpec)

Optional. Die Spezifikation des Abfragesets.
Union-Feld search_spec. Die Suchspezifikation. Für search_spec ist nur einer der folgenden Werte zulässig:
searchRequest

object (SearchRequest)

Erforderlich. Die Suchanfrage, die für die Auswertung verwendet wird.

Nur die folgenden Felder in SearchRequest werden unterstützt. Wenn andere Felder angegeben werden, wird ein UNSUPPORTED-Fehler zurückgegeben:

ImageQuery

Gibt die Eingabe für die Bildanfrage an.

JSON-Darstellung 
{

  // Union field image can be only one of the following:
  "imageBytes": string
  // End of list of possible types for union field image.
}
Felder

Union-Feld image.

Für image ist nur einer der folgenden Werte zulässig:
imageBytes

string

Base64-codierte Bilddaten. Unterstützte Bildformate: JPEG, PNG und BMP.

FacetSpec

Eine Facettenspezifikation für die Attributsuche.

JSON-Darstellung 
{
  "facetKey": {
    object (FacetKey)
  },
  "limit": integer,
  "excludedFilterKeys": [
    string
  ],
  "enableDynamicPosition": boolean
}
Felder
facetKey

object (FacetKey)

Erforderlich. Die Facettenschlüsselspezifikation.
limit

integer

Maximale Anzahl von Attributwerten, die für dieses Attribut zurückgegeben werden. Wenn nichts anderes angegeben wird, wird der Wert standardmäßig auf 20 gesetzt. Der maximal zulässige Wert beträgt 300. Werte über 300 werden implizit auf 300 umgewandelt. Bei der Aggregation in der Suche nach Gesundheitsdaten wird das Limit intern auf 10.000 überschrieben, wenn [FacetKey.key] „healthcare_aggregation_key“ ist. Das gilt unabhängig vom hier festgelegten Wert.

Wenn dieses Feld negativ ist, wird ein INVALID_ARGUMENT zurückgegeben.
excludedFilterKeys[]

string

Liste der Schlüssel, die beim Facettieren ausgeschlossen werden sollen.

Standardmäßig wird FacetKey.key nicht aus dem Filter ausgeschlossen, sofern es nicht in diesem Feld aufgeführt ist.

Wenn Sie einen Attributschlüssel in diesem Feld angeben, können seine Werte als Attributergebnisse angezeigt werden, auch wenn sie aus den Suchergebnissen herausgefiltert werden. Die Verwendung dieses Felds hat keinen Einfluss darauf, welche Suchergebnisse zurückgegeben werden.

Angenommen, es gibt 100 Dokumente mit der Facette „Farbe“ – „Rot“ und 200 Dokumente mit der Facette „Farbe“ – „Blau“. Bei einer Abfrage mit dem Filter „color:ANY(“Red”)“ und „color“ als FacetKey.key werden in den Suchergebnissen standardmäßig nur Dokumente mit der Farbe „Rot“ zurückgegeben. Außerdem wird „Rot“ mit der Anzahl 100 als einzige Farb-Facette zurückgegeben. Obwohl auch blaue Dokumente verfügbar sind, wird „Blau“ nicht als verfügbarer Facettenwert angezeigt.

Wenn „color“ in „excludedFilterKeys“ aufgeführt ist, gibt die Abfrage die Facettenwerte „Red“ mit dem Zähler 100 und „Blue“ mit dem Zähler 200 zurück, da der Schlüssel „color“ jetzt aus dem Filter ausgeschlossen ist. Da sich dieses Feld nicht auf die Suchergebnisse auswirkt, werden die Suchergebnisse weiterhin korrekt gefiltert, sodass nur Dokumente mit der Farbe „Rot“ zurückgegeben werden.

Es sind maximal 100 Werte zulässig. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
enableDynamicPosition

boolean

Aktiviert die dynamische Position für diese Facette. Wenn diese Option auf „true“ gesetzt ist, wird die Position dieser Facette unter allen Facetten in der Antwort automatisch bestimmt. Wenn dynamische Attribute aktiviert sind, wird die Bestellung zusammen ausgeführt. Wenn der Wert auf „false“ gesetzt ist, ist die Position dieses Attributs in der Antwort dieselbe wie in der Anfrage. Es wird vor den Attributen mit aktivierter dynamischer Position und allen dynamischen Attributen eingestuft.

Sie möchten beispielsweise immer, dass die Facette „Bewertung“ in der Antwort zurückgegeben wird, aber nicht unbedingt immer oben angezeigt wird. In diesem Fall können Sie „enableDynamicPosition“ auf „true“ setzen, damit die Position der Bewertungsfacette in der Antwort automatisch bestimmt wird.

Ein weiteres Beispiel: Angenommen, Sie haben die folgenden Facetten in der Anfrage:

  • „rating“, enableDynamicPosition = true

  • „price“, enableDynamicPosition = false

  • „brands“, enableDynamicPosition = false

Außerdem haben Sie dynamische Facetten aktiviert, wodurch die Facette gender generiert wird. Die endgültige Reihenfolge der Facetten in der Antwort kann dann („price“, „brands“, „rating“, „gender“) oder („price“, „brands“, „gender“, „rating“) sein, je nachdem, wie die API die Facetten „gender“ und „rating“ sortiert. „price“ und „brands“ werden jedoch immer an erster und zweiter Stelle platziert, da für sie „enableDynamicPosition“ auf „false“ gesetzt ist.

FacetKey

Gibt an, wie eine Facette berechnet wird.

JSON-Darstellung 
{
  "key": string,
  "intervals": [
    {
      object (Interval)
    }
  ],
  "restrictedValues": [
    string
  ],
  "prefixes": [
    string
  ],
  "contains": [
    string
  ],
  "caseInsensitive": boolean,
  "orderBy": string
}
Felder
key

string

Erforderlich. Unterstützte Text- und numerische Attributschlüssel im Document-Objekt, für die die Attributwerte berechnet werden. Bei Facettenschlüsseln wird zwischen Groß- und Kleinschreibung unterschieden.
intervals[]

object (Interval)

Nur festlegen, wenn Werte in Intervalle unterteilt werden sollen. Muss für Facetten mit numerischen Werten festgelegt werden. Darf nicht für Facette mit Textwerten festgelegt werden. Die maximale Anzahl von Intervallen beträgt 30.
restrictedValues[]

string

Nur Facette für die angegebenen eingeschränkten Werte abrufen. Wird nur für Textfelder unterstützt. Angenommen, „category“ hat die drei Werte „Action > 2022“, „Action > 2021“ und „Sci-Fi > 2022“. Wenn Sie „restrictedValues“ auf „Action > 2022“ festlegen, enthält die Facette „category“ nur „Action > 2022“. Wird nur für Textfelder unterstützt. Der Maximalwert beträgt 10.
prefixes[]

string

Nur Facettenwerte abrufen, die mit dem angegebenen Stringpräfix beginnen. Angenommen, „category“ hat die drei Werte „Action > 2022“, „Action > 2021“ und „Sci-Fi > 2022“. Wenn Sie „prefixes“ auf „Action“ festlegen, enthält die Dimension „category“ nur „Action > 2022“ und „Action > 2021“. Wird nur für Textfelder unterstützt. Der Maximalwert beträgt 10.
contains[]

string

Nur Facettenwerte abrufen, die die angegebenen Strings enthalten. Angenommen, „category“ hat die drei Werte „Action > 2022“, „Action > 2021“ und „Sci-Fi > 2022“. Wenn Sie „contains“ auf „2022“ festlegen, enthält die Facette „category“ nur „Action > 2022“ und „Sci-Fi > 2022“. Wird nur für Textfelder unterstützt. Der Maximalwert beträgt 10.
caseInsensitive

boolean

„True“, damit bei der Suche nach Facettierungswerten mit Präfixen oder „contains“ die Groß-/Kleinschreibung für Facettenschlüssel nicht berücksichtigt wird. Andernfalls „false“.
orderBy

string

Die Reihenfolge, in der Dokumente zurückgegeben werden.

Zulässige Werte sind:

Wenn nicht festgelegt, werden Textwerte in natürlicher Reihenfolge sortiert. Numerische Intervalle werden in der durch FacetSpec.FacetKey.intervals angegebenen Reihenfolge sortiert.

Intervall

Ein Gleitkomma-Intervall.

JSON-Darstellung 
{

  // Union field min can be only one of the following:
  "minimum": number,
  "exclusiveMinimum": number
  // End of list of possible types for union field min.

  // Union field max can be only one of the following:
  "maximum": number,
  "exclusiveMaximum": number
  // End of list of possible types for union field max.
}
Felder

Union-Feld min. Die Untergrenze des Intervalls. Wenn keines der „min“-Felder festgelegt ist, ist die Untergrenze negativ unendlich.

Dieses Feld darf nicht größer als „max“ sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben. Für min ist nur einer der folgenden Werte zulässig:
minimum

number

Inklusive Untergrenze.
exclusiveMinimum

number

Exklusive Untergrenze.

Union-Feld max. Die Obergrenze des Intervalls. Wenn keines der Felder für das Maximum festgelegt ist, ist die Obergrenze positiv unendlich.

Der Wert in diesem Feld darf nicht kleiner als „min“ sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben. Für max ist nur einer der folgenden Werte zulässig:
maximum

number

Inklusive Obergrenze.
exclusiveMaximum

number

Exklusive Obergrenze.

QueryExpansionSpec

Spezifikation, um festzulegen, unter welchen Bedingungen die Suchanfragenerweiterung erfolgen soll.

JSON-Darstellung 
{
  "condition": enum (Condition),
  "pinUnexpandedResults": boolean
}
Felder
condition

enum (Condition)

Die Bedingung, unter der die Suchanfragenerweiterung erfolgen soll. Standardeinstellung ist Condition.DISABLED.
pinUnexpandedResults

boolean

Gibt an, ob nicht erweiterte Ergebnisse angepinnt werden sollen. Wenn dieses Feld auf „true“ gesetzt ist, werden nicht erweiterte Produkte immer oben in den Suchergebnissen angezeigt, gefolgt von den erweiterten Ergebnissen.

Bedingung

Enum, das beschreibt, unter welcher Bedingung die Suchanfragenerweiterung erfolgen soll

Enums
CONDITION_UNSPECIFIED Nicht angegebene Bedingung für die Suchanfragenerweiterung. In diesem Fall ist das Serververhalten standardmäßig Condition.DISABLED.
DISABLED Suchanfragenerweiterung deaktiviert. Es wird nur die genaue Suchanfrage verwendet, selbst wenn SearchResponse.total_size null ist.
AUTO Automatische Suchanfragenerweiterung, die von der Search API erstellt wird.

SpellCorrectionSpec

Die Spezifikation für die Rechtschreibkorrektur von Anfragen.

JSON-Darstellung 
{
  "mode": enum (Mode)
}
Felder
mode

enum (Mode)

Der Modus, in dem die Rechtschreibkorrektur die ursprüngliche Suchanfrage ersetzt. Die Standardeinstellung ist Mode.AUTO.

Modus

Enum, das beschreibt, in welchem Modus die Rechtschreibkorrektur erfolgen soll.

Enums
MODE_UNSPECIFIED Nicht angegebener Modus für die Rechtschreibkorrektur. In diesem Fall ist das Serververhalten standardmäßig Mode.AUTO.
SUGGESTION_ONLY Die Search API versucht, einen Rechtschreibvorschlag zu finden. Wenn ein Vorschlag gefunden wird, wird er in SearchResponse.corrected_query eingefügt. Der Rechtschreibvorschlag wird nicht als Suchanfrage verwendet.
AUTO Automatische Rechtschreibkorrektur durch die Search API. Die Suche basiert auf der korrigierten Anfrage, sofern eine solche gefunden wird.

EmbeddingSpec

Die Spezifikation, die einen benutzerdefinierten Vektor für die Abfrageeinbettung verwendet, um semantische Dokumente abzurufen.

JSON-Darstellung 
{
  "embeddingVectors": [
    {
      object (EmbeddingVector)
    }
  ]
}
Felder
embeddingVectors[]

object (EmbeddingVector)

Der für den Abruf verwendete Einbettungsvektor. Auf 1 begrenzen.

EmbeddingVector

Einbettungsvektor.

JSON-Darstellung 
{
  "fieldPath": string,
  "vector": [
    number
  ]
}
Felder
fieldPath

string

Einbettungsfeldpfad im Schema.
vector[]

number

Vektor zum Einbetten von Abfragen.

RankingExpressionBackend

Das Backend, das für die Auswertung des Rankingausdrucks verwendet werden soll

Enums
RANKING_EXPRESSION_BACKEND_UNSPECIFIED Standardoption für nicht angegebene / unbekannte Werte
BYOE

Nicht mehr unterstützt: Verwenden Sie stattdessen RANK_BY_EMBEDDING. Ranking nach benutzerdefiniertem Einbettungsmodell, die Standardmethode zur Bewertung des Rankingausdrucks. Stattdessen sollte die Legacy-Enum-Option RANK_BY_EMBEDDING verwendet werden.
CLEARBOX

Nicht mehr unterstützt: Verwenden Sie stattdessen RANK_BY_FORMULA. Ranking nach benutzerdefinierter Formel. Stattdessen sollte die Legacy-Enum-Option RANK_BY_FORMULA verwendet werden.
RANK_BY_EMBEDDING Ranking nach benutzerdefiniertem Einbettungsmodell, die Standardmethode zur Bewertung des Rankingausdrucks
RANK_BY_FORMULA Ranking nach benutzerdefinierter Formel

NaturalLanguageQueryUnderstandingSpec

Spezifikation zur Aktivierung von Funktionen zum Verarbeiten natürlicher Sprache für Suchanfragen

JSON-Darstellung 
{
  "filterExtractionCondition": enum (FilterExtractionCondition),
  "geoSearchQueryDetectionFieldNames": [
    string
  ],
  "extractedFilterBehavior": enum (ExtractedFilterBehavior),
  "allowedFieldNames": [
    string
  ]
}
Felder
filterExtractionCondition

enum (FilterExtractionCondition)

Die Bedingung, unter der die Filterextraktion erfolgen soll. Das Serververhalten ist standardmäßig DISABLED.
geoSearchQueryDetectionFieldNames[]

string

Feldnamen, die für die standortbasierte Filterung verwendet werden, wenn Geolocation-Filter in Suchanfragen in natürlicher Sprache erkannt werden. Nur gültig, wenn „FilterExtractionCondition“ auf ENABLED festgelegt ist.

Wenn dieses Feld festgelegt ist, werden die in ServingConfig.geo_search_query_detection_field_names festgelegten Feldnamen überschrieben.
extractedFilterBehavior

enum (ExtractedFilterBehavior)

Optional. Steuert, wie extrahierte Filter auf die Suche angewendet werden. Das Standardverhalten hängt von der Anfrage ab. Bei der strukturierten Suche in einem einzelnen Datenspeicher ist HARD_FILTER die Standardeinstellung. Bei der Suche in mehreren Datenspeichern ist das Standardverhalten SOFT_BOOST. Standortbasierte Filter werden immer als Hard-Filter angewendet und die Einstellung SOFT_BOOST hat keine Auswirkungen auf sie. Dieses Feld wird nur verwendet, wenn [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] auf FilterExtractionCondition.ENABLED festgelegt ist.
allowedFieldNames[]

string

Optional. Zulassungsliste der Felder, die für die Extraktion von Filtern in natürlicher Sprache verwendet werden können. Wenn nichts angegeben ist, kommen standardmäßig alle indexierbaren Felder für die Extraktion von Filtern in natürlicher Sprache infrage (die Verwendung ist jedoch nicht garantiert). Wenn Felder in „allowedFieldNames“ angegeben sind, kommen nur die Felder für die Extraktion von Filtern in natürlicher Sprache infrage, die sowohl im Schema als indexierbar gekennzeichnet als auch in der Zulassungsliste angegeben sind. Hinweis: Bei der Suche in mehreren Datenspeichern wird dies noch nicht unterstützt und ignoriert.

FilterExtractionCondition

Enum, das beschreibt, unter welcher Bedingung die Filterextraktion erfolgen soll.

Enums
CONDITION_UNSPECIFIED Das Serververhalten ist standardmäßig DISABLED.
DISABLED Deaktiviert die Extraktion von Filtern in natürlicher Sprache.
ENABLED Ermöglicht das Extrahieren von Filtern für natürliche Sprache.

ExtractedFilterBehavior

Aufzählung, die beschreibt, wie extrahierte Filter auf die Suche angewendet werden.

Enums
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED verwendet das Standardverhalten für extrahierte Filter. Bei der Suche in einem einzelnen Datenspeicher werden sie standardmäßig als Hard-Filter angewendet. Bei der Suche in mehreren Datenspeichern werden sie standardmäßig als Soft Boosts angewendet.
HARD_FILTER Wendet alle extrahierten Filter als feste Filter auf die Ergebnisse an. Ergebnisse, die die extrahierten Filter nicht bestehen, werden nicht in der Ergebnismenge zurückgegeben.
SOFT_BOOST Wendet alle extrahierten Filter als Soft Boosts an. Ergebnisse, die die Filter bestehen, werden im Ergebnissatz auf höhere Ränge verschoben.

SearchAsYouTypeSpec

Spezifikation für die Suche während der Eingabe in Suchanfragen.

JSON-Darstellung 
{
  "condition": enum (Condition)
}
Felder
condition

enum (Condition)

Die Bedingung, unter der die Funktion „Während der Eingabe suchen“ ausgeführt werden soll. Standardeinstellung ist Condition.DISABLED.

Bedingung

Enum, das beschreibt, unter welcher Bedingung die automatische Vervollständigung der Suche erfolgen soll.

Enums
CONDITION_UNSPECIFIED Das Serververhalten ist standardmäßig Condition.DISABLED.
DISABLED Deaktiviert die Suche während der Eingabe.
ENABLED Aktiviert die Suche während der Eingabe.
AUTO Automatisches Umschalten zwischen der Suche während der Eingabe und dem Standardmodus, ideal für Implementierungen mit einer einzigen API (z.B. Debouncing).

DisplaySpec

Gibt Funktionen für die Anzeige an, z. B. das Hervorheben von Übereinstimmungen.

JSON-Darstellung 
{
  "matchHighlightingCondition": enum (MatchHighlightingCondition)
}
Felder
matchHighlightingCondition

enum (MatchHighlightingCondition)

Die Bedingung, unter der Übereinstimmungen hervorgehoben werden sollen.

MatchHighlightingCondition

Enum, das beschreibt, unter welcher Bedingung die Hervorhebung von Übereinstimmungen erfolgen soll.

Enums
MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED Das Serververhalten ist identisch mit MATCH_HIGHLIGHTING_DISABLED.
MATCH_HIGHLIGHTING_DISABLED Deaktiviert die Hervorhebung von Übereinstimmungen in allen Dokumenten.
MATCH_HIGHLIGHTING_ENABLED Aktiviert die Hervorhebung von Übereinstimmungen in allen Dokumenten.

CrowdingSpec

Spezifikation für die Überfüllung. Durch Crowding wird die Vielfalt der Suchergebnisse verbessert, indem die Anzahl der Ergebnisse mit demselben Feldwert begrenzt wird. Wenn beispielsweise das Farbfeld mit einem „maxCount“ von 3 und dem Modus „DROP_CROWDED_RESULTS“ überlaufen ist, werden auf allen Seiten maximal drei Ergebnisse mit derselben Farbe zurückgegeben.

JSON-Darstellung 
{
  "field": string,
  "maxCount": integer,
  "mode": enum (Mode)
}
Felder
field

string

Das Feld, das für die Überlappung verwendet werden soll. Dokumente können nach einem Feld im Document-Objekt sortiert werden. Beim Feld „Crowding“ wird zwischen Groß- und Kleinschreibung unterschieden.
maxCount

integer

Die maximale Anzahl der Dokumente, die pro Wert des Felds beibehalten werden sollen. Sobald es mindestens maxCount vorherige Ergebnisse gibt, die denselben Wert für das angegebene Feld enthalten (entsprechend der in orderBy angegebenen Reihenfolge), werden spätere Ergebnisse mit demselben Wert „verdrängt“. Wenn keine Angabe erfolgt, beträgt der Standardwert 1.
mode

enum (Mode)

Modus für Dokumente, die nicht mehr angezeigt werden.

Modus

Aufzählung, die den Modus für Dokumente beschreibt, die ausgeblendet werden. Sie können auf die späteren Seiten verschoben oder herabgestuft werden.

Enums
MODE_UNSPECIFIED Nicht angegebener Modus für die Dichte. In diesem Fall ist das Serververhalten standardmäßig Mode.DROP_CROWDED_RESULTS.
DROP_CROWDED_RESULTS Überlappende Ergebnisse entfernen
DEMOTE_CROWDED_RESULTS_TO_END Überfüllte Ergebnisse auf die späteren Seiten verschieben.

SessionSpec

Sitzungsspezifikation

Die Funktion für die Suche mit mehreren Anfragen befindet sich derzeit in der privaten GA-Phase. Verwenden Sie stattdessen die Version v1alpha oder v1beta, bevor wir diese Funktion allgemein verfügbar machen. Alternativ können Sie das Google-Supportteam bitten, Sie auf die Zulassungsliste zu setzen.

JSON-Darstellung 
{
  "queryId": string,
  "searchResultPersistenceCount": integer
}
Felder
queryId

string

Wenn festgelegt, wird das Suchergebnis im „Turn“ gespeichert, das durch diese Abfrage-ID angegeben wird.

Beispiel: Angenommen, die Sitzung sieht so aus: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" queryId: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" queryId: ".../questions/zzz" } } }

Der Nutzer kann die /search API mit einer Anfrage wie dieser aufrufen:

session: ".../sessions/xxx" sessionSpec { queryId: ".../questions/zzz" }

Anschließend speichert die API das Suchergebnis, das mit dem letzten Turn verknüpft ist. Das gespeicherte Suchergebnis kann von einem nachfolgenden /answer-API-Aufruf verwendet werden, wenn die Sitzungs-ID und die Abfrage-ID angegeben sind. Außerdem ist es möglich, /search und /answer parallel mit derselben Sitzungs-ID und Abfrage-ID aufzurufen.
searchResultPersistenceCount

integer

Die Anzahl der wichtigsten Suchergebnisse, die beibehalten werden sollen. Die gespeicherten Suchergebnisse können für den nachfolgenden /answer-API-Aufruf verwendet werden.

Dieses Feld ähnelt dem Feld summaryResultCount in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.

Maximal 10 Ergebnisse im Dokumentmodus oder 50 Ergebnisse im Chunks-Modus.

RelevanceThreshold

Der Relevanzschwellenwert der Suchergebnisse Je höher der Relevanzschwellenwert, desto relevanter sind die angezeigten Ergebnisse und desto weniger Ergebnisse werden zurückgegeben.

Enums
RELEVANCE_THRESHOLD_UNSPECIFIED Standardwert. In diesem Fall ist das Serververhalten standardmäßig der von Google definierte Schwellenwert.
LOWEST Niedrigster Relevanzschwellenwert.
LOW Niedriger Relevanzschwellenwert
MEDIUM Mittlerer Relevanzschwellenwert.
HIGH Hoher Relevanzschwellenwert.

RelevanceScoreSpec

Die Spezifikation für die Rückgabe des Relevanzwerts für das Dokument.

JSON-Darstellung 
{
  "returnRelevanceScore": boolean
}
Felder
returnRelevanceScore

boolean

Optional. Gibt an, ob der Relevanzwert für Suchergebnisse zurückgegeben werden soll. Je höher der Wert, desto relevanter ist das Dokument für die Anfrage.

SearchAddonSpec

Mit SearchAddonSpec werden Add-ons für die Suche gemäß dem neuen Preismodell deaktiviert. Wenn die SearchAddonSpec nicht angegeben ist, gehen wir standardmäßig davon aus, dass der Kunde sie überall aktivieren möchte, wo dies möglich ist.

JSON-Darstellung 
{
  "disableSemanticAddOn": boolean,
  "disableKpiPersonalizationAddOn": boolean,
  "disableGenerativeAnswerAddOn": boolean
}
Felder
disableSemanticAddOn

boolean

Optional. Wenn „true“, ist das semantische Add-on deaktiviert. Das semantische Add-on umfasst Einbettungen und Jetstream.
disableKpiPersonalizationAddOn

boolean

Optional. Bei „true“ werden das Neuklassifizieren von Ereignissen und die Personalisierung deaktiviert, um KPIs zu optimieren und Ergebnisse zu personalisieren.
disableGenerativeAnswerAddOn

boolean

Optional. Wenn „true“ festgelegt ist, ist das Add-on für generative Antworten deaktiviert. Das Add-on für generative Antworten umfasst natürliche Sprache für Filter und einfache Antworten.

QuerySetSpec

Beschreibt die Spezifikation des Abfragesets.

JSON-Darstellung 
{
  "sampleQuerySet": string
}
Felder
sampleQuerySet

string

Optional. Der vollständige Ressourcenname des SampleQuerySet, der für die Bewertung verwendet wird, im Format projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

QualityMetrics

Beschreibt die Messwerte, die durch die Bewertung generiert werden.

JSON-Darstellung 
{
  "docRecall": {
    object (TopkMetrics)
  },
  "docPrecision": {
    object (TopkMetrics)
  },
  "docNdcg": {
    object (TopkMetrics)
  },
  "pageRecall": {
    object (TopkMetrics)
  },
  "pageNdcg": {
    object (TopkMetrics)
  }
}
Felder
docRecall

object (TopkMetrics)

Trefferquote pro Dokument bei verschiedenen Top-K-Grenzwerten.

Die Trefferquote ist der Anteil der abgerufenen relevanten Dokumente an allen relevanten Dokumenten.

Beispiel (Top 5): * Für ein einzelnes SampleQuery: Wenn 3 von 5 relevanten Dokumenten in den Top 5 abgerufen werden, ist Recall@5 = 3/5 = 0, 6.
docPrecision

object (TopkMetrics)

Genauigkeit pro Dokument bei verschiedenen Top-k-Grenzwerten.

Die Präzision ist der Anteil der abgerufenen Dokumente, die relevant sind.

Beispiel (Top 5): * Für ein einzelnes SampleQuery: Wenn 4 von 5 abgerufenen Dokumenten in den Top 5 relevant sind, ist precision@5 = 4/5 = 0, 8.
docNdcg

object (TopkMetrics)

Normalisierter diskontierter kumulierter Gewinn (NDCG) pro Dokument bei verschiedenen Top-k-Grenzwerten.

Mit NDCG wird die Ranking-Qualität gemessen, wobei Top-Ergebnisse stärker gewichtet werden.

Beispiel (Top 3): Angenommen, SampleQuery mit drei abgerufenen Dokumenten (D1, D2, D3) und binären Relevanzbewertungen (1 für relevant, 0 für nicht relevant):

Abgerufen: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)]

Berechnen Sie NDCG@3 für jede SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1,13 * Idealer DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1,63 * NDCG@3: 1,13/1,63 = 0,693
pageRecall

object (TopkMetrics)

Trefferquote pro Seite bei verschiedenen Top-k-Grenzwerten.

Die Trefferquote ist der Anteil der abgerufenen relevanten Seiten an allen relevanten Seiten.

Beispiel (Top 5): * Wenn für ein einzelnes SampleQuery 3 von 5 relevanten Seiten in den Top 5 abgerufen werden, gilt recall@5 = 3/5 = 0, 6.
pageNdcg

object (TopkMetrics)

Normalisierter diskontierter kumulierter Gewinn (NDCG) pro Seite bei verschiedenen Top-k-Grenzwerten.

Mit NDCG wird die Ranking-Qualität gemessen, wobei Top-Ergebnisse stärker gewichtet werden.

Beispiel (Top 3): Angenommen, SampleQuery mit drei abgerufenen Seiten (P1, P2, P3) und binären Relevanzbewertungen (1 für relevant, 0 für nicht relevant):

Abgerufen: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)]

NDCG@3 für SampleQuery berechnen: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1,13 * Ideales DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1,63 * NDCG@3: 1,13/1,63 = 0,693

TopkMetrics

Speichert die Messwerte auf bestimmten Top-k-Ebenen.

JSON-Darstellung 
{
  "top1": number,
  "top3": number,
  "top5": number,
  "top10": number
}
Felder
top1

number

Der Top-1-Wert.
top3

number

Der Wert für die drei wichtigsten.
top5

number

Der Wert der Top 5.
top10

number

Der Top-10-Wert.

Bundesland

Beschreibt den Status einer Auswertung.

Enums
STATE_UNSPECIFIED Die Bewertung ist nicht angegeben.
PENDING Der Dienst bereitet die Ausführung der Bewertung vor.
RUNNING Die Überprüfung läuft.
SUCCEEDED Die Bewertung wurde erfolgreich abgeschlossen.
FAILED Die Bewertung ist fehlgeschlagen.

Methoden

create

 Erstellt ein Evaluation

get

 Ruft eine Evaluation ab.

list

 Ruft eine Liste der Evaluations ab.

listResults

 Ruft eine Liste von Ergebnissen für ein bestimmtes Evaluation ab.