- Ressource: Engine
- SimilarDocumentsEngineConfig
- ChatEngineConfig
- AgentCreationConfig
- SearchEngineConfig
- SearchTier
- SearchAddOn
- MediaRecommendationEngineConfig
- OptimizationObjectiveConfig
- TrainingState
- EngineFeaturesConfig
- RecommendedForYouFeatureConfig
- MostPopularFeatureConfig
- RecommendationMetadata
- ServingState
- DataState
- ChatEngineMetadata
- CommonConfig
- KnowledgeGraphConfig
- FeatureConfig
- AppType
- FeatureState
- ConfigurableBillingApproach
- ModelState
- Methoden
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 ( |
| Felder | |
|---|---|
name |
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: |
displayName |
Erforderlich. Der Anzeigename der Engine. Sollte für Menschen lesbar sein. Ein UTF-8-codierter String mit höchstens 1.024 Zeichen. |
createTime |
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: |
updateTime |
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: |
dataStoreIds[] |
Optional. Die mit dieser Engine verknüpften Datenspeicher. Engines vom Typ Wenn Bei der Verwendung in |
solutionType |
Erforderlich. Die Lösungen der Engine. |
industryVertical |
Optional. Die Branche, für die die Engine registriert wird. Die Einschränkung der Engine-Branche basiert auf |
commonConfig |
Allgemeine Konfigurationsspezifikation, die die Metadaten der Engine angibt. |
knowledgeGraphConfig |
Optional. Konfigurationen für den Knowledge Graph. Gilt nur für den |
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 |
Optional. Gibt an, ob die Analyse für Suchanfragen, die mit dieser Engine durchgeführt werden, deaktiviert werden soll. |
features |
Optional. Funktionskonfiguration für die Engine, um Funktionen zu aktivieren oder zu deaktivieren. Unterstützte Schlüssel:
|
cmekConfig |
Nur Ausgabe. CMEK-bezogene Informationen für die Engine. |
configurableBillingApproach |
Optional. Konfiguration für den konfigurierbaren Abrechnungsansatz. |
modelConfigs |
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: |
|
similarDocumentsConfig |
Zusätzliche Konfigurationsspezifikationen für eine |
chatEngineConfig |
Konfigurationen für die Chat-Engine. Gilt nur für den |
searchEngineConfig |
Konfigurationen für die Suchmaschine. Gilt nur für den |
mediaRecommendationEngineConfig |
Konfigurationen für die Medien-Engine. Gilt nur für Datenspeicher mit |
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: |
|
recommendationMetadata |
Nur Ausgabe. Zusätzliche Informationen zu einem Empfehlungssystem. Gilt nur für den |
chatEngineMetadata |
Nur Ausgabe. Zusätzliche Informationen zur Chat-Engine. Gilt nur für den |
SimilarDocumentsEngineConfig
Dieser Typ hat keine Felder.
Zusätzliche Konfigurationsspezifikationen für eine similar-items-Engine.
ChatEngineConfig
Konfigurationen für eine Chat-Engine.
| JSON-Darstellung |
|---|
{
"agentCreationConfig": {
object ( |
| Felder | |
|---|---|
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 |
dialogflowAgentToLink |
Der Ressourcenname eines vorhandenen Dialogflow-Agenten, der mit dieser Chat-Engine verknüpft werden soll. Kunden können entweder Format:
|
allowCrossRegion |
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.
|
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 |
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 |
Erforderlich. Die Standardsprache des KI-Agenten als Sprach-Tag. Unter Sprachunterstützung finden Sie eine Liste der aktuell unterstützten Sprachcodes. |
timeZone |
Erforderlich. Die Zeitzone des KI-Agenten aus der Zeitzonendatenbank, zum Beispiel Amerika/New_York, Europa/Paris. |
location |
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 ( |
| Felder | |
|---|---|
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 |
requiredSubscriptionTier |
Optional. Die erforderliche Abostufe dieser Engine. Sie können nach der Erstellung der Engine nicht mehr geändert werden. Wenn die erforderliche Aboversion „Search“ ist, können Nutzer mit einer höheren Lizenzversion wie „Assist“ weiterhin auf die mit dieser Engine verknüpfte eigenständige App zugreifen. |
searchAddOns[] |
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 ( |
| Felder | |
|---|---|
type |
Erforderlich. Der Engine-Typ, zum Beispiel Dieses Feld und Derzeit unterstützte Werte: |
optimizationObjective |
Das Optimierungsziel, zum Beispiel Dieses Feld und Derzeit unterstützte Werte: Falls nicht angegeben, wird der Standardwert für den Engine-Typ ausgewählt. Der Standardwert hängt vom Empfehlungstyp ab:
|
optimizationObjectiveConfig |
Name und Wert des benutzerdefinierten Grenzwerts, wenn für „optimizationObjective“ „cvr“ festgelegt ist. Wenn für „targetField“ |
trainingState |
Der Trainingsstatus der Engine, zum Beispiel 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 |
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 |
Erforderlich. Der Name des Zielfelds. Derzeit unterstützte Werte: |
targetFieldValueFloat |
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 |
| 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 |
Funktionskonfiguration der „Recommended-for-you“-Engine. |
mostPopularConfig |
Funktionskonfiguration der „Most-popular“-Engine. |
RecommendedForYouFeatureConfig
Zusätzliche Konfigurationen für das Erstellen einer recommended-for-you-Engine.
| JSON-Darstellung |
|---|
{ "contextEventType": string } |
| Felder | |
|---|---|
contextEventType |
Der Ereignistyp, mit dem die Engine zum Zeitpunkt der Vorhersage abgefragt wird. Wenn dies auf |
MostPopularFeatureConfig
Funktionskonfigurationen, die zum Erstellen einer „Most Popular“-Engine erforderlich sind.
| JSON-Darstellung |
|---|
{ "timeWindowDays": string } |
| Felder | |
|---|---|
timeWindowDays |
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 |
RecommendationMetadata
Zusätzliche Informationen zu einem Empfehlungssystem.
| JSON-Darstellung |
|---|
{ "servingState": enum ( |
| Felder | |
|---|---|
servingState |
Nur Ausgabe. Der Bereitstellungsstatus der Engine: |
dataState |
Nur Ausgabe. Der Status der Datenanforderungen für diese Engine: Die Engine kann nicht trainiert werden, wenn sich die Daten im Status |
lastTuneTime |
Nur Ausgabe. Der Zeitstempel, der angibt, wann die letzte erfolgreiche Abstimmung abgeschlossen wurde. Gilt nur für Media Recommendation-Engines. 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: |
lastTrainTime |
Nur Ausgabe. Der Zeitstempel, der angibt, wann das letzte erfolgreiche Training abgeschlossen wurde. Gilt nur für Media Recommendation-Engines. 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: |
tuningOperation |
Nur Ausgabe. Die ID des letzten Optimierungsvorgangs, der mit der Engine verknüpft ist. Gilt nur für Media Recommendation-Engines. Wenn vorhanden, kann diese Vorgangs-ID verwendet werden, um festzustellen, ob für diese Engine eine Abstimmung läuft. Senden Sie die Anfrage „operations.get“ mit dieser Vorgangs-ID im Engine-Ressourcenformat, um den Vorgangsstatus zu prüfen. Wenn für diese Engine keine Optimierung erfolgt ist, ist der String leer. |
ServingState
Der Bereitstellungsstatus des Empfehlungssystems.
| Enums | |
|---|---|
SERVING_STATE_UNSPECIFIED |
Nicht angegebener Bereitstellungsstatus. |
INACTIVE |
Die Engine wird nicht bereitgestellt. |
ACTIVE |
Die Engine wird bereitgestellt und kann abgefragt werden. |
TUNED |
Die Engine wird mit optimierten Hyperparametern trainiert und kann abgefragt werden. |
DataState
Gibt an, ob für diese Engine genügend Trainingsdaten vorhanden sind, um sie kontinuierlich zu trainieren.
| Enums | |
|---|---|
DATA_STATE_UNSPECIFIED |
Nicht angegebener Standardwert, sollte nie explizit festgelegt werden. |
DATA_OK |
Die Engine hat genügend Trainingsdaten. |
DATA_ERROR |
Die Engine hat nicht genügend Trainingsdaten. Fehlermeldungen können über Stackdriver abgefragt werden. |
ChatEngineMetadata
Zusätzliche Informationen zu einer Chat-Engine. Die Felder in dieser Nachricht dienen nur der Ausgabe.
| JSON-Darstellung |
|---|
{ "dialogflowAgent": string } |
| Felder | |
|---|---|
dialogflowAgent |
Der Ressourcenname eines Dialogflow-Agenten, auf den sich diese Chat-Engine bezieht. Format: |
CommonConfig
Gängige Konfigurationen für eine Engine.
| JSON-Darstellung |
|---|
{ "companyName": string } |
| Felder | |
|---|---|
companyName |
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. |
KnowledgeGraphConfig
Konfigurationsnachricht für den Knowledge Graph.
| JSON-Darstellung |
|---|
{
"enableCloudKnowledgeGraph": boolean,
"cloudKnowledgeGraphTypes": [
string
],
"enablePrivateKnowledgeGraph": boolean,
"privateKnowledgeGraphTypes": [
string
],
"featureConfig": {
object ( |
| Felder | |
|---|---|
enableCloudKnowledgeGraph |
Gibt an, ob der Cloud Knowledge Graph für die Engine aktiviert werden soll. Wenn nicht angegeben, wird standardmäßig „false“ verwendet. |
cloudKnowledgeGraphTypes[] |
Geben Sie die zu unterstützenden Entitätstypen an. |
enablePrivateKnowledgeGraph |
Gibt an, ob der private Knowledge Graph für die Engine aktiviert werden soll. Wenn nicht angegeben, wird standardmäßig „false“ verwendet. |
privateKnowledgeGraphTypes[] |
Geben Sie die zu unterstützenden Entitätstypen an. |
featureConfig |
Optional. Feature-Konfiguration für den Knowledge Graph. |
FeatureConfig
Feature-Konfiguration für den Knowledge Graph.
| JSON-Darstellung |
|---|
{ "disablePrivateKgQueryUnderstanding": boolean, "disablePrivateKgEnrichment": boolean, "disablePrivateKgAutoComplete": boolean, "disablePrivateKgQueryUiChips": boolean } |
| Felder | |
|---|---|
disablePrivateKgQueryUnderstanding |
Gibt an, ob die Verarbeitung von Anfragen an den privaten Knowledge Graph für die Engine deaktiviert werden soll. Wenn nicht angegeben, wird standardmäßig „false“ verwendet. |
disablePrivateKgEnrichment |
Gibt an, ob die Anreicherung des privaten Knowledge Graph für die Engine deaktiviert werden soll. Wenn nicht angegeben, wird standardmäßig „false“ verwendet. |
disablePrivateKgAutoComplete |
Gibt an, ob die automatische Vervollständigung für den privaten Wissensgraphen für die Engine deaktiviert werden soll. Wenn nicht angegeben, wird standardmäßig „false“ verwendet. |
disablePrivateKgQueryUiChips |
Gibt an, ob der private Knowledge Graph für UI-Chips für Abfragen deaktiviert werden soll. Wenn nicht angegeben, wird standardmäßig „false“ verwendet. |
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 |
|
|---|---|
|
Erstellt ein Engine-Element. |
|
Löscht ein Engine-Element. |
|
Ruft einen Engine ab |
|
Ruft ein CompletionConfig ab. |
|
Workspace-Einstellungen für den Endnutzer abrufen |
|
Listet alle Engines auf, die dem Projekt zugeordnet sind. |
|
Aktualisiert eine Engine. |
|
Pausiert das Training einer vorhandenen Engine. |
|
Setzt das Training einer vorhandenen Engine fort. |
|
Optimiert eine vorhandene Engine per Tuning. |
|
Aktualisiert die CompletionConfigs |