REST Resource: projects.locations.collections.engines

Ressource: Engine

Metadaten, die die Trainings- und Bereitstellungsparameter eines 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),
    ...
  },
  "configurableBillingApproach": enum (ConfigurableBillingApproach),

  // 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 vollständig 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–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. UTF-8-codierter String mit einem Limit von 1.024 Zeichen.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung der Recommendation Engine.

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 letzten Aktualisierung der Recommendation Engine.

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

string

Optional. Die mit dieser Engine verknüpften Datenspeicher.

Für Engines vom Typ SOLUTION_TYPE_SEARCH und SOLUTION_TYPE_RECOMMENDATION kann maximal ein Datenspeicher zugeordnet werden.

Wenn solutionType gleich SOLUTION_TYPE_CHAT ist, können hier mehrere DataStores im selben Collection verknüpft werden.

Wenn das Feld in CreateEngineRequest verwendet wird, 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, die von der Engine registriert wird. Die Einschränkung der Branche „Engine“ 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 bestehenden 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 dieser Wert 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
configurableBillingApproach

enum (ConfigurableBillingApproach)

Optional. Konfiguration für den konfigurierbaren Abrechnungsansatz.
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, wenn solutionType SOLUTION_TYPE_CHAT ist.
searchEngineConfig

object (SearchEngineConfig)

Konfigurationen für die Suchmaschine. Gilt nur, wenn solutionType SOLUTION_TYPE_SEARCH ist.
mediaRecommendationEngineConfig

object (MediaRecommendationEngineConfig)

Konfigurationen für die Media Engine. Gilt nur für die Datenspeicher mit den Branchen solutionType SOLUTION_TYPE_RECOMMENDATION und 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, wenn solutionType SOLUTION_TYPE_CHAT ist.

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-Agents, 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, können sich der 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.

Die allowCrossRegion werden 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 können.

AgentCreationConfig

Konfigurationen zum Generieren eines Dialogflow-Agents.

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 des Rechtssubjekts, das der Vertreter vertritt. Wird für den LLM-Prompt des Wissensconnectors und für die Wissenssuche verwendet.
defaultLanguageCode

string

Erforderlich. Die Standardsprache des Agents als Sprachtag. Unter Sprachunterstützung finden Sie eine Liste der aktuell unterstützten Sprachcodes.
timeZone

string

Erforderlich. Die Zeitzone des Agents aus der Zeitzonendatenbank, z. B. Amerika/New_York, Europa/Paris.
location

string

Agent-Standort für die Agent-Erstellung. Unterstützte Werte: global/us/eu. Wenn nicht angegeben, wird der 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 Stufe der Suchfunktion dieser Engine.

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

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 Dokumentation zur Preisgestaltung.

Enums
SEARCH_TIER_UNSPECIFIED Standardwert, wenn die Enumeration nicht 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 die Enumeration nicht angegeben ist. Diese Option ist ungültig.
SEARCH_ADD_ON_LLM Add-on für Large Language Models

MediaRecommendationEngineConfig

Zusätzliche Konfigurationsspezifikationen für eine Media Recommendation Engine.

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

string

Erforderlich. Der Motortyp, z. B. 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, most-popular-items.
optimizationObjective

string

Das Optimierungsziel, z. B. 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, cvr.

Wenn nicht angegeben, wird je nach Engine-Typ ein Standardwert 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 für die Zielvorhaben-CVR-Optimierung. Für targetField watch-time muss target_field_value ein ganzzahliger Wert sein, der die Media-Fortschrittszeit in Sekunden zwischen (0, 86400] angibt (0 wird ausgeschlossen, 86400 wird eingeschlossen). Beispiel: 90). Für targetField watch-percentage muss target_field_value ein gültiger Gleitkommawert zwischen (0, 1.0] sein (0 wird ausgeschlossen, 1.0 wird eingeschlossen) (z.B. 0,5).
trainingState

enum (TrainingState)

Der Trainingsstatus der Engine, z.B. TRAINING oder PAUSED.

Da ein Teil der Kosten für den Betrieb des Dienstes von der Häufigkeit des Trainings abhängt, kann dies verwendet werden, um zu bestimmen, wann die Engine trainiert werden soll, um die Kosten zu kontrollieren. Wenn keine Angabe erfolgt, ist der Standardwert für die engines.create-Methode TRAINING. Der Standardwert für die engines.patch-Methode ist, den Status beizubehalten.
engineFeaturesConfig

object (EngineFeaturesConfig)

Optional. Konfiguration zusätzlicher Engine-Funktionen.

OptimizationObjectiveConfig

Benutzerdefinierte Untergrenze für das cvr-Optimierungszielvorhaben.

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

string

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

number

Erforderlich. Der Schwellenwert, der auf das Ziel angewendet werden soll (z.B. 0,5).

TrainingState

Der Trainingsstatus der Engine.

Enums
TRAINING_STATE_UNSPECIFIED Nicht angegebener Trainingsstatus.
PAUSED Das Training der Engine wurde pausiert.
TRAINING Die Engine wird trainiert.

EngineFeaturesConfig

Weitere Featurekonfigurationen 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. Konfigurationen für Funktionen, die auf einen bestimmten Typ von Media-Empfehlungs-Engines angewendet werden. Für type_dedicated_config ist nur einer der folgenden Werte zulässig:
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

Für die Konfiguration der Engine-Funktion empfohlen.

RecommendedForYouFeatureConfig

Zusätzliche Konfigurationen für die Erstellung 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 diese Option auf generic gesetzt 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 auch als context-events verwendet. Wird derzeit für die recommended-for-you-Engine unterstützt. Derzeit unterstützte Werte: view-home-page, generic.

MostPopularFeatureConfig

Funktionskonfigurationen, die zum Erstellen einer Engine vom Typ „Am beliebtesten“ 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. Felder in dieser Nachricht dienen nur der Ausgabe.

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

string

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

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

CommonConfig

Häufige Konfigurationen für eine Engine.

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

string

Der Name des Unternehmens, des Betriebs oder der Rechtspersönlichkeit, die mit der Engine verknüpft ist. Wenn Sie dies festlegen, können Sie die LLM-bezogenen Funktionen möglicherweise verbessern.

AppType

Die App der Engine.

Enums
APP_TYPE_UNSPECIFIED Alle nicht angegebenen Apps.
APP_TYPE_INTRANET App-Typ für die Intranetsuche und Agentspace.

FeatureState

Der Status des Features für die Engine.

Enums
FEATURE_STATE_UNSPECIFIED Der Funktionsstatus 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.

Methoden

create

 Erstellt einen Engine.

delete

 Löscht ein Engine.

get

 Erstellt einen Engine.

list

 Listet alle Engine auf, die dem Projekt zugeordnet sind.

patch

 Aktualisiert eine Engine