REST Resource: projects.locations.collections.engines.servingConfigs

Ressource: ServingConfig

Konfiguriert Metadaten, die zum Generieren von Ergebnissen zur Bereitstellungszeit verwendet werden, z.B. Suchergebnisse oder Empfehlungsvorhersagen. Die ServingConfig wird in der Such- und Vorhersageanfrage übergeben und generiert Ergebnisse.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "solutionType": enum (SolutionType),
  "modelId": string,
  "diversityLevel": string,
  "embeddingConfig": {
    object (EmbeddingConfig)
  },
  "rankingExpression": string,
  "guidedSearchSpec": {
    object (GuidedSearchSpec)
  },
  "customFineTuningSpec": {
    object (CustomFineTuningSpec)
  },
  "createTime": string,
  "updateTime": string,
  "filterControlIds": [
    string
  ],
  "boostControlIds": [
    string
  ],
  "redirectControlIds": [
    string
  ],
  "synonymsControlIds": [
    string
  ],
  "onewaySynonymsControlIds": [
    string
  ],
  "dissociateControlIds": [
    string
  ],
  "replacementControlIds": [
    string
  ],
  "ignoreControlIds": [
    string
  ],
  "promoteControlIds": [
    string
  ],
  "personalizationSpec": {
    object (PersonalizationSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },

  // Union field vertical_config can be only one of the following:
  "mediaConfig": {
    object (MediaConfig)
  },
  "genericConfig": {
    object (GenericConfig)
  }
  // End of list of possible types for union field vertical_config.
}
Felder
name

string

Nicht veränderbar. Vollständig qualifizierter Name projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}/servingConfigs/{servingConfigId}
displayName

string

Erforderlich. Der für Menschen lesbare Anzeigename der Bereitstellungskonfiguration. Wird in der Discovery-Benutzeroberfläche verwendet.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
solutionType

enum (SolutionType)

Erforderlich. Nicht veränderbar. Gibt den Lösungstyp an, dem eine Serving-Konfiguration zugeordnet werden kann.
modelId

string

Die ID des Modells, das zur Bereitstellungszeit verwendet werden soll. Derzeit werden nur RecommendationModels unterstützt. Kann geändert werden, aber nur in ein kompatibles Modell (z.B. „Was Ihnen sonst noch gefallen könnte“-CTR in „Was Ihnen sonst noch gefallen könnte“-CVR).

Erforderlich, wenn SolutionType SOLUTION_TYPE_RECOMMENDATION ist.
diversityLevel

string

Wie viel Diversität in den Ergebnissen des Empfehlungsmodells verwendet werden soll, z.B. medium-diversity oder high-diversity. Derzeit unterstützte Werte:

  • no-diversity
  • low-diversity
  • medium-diversity
  • high-diversity
  • auto-diversity

Wenn nicht angegeben, wird der Standardwert basierend auf dem Empfehlungsmodelltyp ausgewählt. Standardwert: no-diversity.

Kann nur festgelegt werden, wenn SolutionType SOLUTION_TYPE_RECOMMENDATION ist.
embeddingConfig

object (EmbeddingConfig)

Eigene Einbettungskonfiguration verwenden Die Konfiguration wird für die semantische Suche verwendet. Der Abruf basiert auf dem Skalarprodukt von SearchRequest.EmbeddingSpec.EmbeddingVector.vector und den Dokumenteinbettungen, die von dieser EmbeddingConfig bereitgestellt werden. Wenn SearchRequest.EmbeddingSpec.EmbeddingVector.vector angegeben ist, wird ServingConfig.embedding_config damit überschrieben.
rankingExpression

string

Mit dem Ranking-Ausdruck wird das benutzerdefinierte Ranking beim Abrufen von Dokumenten gesteuert. Dazu ist das Einbetten von Dokumenten erforderlich. Die Einstellung für den Ranking-Ausdruck in ServingConfig gilt für alle Suchanfragen, die von der Bereitstellungskonfiguration bereitgestellt werden. Wenn SearchRequest.ranking_expression angegeben ist, wird der Ranking-Ausdruck der ServingConfig jedoch überschrieben.

Der Ranking-Ausdruck ist eine einzelne Funktion oder mehrere Funktionen, die durch „+“ verbunden sind.

  • rankingExpression = function, { " + ", function };

Unterstützte Funktionen:

  • double * relevanceScore
  • double * dotProduct(embedding_field_path)

Funktionsvariablen:

  • relevanceScore: Vordefinierte Keywords, die verwendet werden, um die Relevanz zwischen Anfrage und Dokument zu messen.
  • embedding_field_path: Das Dokumenteinbettungsfeld, das mit dem Abfrageeinbettungsvektor verwendet wird.
  • dotProduct: Einbettungsfunktion zwischen „embedding_field_path“ und dem Einbettungsvektor der Anfrage.

Beispiel für einen Rankingausdruck:

Wenn ein Dokument das Einbettungsfeld „doc_embedding“ hat, könnte der Ranking-Ausdruck 0.5 * relevanceScore + 0.3 * dotProduct(doc_embedding) lauten.
guidedSearchSpec

