REST Resource: projects.locations.collections.engines

Ressource: Engine

Metadaten, die die Trainings- und Bereitstellungsparameter einer Engine beschreiben.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "dataStoreIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "industryVertical": enum (IndustryVertical),
  "commonConfig": {
    object (CommonConfig)
  },
  "appType": enum (AppType),
  "disableAnalytics": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "cmekConfig": {
    object (CmekConfig)
  },
  "configurableBillingApproach": enum (ConfigurableBillingApproach),
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },

  // Union field engine_config can be only one of the following:
  "chatEngineConfig": {
    object (ChatEngineConfig)
  },
  "searchEngineConfig": {
    object (SearchEngineConfig)
  },
  "mediaRecommendationEngineConfig": {
    object (MediaRecommendationEngineConfig)
  }
  // End of list of possible types for union field engine_config.

  // Union field engine_metadata can be only one of the following:
  "chatEngineMetadata": {
    object (ChatEngineMetadata)
  }
  // End of list of possible types for union field engine_metadata.
}
Felder
name

string

Nicht veränderbar. ID. Der voll qualifizierte Ressourcenname der Engine.

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

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}. „engine“ sollte 1 bis 63 Zeichen umfassen. Gültige Zeichen sind /[a-z0-9][a-z0-9-_]*/. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
displayName

string

Erforderlich. Der Anzeigename der Engine. Sollte für Menschen lesbar sein. Ein UTF-8-codierter String mit höchstens 1.024 Zeichen.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Erstellung des Empfehlungssystems.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen hat. 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 letzten Aktualisierung des Empfehlungssystems.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen hat. 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"
dataStoreIds[]

string

Optional. Die mit dieser Engine verknüpften Datenspeicher.

Engines vom Typ SOLUTION_TYPE_SEARCH und SOLUTION_TYPE_RECOMMENDATION können nur mit maximal einem Datenspeicher verknüpft werden.

Wenn solutionType den Wert SOLUTION_TYPE_CHAT hat, können mehrere DataStores in derselben Collection verknüpft werden.

Bei der Verwendung in CreateEngineRequest muss eine DataStore-ID angegeben werden, da das System sie für erforderliche Initialisierungen verwendet.
solutionType

enum (SolutionType)

Erforderlich. Die Lösungen der Engine.
industryVertical

enum (IndustryVertical)

Optional. Die Branche, für die die Engine registriert wird. Die Einschränkung der Engine-Branche basiert auf DataStore: Die Branche der Engine muss mit der Branche des mit der Engine verknüpften Datenspeichers übereinstimmen.
commonConfig

object (CommonConfig)

Allgemeine Konfigurationsspezifikation, die die Metadaten der Engine angibt.
appType

enum (AppType)

Optional. Nicht veränderbar. Dies ist der Anwendungstyp, den diese Engine-Ressource darstellt. HINWEIS: Dies ist ein neues Konzept, das unabhängig von der Branche oder dem Lösungstyp ist.
disableAnalytics

boolean

Optional. Gibt an, ob die Analyse für Suchanfragen, die mit dieser Engine durchgeführt werden, deaktiviert werden soll.
features

map (key: string, value: enum (FeatureState))

Optional. Funktionskonfiguration für die Engine, um Funktionen zu aktivieren oder zu deaktivieren. Unterstützte Schlüssel:

  • *: Alle Funktionen. Wenn dieses Attribut vorhanden ist, werden alle anderen Einstellungen für den Funktionsstatus ignoriert.
  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • feedback
  • session-sharing
  • personalization-memory
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
cmekConfig

object (CmekConfig)

Nur Ausgabe. CMEK-bezogene Informationen für die Engine.
configurableBillingApproach

enum (ConfigurableBillingApproach)

Optional. Konfiguration für den konfigurierbaren Abrechnungsansatz.
modelConfigs

map (key: string, value: enum (ModelState))

Optional. Ordnet einen Modellnamen der zugehörigen Konfiguration für diese Engine zu. So können Administratoren einzelne Modelle aktivieren oder deaktivieren. Hier werden nur Modelle gespeichert, deren Status vom Administrator überschrieben wird.

