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

Ressource: ServingConfig

Konfiguriert Metadaten, die verwendet werden, um Ergebnisse zur Bereitstellungszeit zu generieren, 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,
  "rankingExpression": string,
  "createTime": string,
  "updateTime": string,
  "filterControlIds": [
    string
  ],
  "boostControlIds": [
    string
  ],
  "redirectControlIds": [
    string
  ],
  "synonymsControlIds": [
    string
  ],
  "onewaySynonymsControlIds": [
    string
  ],
  "dissociateControlIds": [
    string
  ],
  "replacementControlIds": [
    string
  ],
  "ignoreControlIds": [
    string
  ],
  "promoteControlIds": [
    string
  ],
  "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. Voll 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-UI 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, mit dem eine Bereitstellungskonfiguration verknüpft werden kann.
modelId

string

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

Erforderlich, wenn der SolutionType SOLUTION_TYPE_RECOMMENDATION ist.
diversityLevel

string

Gibt an, wie vielfältig die Ergebnisse des Empfehlungsmodells sein sollen, z. B. medium-diversity oder high-diversity. Derzeit unterstützte Werte:

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

Falls nicht angegeben, wird der Standardwert für den Empfehlungsmodelltyp ausgewählt. Standardwert: no-diversity.

Kann nur festgelegt werden, wenn der SolutionType SOLUTION_TYPE_RECOMMENDATION ist.
rankingExpression

string

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

Der Rankingausdruck besteht aus einer einzigen Funktion oder mehreren 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: Die Einbettungsfunktion zwischen „embedding_field_path“ und dem Anfrage-Einbettungsvektor.

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

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Erstellung der 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 der 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

Filtersteuerungen, die im Bereitstellungspfad verwendet werden sollen. Alle ausgelösten Filtersteuerungen werden angewendet. Die Filtersteuerungen müssen sich im selben Datenspeicher wie die Bereitstellungskonfiguration befinden. Maximal 20 Filtersteuerungen.
boostControlIds[]

string

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

string

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

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

string

Spezifikationen für bedingte Synonyme. Wenn mehrere Synonymbedingungen zutreffen, werden alle zutreffenden Synonymsteuerelemente in der Liste ausgeführt. Es sind maximal 100 Spezifikationen zulässig.

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

string

Spezifikationen für bedingte unidirektionale Synonyme. Wenn mehrere Bedingungen für unidirektionale Synonyme zutreffen, werden alle zutreffenden Steuerelemente für unidirektionale Synonyme in der Liste ausgeführt. Es sind maximal 100 Spezifikationen zulässig.

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

string

Spezifikationen für bedingte Nicht-Zuordnungen. Wenn mehrere Bedingungen für die Nicht-Zuordnung zutreffen, werden alle zutreffenden Steuerelemente für Nicht-Zuordnungen in der Liste ausgeführt. Die Reihenfolge spielt keine Rolle. Es sind maximal 100 Spezifikationen zulässig.

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

string

Spezifikationen für bedingtes Ersetzen. Diese werden nach der Reihenfolge in der Liste angewendet. Ein bereits ersetzter Begriff kann nicht noch einmal ersetzt werden. Es sind maximal 100 Spezifikationen zulässig.

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

string

Spezifikationen für bedingtes Ignorieren. Wenn mehrere Bedingungen für das Ignorieren zutreffen, werden alle zutreffenden Steuerelemente für das Ignorieren in der Liste ausgeführt. Die Reihenfolge spielt keine Rolle. Es sind maximal 100 Spezifikationen zulässig.
promoteControlIds[]

string

Spezifikationen für bedingtes Hochstufen.

Es sind maximal 100 Spezifikationen zulässig.
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.

MediaConfig

Gibt die für die Media Discovery erforderlichen Konfigurationen an. Derzeit unterstützen wir:

  • demote_content_watched: Schwellenwert für die Herabstufung von angesehenen Inhalten. Kunden können angeben, ob sie die Herabstufung angesehener Inhalte oder die Herabstufung von Inhalten, deren Detailseite angesehen wurde, verwenden möchten. Bei der Herabstufung von angesehenen Inhalten müssen Kunden angeben, ob die angesehenen Minuten oder der Prozentsatz den Schwellenwert überschreitet. Wenn dies der Fall ist, werden die Inhalte in den Empfehlungsergebnissen herabgestuft.
  • promote_fresh_content: Stichtage für die Bewerbung neuer Inhalte. Kunden können angeben, ob sie die Bewerbung neuer Inhalte nutzen möchten. Wenn die Inhalte innerhalb des Zeitraums veröffentlicht wurden, werden sie in den Empfehlungsergebnissen beworben. Kann nur festgelegt werden, wenn der SolutionType SOLUTION_TYPE_RECOMMENDATION ist.