object (GuidedSearchSpec)

Konfigurationen für die geführte Suche.
customFineTuningSpec

object (CustomFineTuningSpec)

Benutzerdefinierte Konfigurationen für das Fine-Tuning. Wenn SearchRequest.custom_fine_tuning_spec festgelegt ist, hat es eine höhere Priorität als die hier festgelegten Konfigurationen.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Erstellung von ServingConfig.

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

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Aktualisierung von ServingConfig.

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".
filterControlIds[]

string

Filtereinstellungen, die im Bereitstellungspfad verwendet werden sollen. Alle ausgelösten Filter werden angewendet. Filtersteuerungen müssen sich im selben Datenspeicher wie die Serving-Konfiguration befinden. Maximal 20 Filtersteuerungen.
boostControlIds[]

string

Boost-Variablen, die im Bereitstellungspfad verwendet werden sollen. Alle ausgelösten Boost-Einstellungen werden angewendet. Die Boost-Steuerelemente müssen sich im selben Datenspeicher wie die Serving-Konfiguration befinden. Maximal 20 Einstellungen zum Hochstufen.
redirectControlIds[]

string

IDs der Weiterleitungseinstellungen. Es wird nur die erste ausgelöste Weiterleitungsaktion angewendet, auch wenn mehrere zutreffen. Es sind maximal 100 Spezifikationen zulässig.

Kann nur festgelegt werden, wenn SolutionType SOLUTION_TYPE_SEARCH ist.
synonymsControlIds[]

string

Spezifikationen für Bedingungssynonyme. Wenn mehrere Synonymbedingungen übereinstimmen, werden alle übereinstimmenden Synonymsteuerungen in der Liste ausgeführt. Es sind maximal 100 Spezifikationen zulässig.

Kann nur festgelegt werden, wenn SolutionType SOLUTION_TYPE_SEARCH ist.
onewaySynonymsControlIds[]

string

Spezifikationen für unidirektionale Synonyme für Bedingungen. Wenn mehrere unidirektionale Synonymbedingungen übereinstimmen, werden alle übereinstimmenden unidirektionalen Synonymsteuerungen in der Liste ausgeführt. Es sind maximal 100 Spezifikationen zulässig.

Kann nur festgelegt werden, wenn SolutionType SOLUTION_TYPE_SEARCH ist.
dissociateControlIds[]

string

Die Bedingung ist nicht mit Spezifikationen verknüpft. Wenn mehrere Bedingungen für die Zuordnung nicht zutreffen, werden alle übereinstimmenden Kontrollvariablen in der Liste ausgeführt. Die Reihenfolge spielt keine Rolle. Es sind maximal 100 Spezifikationen zulässig.

Kann nur festgelegt werden, wenn SolutionType SOLUTION_TYPE_SEARCH ist.
replacementControlIds[]

string

Spezifikationen für den Bedingungsersatz. Die Anwendung erfolgt in der Reihenfolge der Liste. Ein zuvor ersetzter Begriff kann nicht noch einmal ersetzt werden. Es sind maximal 100 Spezifikationen zulässig.

Kann nur festgelegt werden, wenn SolutionType SOLUTION_TYPE_SEARCH ist.
ignoreControlIds[]

string

Bedingungsspezifikationen ignorieren. Wenn mehrere Bedingungen zum Ignorieren übereinstimmen, werden alle übereinstimmenden Steuerelemente zum Ignorieren in der Liste ausgeführt. Die Reihenfolge spielt keine Rolle. Es sind maximal 100 Spezifikationen zulässig.
promoteControlIds[]

string

Bedingung für die Bewerbungsspezifikationen.

Es sind maximal 100 Spezifikationen zulässig.
personalizationSpec

object (PersonalizationSpec)

Die Spezifikation für die Personalisierungsspezifikation.

Wenn sowohl ServingConfig.personalization_spec als auch SearchRequest.personalization_spec festgelegt sind, überschreibt SearchRequest.personalization_spec ServingConfig.personalization_spec.
answerGenerationSpec

object (AnswerGenerationSpec)

Optional. Die Spezifikation für die Antwortgenerierung.
Union-Feld vertical_config. Branchenspezifische Konfiguration. Für vertical_config ist nur einer der folgenden Werte zulässig:
mediaConfig

object (MediaConfig)

Die MediaConfig der Bereitstellungskonfiguration.
genericConfig

object (GenericConfig)

Die GenericConfig der Bereitstellungskonfiguration.

Methoden

answer

 Methode zum Beantworten von Anfragen.

create

 Erstellt eine ServingConfig.

delete

 Löscht eine ServingConfig.

get

 Ruft eine ServingConfig ab.

list

 Listet alle ServingConfigs auf, die mit diesem Datenspeicher verknüpft sind.

patch

 Aktualisiert eine ServingConfig.

recommend

 Gibt eine Empfehlung ab, für die ein kontextbezogenes Nutzerereignis erforderlich ist.
Führt eine Suche aus.

searchLite

 Führt eine Suche aus.

streamAnswer

 Methode zum Beantworten von Anfragen (Streaming).