Wenn der Status nicht angegeben oder „modelConfigs“ für dieses Modell leer ist, entscheidet das System anhand der Standardkonfiguration, ob dieses Modell verfügbar sein soll. Ein Modell der Vorabversion sollte beispielsweise standardmäßig deaktiviert sein, wenn der Administrator es nicht aktiviert hat.
Union-Feld engine_config. Zusätzliche Konfigurationsspezifikationen, die das Verhalten der Engine definieren. Für engine_config ist nur einer der folgenden Werte zulässig:
chatEngineConfig

object (ChatEngineConfig)

Konfigurationen für die Chat-Engine. Gilt nur für den solutionType SOLUTION_TYPE_CHAT.
searchEngineConfig

object (SearchEngineConfig)

Konfigurationen für die Suchmaschine. Gilt nur für den solutionType SOLUTION_TYPE_SEARCH.
mediaRecommendationEngineConfig

object (MediaRecommendationEngineConfig)

Konfigurationen für die Medien-Engine. Gilt nur für Datenspeicher mit solutionType SOLUTION_TYPE_RECOMMENDATION und für die Branche IndustryVertical.MEDIA.
Union-Feld engine_metadata. Metadaten der Engine zum Überwachen des Status der Engine. Für engine_metadata ist nur einer der folgenden Werte zulässig:
chatEngineMetadata

object (ChatEngineMetadata)

Nur Ausgabe. Zusätzliche Informationen zur Chat-Engine. Gilt nur für den solutionType SOLUTION_TYPE_CHAT.

ChatEngineConfig

Konfigurationen für eine Chat-Engine.

JSON-Darstellung 
{
  "agentCreationConfig": {
    object (AgentCreationConfig)
  },
  "dialogflowAgentToLink": string,
  "allowCrossRegion": boolean
}
Felder
agentCreationConfig

object (AgentCreationConfig)

Die Konfiguration zum Generieren des Dialogflow-Agenten, der dieser Engine zugeordnet ist.

Diese Konfigurationen werden einmalig vom Dialogflow-Dienst verwendet und an ihn übergeben. Das bedeutet, dass sie nach der Erstellung der Engine nicht mehr über die EngineService.GetEngine oder EngineService.ListEngines API abgerufen werden können.
allowCrossRegion

boolean

Optional. Wenn das Flag auf „true“ gesetzt ist, dürfen sich der KI-Agent und die Engine an verschiedenen Standorten befinden. Andernfalls müssen sie sich am selben Standort befinden. Das Flag ist standardmäßig auf „false“ gesetzt.

allowCrossRegion wird einmalig von EngineService.CreateEngine verwendet und an EngineService.CreateEngine übergeben. Das bedeutet, dass sie nach der Erstellung der Engine nicht mehr über die EngineService.GetEngine oder EngineService.ListEngines API abgerufen werden kann.

AgentCreationConfig

Konfigurationen zum Generieren eines Dialogflow-Agenten.

Diese Konfigurationen werden einmalig vom Dialogflow-Dienst verwendet und an ihn übergeben. Das bedeutet, dass sie nach der Erstellung der Engine nicht mehr über die EngineService.GetEngine oder EngineService.ListEngines API abgerufen werden können.

JSON-Darstellung 
{
  "business": string,
  "defaultLanguageCode": string,
  "timeZone": string,
  "location": string
}
Felder
business

string

Name des Unternehmens, der Organisation oder der Entität, das beziehungsweise die der KI-Agent vertritt. Wird für den LLM-Prompt des Wissensconnectors und für die Wissenssuche verwendet.
defaultLanguageCode

string

Erforderlich. Die Standardsprache des KI-Agenten als Sprach-Tag. Unter Sprachunterstützung finden Sie eine Liste der aktuell unterstützten Sprachcodes.
timeZone

string

Erforderlich. Die Zeitzone des KI-Agenten aus der Zeitzonendatenbank, zum Beispiel Amerika/New_York, Europa/Paris.
location

string

Standort des KI-Agenten für die Erstellung. Unterstützte Werte: global/us/eu. Wenn nicht angegeben, wird ein KI-Agent von der US-Engine standardmäßig mit „us-central-1“ und von der EU-Engine standardmäßig mit „eu-west-1“ erstellt.

SearchEngineConfig

Konfigurationen für eine Suchmaschine.

JSON-Darstellung 
{
  "searchTier": enum (SearchTier),
  "searchAddOns": [
    enum (SearchAddOn)
  ]
}
Felder
searchTier

enum (SearchTier)

Die Suchfunktionsstufe dieser Engine.