JSON-Darstellung 
{
  "demotionEventType": string,
  "demoteContentWatchedPastDays": integer,
  "contentFreshnessCutoffDays": integer,

  // Union field demote_content_watched can be only one of the following:
  "contentWatchedPercentageThreshold": number,
  "contentWatchedSecondsThreshold": number
  // End of list of possible types for union field demote_content_watched.
}
Felder
demotionEventType

string

Gibt den Ereignistyp an, der zum Herabstufen von Empfehlungsergebnissen verwendet wird. Derzeit unterstützte Werte:

  • view-item: Artikel angesehen
  • media-play: Video oder Song starten oder Wiedergabe fortsetzen
  • media-complete: Das Video, Lied usw. wurde beendet oder mittendrin angehalten.

Wenn die Option nicht festgelegt ist, wird die Herabstufung des Wiedergabeverlaufs nicht angewendet. Die Herabstufung aufgrund der Aktualität von Inhalten wird weiterhin angewendet.
demoteContentWatchedPastDays

integer

Optional. Gibt die Anzahl der Tage an, die beim Herabstufen angesehener Inhalte berücksichtigt werden sollen. Wenn der Wert auf null gesetzt oder nicht festgelegt ist, wird standardmäßig der maximale Wert von 365 Tagen verwendet.
contentFreshnessCutoffDays

integer

Gibt die Aktualität der Inhalte an, die für das Empfehlungsergebnis verwendet werden. Inhalte werden herabgestuft, wenn sie länger als die festgelegten Tage für die Aktualität von Inhalten veröffentlicht wurden.
Union-Feld demote_content_watched. Geben Sie den Schwellenwert für das Herabstufen angesehener Inhalte an. Er kann entweder ein Prozentsatz oder ein Wert in Minuten sein. Dieser Wert muss für den Ereignistyp media-complete festgelegt werden. Für demote_content_watched ist nur einer der folgenden Werte zulässig:
contentWatchedPercentageThreshold

number

Gibt den Schwellenwert für den Prozentsatz der angesehenen Inhalte für die Herabstufung an. Der Schwellenwert muss zwischen [0 und 1,0] (einschließlich) liegen.
contentWatchedSecondsThreshold

number

Gibt den Schwellenwert für die Wiedergabezeit (in Minuten) an, ab dem Inhalte herabgestuft werden.

GenericConfig

Gibt die für die generische Suche erforderlichen Konfigurationen an. Derzeit werden folgende Konfigurationen unterstützt:

  • contentSearchSpec: Konfiguration für die allgemeine Inhaltssuche
JSON-Darstellung 
{
  "contentSearchSpec": {
    object (ContentSearchSpec)
  }
}
Felder
contentSearchSpec

object (ContentSearchSpec)

Gibt das erwartete Verhalten der Inhaltssuche an. Gilt nur für Datenspeicher, in denen die Inhaltssuche aktiviert ist.

AnswerGenerationSpec

Die Spezifikation für die Antwortgenerierung

JSON-Darstellung 
{
  "userDefinedClassifierSpec": {
    object (UserDefinedClassifierSpec)
  }
}
Felder
userDefinedClassifierSpec

object (UserDefinedClassifierSpec)

Optional. Die Spezifikation für die benutzerdefinierte Klassifikatorspezifikation

UserDefinedClassifierSpec

Die Spezifikation für den benutzerdefinierten Klassifikator

JSON-Darstellung 
{
  "enableUserDefinedClassifier": boolean,
  "preamble": string,
  "modelId": string,
  "taskMarker": string,
  "topP": number,
  "topK": string,
  "temperature": number,
  "seed": integer
}
Felder
enableUserDefinedClassifier

boolean

Optional. Gibt an, ob ein benutzerdefinierter Klassifikator aktiviert und einbezogen werden soll
preamble

string

Optional. Die Präambel, die für den benutzerdefinierten Klassifikator verwendet werden soll
modelId

string

Optional. Die Modell-ID, die für den benutzerdefinierten Klassifikator verwendet werden soll
taskMarker

string

Optional. Die Aufgabenmarkierung, die für den benutzerdefinierten Klassifikator verwendet werden soll
topP

number

Optional. Der Top‑P-Wert, der für den benutzerdefinierten Klassifikator verwendet werden soll
topK

string (int64 format)

Optional. Der Top‑K-Wert, der für den benutzerdefinierten Klassifikator verwendet werden soll
temperature

number

Optional. Der Temperaturwert, der für den benutzerdefinierten Klassifikator verwendet werden soll
seed

integer

Optional. Der Startwert, der für den benutzerdefinierte Klassifikator verwendet werden soll

Methoden

answer

 Methode zum Beantworten von Anfragen

get

 Ruft eine ServingConfig ab

list

 Listet alle ServingConfigs auf, die mit diesem DataStore 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).