Für die verschiedenen Stufen gelten möglicherweise unterschiedliche Preise. Weitere Informationen finden Sie in der Preisdokumentation.

Wenn keine Angabe gemacht wird, ist der Standardwert SearchTier.SEARCH_TIER_STANDARD.
searchAddOns[]

enum (SearchAddOn)

Das Add‑on, das durch diese Suchmaschine aktiviert wird.

SearchTier

Stufen von Suchfunktionen. Für die verschiedenen Stufen gelten möglicherweise unterschiedliche Preise. Weitere Informationen finden Sie in der Preisdokumentation.

Enums
SEARCH_TIER_UNSPECIFIED Standardwert, wenn für Enum nichts angegeben ist. Diese Option ist ungültig.
SEARCH_TIER_STANDARD Standardstufe.
SEARCH_TIER_ENTERPRISE Enterprise-Stufe.

SearchAddOn

Add-on, das zusätzliche Funktionen für die Suche bietet.

Enums
SEARCH_ADD_ON_UNSPECIFIED Standardwert, wenn für Enum nichts angegeben ist. Diese Option ist ungültig.
SEARCH_ADD_ON_LLM Add-on für Large Language Models.

MediaRecommendationEngineConfig

Zusätzliche Konfigurationsspezifikationen für ein Medienempfehlungssystem.

JSON-Darstellung 
{
  "type": string,
  "optimizationObjective": string,
  "optimizationObjectiveConfig": {
    object (OptimizationObjectiveConfig)
  },
  "trainingState": enum (TrainingState),
  "engineFeaturesConfig": {
    object (EngineFeaturesConfig)
  }
}
Felder
type

string

Erforderlich. Der Engine-Typ, zum Beispiel recommended-for-you.

Dieses Feld und optimizationObjective beschreiben Metadaten für die Engine, mit denen das Training und die Bereitstellung der Engine gesteuert werden.

Derzeit unterstützte Werte: recommended-for-you, others-you-may-like, more-like-this und most-popular-items.
optimizationObjective

string

Das Optimierungsziel, zum Beispiel cvr.

Dieses Feld und optimizationObjective beschreiben Metadaten für die Engine, mit denen das Training und die Bereitstellung der Engine gesteuert werden.

Derzeit unterstützte Werte: ctr und cvr.

Falls nicht angegeben, wird der Standardwert für den Engine-Typ ausgewählt. Der Standardwert hängt vom Empfehlungstyp ab:

recommended-for-you => ctr

others-you-may-like => ctr
optimizationObjectiveConfig

object (OptimizationObjectiveConfig)

Name und Wert des benutzerdefinierten Grenzwerts, wenn für „optimizationObjective“ „cvr“ festgelegt ist. Wenn für „targetField“ watch-time festgelegt ist, muss „target_field_value“ ein ganzzahliger Wert sein, der die Medienfortschrittszeit in Sekunden zwischen [0, 86.400] angibt (0 wird ausgeschlossen, 86.400 wird eingeschlossen). Beispiel: 90). Wenn für „targetField“ watch-percentage festgelegt ist, muss „target_field_value“ ein gültiger Gleitkommawert zwischen [0, 1.0] sein (0 wird ausgeschlossen, 1.0 wird eingeschlossen) (Beispiel: 0.5).
trainingState

enum (TrainingState)

Der Trainingsstatus der Engine, zum Beispiel TRAINING oder PAUSED.

Da ein Teil der Kosten für den Betrieb des Dienstes von der Häufigkeit des Trainings abhängt, kann damit bestimmt werden, wann die Engine trainiert werden soll, um die Kosten zu kontrollieren. Wenn nichts angegeben ist, ist der Standardwert für die Methode engines.create TRAINING. Der Standardwert für die Methode engines.patch ist, den Status beizubehalten.
engineFeaturesConfig

object (EngineFeaturesConfig)

Optional. Konfiguration zusätzlicher Engine-Funktionen.

OptimizationObjectiveConfig

Benutzerdefinierte Untergrenze für „optimizationObjective“ mit dem Wert cvr.

JSON-Darstellung 
{
  "targetField": string,
  "targetFieldValueFloat": number
}
Felder
targetField

string

Erforderlich. Der Name des Zielfelds. Derzeit unterstützte Werte: watch-percentage und watch-time.
targetFieldValueFloat

number

Erforderlich. Der Schwellenwert, der auf das Ziel angewendet werden soll (Beispiel: 0.5).

TrainingState

Der Trainingsstatus der Engine.

Enums
TRAINING_STATE_UNSPECIFIED Trainingsstatus nicht angegeben.
PAUSED Das Training der Engine wurde pausiert.
TRAINING Die Engine wird gerade trainiert.

EngineFeaturesConfig

Weitere Funktionskonfigurationen des ausgewählten Engine-Typs.

JSON-Darstellung 
{

  // Union field type_dedicated_config can be only one of the following:
  "recommendedForYouConfig": {
    object (RecommendedForYouFeatureConfig)
  },
  "mostPopularConfig": {
    object (MostPopularFeatureConfig)
  }
  // End of list of possible types for union field type_dedicated_config.
}
Felder
Union-Feld type_dedicated_config. Funktionsbezogene Konfigurationen, die auf einen bestimmten Typ von Medienempfehlungssystem angewendet werden Für type_dedicated_config ist nur einer der folgenden Werte zulässig:
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

Funktionskonfiguration der „Recommended-for-you“-Engine.

RecommendedForYouFeatureConfig

Zusätzliche Konfigurationen für das Erstellen einer recommended-for-you-Engine.

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

string

Der Ereignistyp, mit dem die Engine zum Zeitpunkt der Vorhersage abgefragt wird. Wenn dies auf generic festgelegt ist, werden nur view-item, media-play und media-complete als context-event beim Engine-Training verwendet. Wenn view-home-page festgelegt ist, wird view-home-page zusätzlich zu view-item, media-play und media-complete als context-events verwendet. Wird aktuell für die recommended-for-you-Engine unterstützt. Derzeit unterstützte Werte: view-home-page und generic.

MostPopularFeatureConfig

Funktionskonfigurationen, die zum Erstellen einer „Most Popular“-Engine erforderlich sind.

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

string (int64 format)

Das Zeitfenster, für das die Engine während des Trainings und der Vorhersage abgefragt wird. Nur positive Ganzzahlen. Der Wert entspricht den Ereignissen der letzten X Tage. Derzeit für die most-popular-items-Engine erforderlich.

ChatEngineMetadata

Zusätzliche Informationen zu einer Chat-Engine. Die Felder in dieser Nachricht dienen nur der Ausgabe.

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

string

Der Ressourcenname eines Dialogflow-Agenten, auf den sich diese Chat-Engine bezieht.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

CommonConfig

Gängige Konfigurationen für eine Engine.

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

string

Der Name des Unternehmens oder der Entität, das beziehungsweise die mit der Engine verknüpft ist. Dies kann die LLM-bezogenen Funktionen möglicherweise verbessern.

AppType

Die Anwendung der Engine.

Enums
APP_TYPE_UNSPECIFIED Alle nicht angegebenen Anwendungen.
APP_TYPE_INTRANET Anwendungstyp für die Intranetsuche und Agentspace.

FeatureState

Der Status der Funktion für die Engine.

Enums
FEATURE_STATE_UNSPECIFIED Der Status der Funktion ist nicht angegeben.
FEATURE_STATE_ON Die Funktion ist aktiviert, um sie zugänglich zu machen.
FEATURE_STATE_OFF Die Funktion ist deaktiviert und kann nicht aufgerufen werden.

ConfigurableBillingApproach

Konfiguration für den konfigurierbaren Abrechnungsansatz.

Enums
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED Standardwert. Nicht konfigurierbarer Abrechnungsansatz für Spark und Nicht-Spark. Allgemeines Preismodell.
CONFIGURABLE_BILLING_APPROACH_ENABLED Der Abrechnungsansatz richtet sich nach den vom Kunden angegebenen Konfigurationen.

ModelState

Der Status des Modells für die Engine.

Enums
MODEL_STATE_UNSPECIFIED Der Modellstatus ist nicht angegeben.
MODEL_ENABLED Das Modell wurde vom Administrator aktiviert.
MODEL_DISABLED Das Modell wurde vom Administrator deaktiviert.

Methoden

create

 Erstellt ein Engine

delete

 Löscht ein Engine

get

 Ruft eine Engine ab.

list

 Listet alle Engines auf, die dem Projekt zugeordnet sind

patch

 Aktualisiert eine Engine.

pause

 Pausiert das Training einer vorhandenen Engine.

resume

 Setzt das Training einer vorhandenen Engine fort.

tune

 Stimmt eine vorhandene Engine ab.