REST Resource: projects.locations.collections.engines

リソース: Engine

Engine のトレーニング パラメータとサービング パラメータを記述するメタデータ。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "dataStoreIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "industryVertical": enum (IndustryVertical),
  "commonConfig": {
    object (CommonConfig)
  },
  "knowledgeGraphConfig": {
    object (KnowledgeGraphConfig)
  },
  "appType": enum (AppType),
  "disableAnalytics": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "cmekConfig": {
    object (CmekConfig)
  },
  "configurableBillingApproach": enum (ConfigurableBillingApproach),
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },
  "observabilityConfig": {
    object (ObservabilityConfig)
  },
  "connectorTenantInfo": {
    string: string,
    ...
  },
  "agentGatewaySetting": {
    object (AgentGatewaySetting)
  },
  "marketplaceAgentVisibility": enum (MarketplaceAgentVisibility),
  "procurementContactEmails": [
    string
  ],

  // 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.
}
フィールド
name

string

変更不可。ID。エンジンの完全修飾リソース名です。

このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。

形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}。エンジンは 1～63 文字で指定する必要があり、有効な文字は /[a-z0-9][a-z0-9-_]*/ です。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
displayName

string

必須。エンジンの表示名。人が読める形式にする必要があります。上限が 1,024 文字の UTF-8 でエンコードされた文字列です。
createTime

string (Timestamp format)

出力専用。レコメンデーション エンジンの作成時のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。レコメンデーション エンジンが最後に更新されたときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
dataStoreIds[]

string

省略可。このエンジンに関連付けられているデータストア。

SOLUTION_TYPE_SEARCH タイプと SOLUTION_TYPE_RECOMMENDATION タイプのエンジンは、最大で 1 つのデータストアにのみ関連付けることができます。

solutionType が SOLUTION_TYPE_CHAT の場合、同じ Collection 内の複数の DataStore をここに関連付けることができます。

CreateEngineRequest で使用する場合、システムが初期化に必要な処理で使用するため、DataStore ID を 1 つ指定する必要があります。
solutionType

enum (SolutionType)

必須。エンジンのソリューション。
industryVertical

enum (IndustryVertical)

省略可。エンジンが登録する業種を指定します。エンジンの業種の制限は DataStore に基づいており、エンジンの業種は、そのエンジンにリンクされた DataStore の業種と一致している必要があります。
commonConfig

object (CommonConfig)

エンジンのメタデータを指定する共通構成仕様。
knowledgeGraphConfig

object (KnowledgeGraphConfig)

省略可。ナレッジグラフの構成。solutionType が SOLUTION_TYPE_SEARCH の場合にのみ適用されます。
appType

enum (AppType)

省略可。変更不可。このエンジン リソースが表すアプリケーション タイプ。注: これは、既存の業界の業種やソリューション タイプとは無関係の新しいコンセプトです。
disableAnalytics

boolean

省略可。このエンジンで行われた検索に対して、アナリティクスを無効にするかどうかを指定します。
features

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

省略可。エンジンが機能をオプトインまたはオプトアウトするための機能構成。サポートされているキー:

  • *: すべての機能。この値が存在する場合、他のすべての機能の状態設定は無視されます。
  • 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
  • personalization-suggested-highlights
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • disable-canvas-workspace
  • disable-skills
cmekConfig

object (CmekConfig)

出力専用。Engine の CMEK 関連情報。
configurableBillingApproach

enum (ConfigurableBillingApproach)

省略可。構成可能な課金アプローチの構成。
modelConfigs

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

省略可。モデル名をこのエンジンの特定の構成にマッピングします。これにより、管理者ユーザーは個々のモデルのオン/オフを切り替えることが可能です。こうして、管理者が状態をオーバーライドしたモデルのみが保存されます。

状態が指定されていない場合、またはこのモデルの modelConfigs が空の場合、システムはデフォルトの構成に基づいて、このモデルを使用可能にするかどうかを決定します。たとえば、管理者がプレビュー モデルを有効にしない場合、プレビュー モデルはデフォルトで無効になります。
observabilityConfig

object (ObservabilityConfig)

省略可。エンジンのオブザーバビリティ構成。
connectorTenantInfo

map (key: string, value: string)

省略可。コネクタ ID（「hybrid-github」、「shopify」など）を、そのコネクタに必要なテナント固有の情報にマッピングします。テナント情報文字列の構造はコネクタによって異なります。
agentGatewaySetting

object (AgentGatewaySetting)

省略可。エンジンのエージェント ゲートウェイ設定。
marketplaceAgentVisibility

enum (MarketplaceAgentVisibility)

省略可。エージェント ギャラリーでの Marketplace エージェントの公開設定。
procurementContactEmails[]

string

省略可。調達担当者のメールアドレス。
共用体フィールド engine_config。エンジンの動作を定義する追加の構成仕様。engine_config は次のいずれかになります。
chatEngineConfig

object (ChatEngineConfig)

チャット エンジンの構成。solutionType が SOLUTION_TYPE_CHAT の場合にのみ適用されます。
searchEngineConfig

object (SearchEngineConfig)

検索エンジンの構成。solutionType が SOLUTION_TYPE_SEARCH の場合にのみ適用されます。
mediaRecommendationEngineConfig

object (MediaRecommendationEngineConfig)

メディア エンジンの構成。solutionType、SOLUTION_TYPE_RECOMMENDATION、IndustryVertical.MEDIA の業種を含むデータストアにのみ適用されます。
共用体フィールド engine_metadata。エンジンのステータスをモニタリングするエンジン メタデータ。engine_metadata は次のいずれかになります。
chatEngineMetadata

object (ChatEngineMetadata)

出力専用。チャット エンジンの追加情報。solutionType が SOLUTION_TYPE_CHAT の場合にのみ適用されます。

ChatEngineConfig

チャット エンジンの構成。

JSON 表現 
{
  "agentCreationConfig": {
    object (AgentCreationConfig)
  },
  "dialogflowAgentToLink": string,
  "allowCrossRegion": boolean
}
フィールド
agentCreationConfig

object (AgentCreationConfig)

この構成により、このエンジンに関連付けられた Dialogflow エージェントが生成されます。

これらの構成は、Dialogflow サービスによって 1 回だけ使用され、渡されます。つまり、エンジン作成後に EngineService.GetEngine API または EngineService.ListEngines API を使用して取得することはできません。
allowCrossRegion

boolean

省略可。フラグが true に設定されている場合、エージェントとエンジンが異なる場所にあることが許可されます。それ以外の場合、エージェントとエンジンは同じ場所にある必要があります。このフラグはデフォルトで false に設定されています。

allowCrossRegion は 1 回だけ使用され、EngineService.CreateEngine に渡されます。つまり、エンジン作成後に EngineService.GetEngine API または EngineService.ListEngines API を使用して取得することはできません。

AgentCreationConfig

Dialogflow エージェントを生成するための構成。

これらの構成は、Dialogflow サービスによって 1 回だけ使用され、渡されます。つまり、エンジン作成後に EngineService.GetEngine API または EngineService.ListEngines API を使用して取得することはできません。

JSON 表現 
{
  "business": string,
  "defaultLanguageCode": string,
  "timeZone": string,
  "location": string
}
フィールド
business

string

エージェントが代理人を務める会社、組織、その他の団体の名前。ナレッジ コネクタの LLM プロンプトとナレッジ検索に使用されます。
defaultLanguageCode

string

必須。エージェントのデフォルト言語。言語タグとして使用されます。現在サポートされている言語コードのリストについては、言語のサポートをご覧ください。
timeZone

string

必須。タイムゾーン データベースにあるエージェントのタイムゾーン（例: America/New_York、Europe/Paris）。
location

string

エージェントを作成する際のロケーション。サポートされている値は global、us、eu です。指定しない場合、US エンジンではデフォルトで us-central-1 にエージェントが作成され、EU エンジンではデフォルトで eu-west-1 にエージェントが作成されます。

SearchEngineConfig

検索エンジンの構成。

JSON 表現 
{
  "searchTier": enum (SearchTier),
  "requiredSubscriptionTier": enum (SubscriptionTier),
  "searchAddOns": [
    enum (SearchAddOn)
  ]
}
フィールド
searchTier

enum (SearchTier)

このエンジンの検索機能のティア。

ティアによって料金が異なる場合があります。詳細については、料金に関するドキュメントをご覧ください。

指定しない場合のデフォルトは SearchTier.SEARCH_TIER_STANDARD です。
requiredSubscriptionTier

enum (SubscriptionTier)

省略可。このエンジンの必要なサブスクリプション ティア。

エンジンの作成後に変更することはできません。必要なサブスクリプション ティアが検索の場合、アシストなどの上位のライセンス ティアを持つユーザーも、このエンジンに関連付けられたスタンドアロン アプリにアクセスできます。
searchAddOns[]

enum (SearchAddOn)

この検索エンジンが有効にするアドオン。

SearchTier

検索機能のティア。ティアによって料金が異なる場合があります。詳細については、料金に関するドキュメントをご覧ください。

列挙型
SEARCH_TIER_UNSPECIFIED 列挙型が指定されていない場合のデフォルト値。これは使用できません。
SEARCH_TIER_STANDARD スタンダード ティア。
SEARCH_TIER_ENTERPRISE エンタープライズ階層。

SearchAddOn

検索に追加機能を提供するアドオン。

列挙型
SEARCH_ADD_ON_UNSPECIFIED 列挙型が指定されていない場合のデフォルト値。これは使用できません。
SEARCH_ADD_ON_LLM 大規模言語モデルアドオン。

MediaRecommendationEngineConfig

メディア レコメンデーション エンジンの追加の構成仕様。

JSON 表現 
{
  "type": string,
  "optimizationObjective": string,
  "optimizationObjectiveConfig": {
    object (OptimizationObjectiveConfig)
  },
  "trainingState": enum (TrainingState),
  "engineFeaturesConfig": {
    object (EngineFeaturesConfig)
  }
}
フィールド
type

string

必須。エンジンの種類。例: recommended-for-you。

このフィールドは optimizationObjective とともに、エンジンのトレーニングとサービングの制御に使用するエンジン メタデータを記述します。

現在サポートされている値は、recommended-for-you、others-you-may-like、more-like-this、most-popular-items です。
optimizationObjective

string

最適化の目標。例: cvr。

このフィールドは optimizationObjective とともに、エンジンのトレーニングとサービングの制御に使用するエンジン メタデータを記述します。

現在サポートされている値は、ctr、cvr です。

指定されていない場合は、エンジンタイプに基づいてデフォルトが選択されます。デフォルトは推奨事項のタイプによって異なります。

recommended-for-you => ctr

others-you-may-like => ctr
optimizationObjectiveConfig

object (OptimizationObjectiveConfig)

コンバージョン率の最適化目標（optimizationObjective）に対するカスタムしきい値の名前と値。targetField watch-time の場合、target_field_value は、メディアの進行状況の時間を秒単位で示す整数値（0, 86400]（0 は除外、86400 は含む）にする必要があります（例: 90）。targetField watch-percentage の場合、target_field_value は (0, 1.0]（0 は除外、1.0 は含む）の範囲内の有効な浮動小数点値にする必要があります（例: 0.5）。
trainingState

enum (TrainingState)

エンジンのトレーニング状態（TRAINING、PAUSED など）。

サービスを運用するコストの一部はトレーニングの頻度によって決まるため、コストを管理する目的で、エンジンをいつトレーニングするかをこの設定で決めることができます。指定しない場合: engines.create メソッドのデフォルト値は TRAINING です。engines.patch メソッドのデフォルト値は、状態を以前と同じに保つことです。
engineFeaturesConfig

object (EngineFeaturesConfig)

省略可。追加のエンジン機能の構成。

OptimizationObjectiveConfig

cvr optimizationObjective のカスタムしきい値。

JSON 表現 
{
  "targetField": string,
  "targetFieldValueFloat": number
}
フィールド
targetField

string

必須。ターゲットとするフィールドの名前です。現在サポートされている値は、watch-percentage、watch-time です。
targetFieldValueFloat

number

必須。ターゲットに適用するしきい値（例: 0.5）。

TrainingState

エンジンのトレーニング状態。

列挙型
TRAINING_STATE_UNSPECIFIED トレーニングの状態が指定されていません。
PAUSED エンジンのトレーニングが一時停止しています。
TRAINING エンジンはトレーニング中です。

EngineFeaturesConfig

選択したエンジンタイプの追加機能構成。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド type_dedicated_config。特定のタイプのメディア レコメンデーション エンジンに適用される機能関連の構成。type_dedicated_config は次のいずれかになります。
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

推奨されるエンジン機能構成。

RecommendedForYouFeatureConfig

recommended-for-you エンジンを作成するための追加の機能構成。

JSON 表現 
{
  "contextEventType": string
}
フィールド
contextEventType

string

予測時にエンジンがクエリされるイベントのタイプ。generic に設定した場合、エンジン トレーニングで context-event として使用されるのは view-item、media-play、media-complete のみです。view-home-page に設定すると、view-item、media-play、media-complete に加えて、context-events としても view-home-page が使用されます。現在、recommended-for-you エンジンでサポートされています。現在サポートされている値は、view-home-page、generic です。

MostPopularFeatureConfig

最も人気のあるエンジンを作成するために必要な機能構成。

JSON 表現 
{
  "timeWindowDays": string
}
フィールド
timeWindowDays

string (int64 format)

トレーニング時と予測時にエンジンがクエリされる時間枠。正の整数のみ。この値は、イベントの過去 X 日間に変換されます。現在、most-popular-items エンジンに必要です。

ChatEngineMetadata

チャット エンジンの追加情報。このメッセージのフィールドは出力専用です。

JSON 表現 
{
  "dialogflowAgent": string
}
フィールド
dialogflowAgent

string

このチャット エンジンが参照する Dialogflow エージェントのリソース名。

形式: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>

CommonConfig

エンジンの一般的な構成。

JSON 表現 
{
  "companyName": string
}
フィールド
companyName

string

エンジンに関連付けられている会社、ビジネス、またはエンティティの名前。この設定を行うと、LLM 関連機能の改善に役立つことがあります。

KnowledgeGraphConfig

ナレッジグラフの構成メッセージ。

JSON 表現 
{
  "enableCloudKnowledgeGraph": boolean,
  "cloudKnowledgeGraphTypes": [
    string
  ],
  "enablePrivateKnowledgeGraph": boolean,
  "privateKnowledgeGraphTypes": [
    string
  ],
  "featureConfig": {
    object (FeatureConfig)
  }
}
フィールド
enableCloudKnowledgeGraph

boolean

エンジンで Cloud ナレッジグラフを有効にするかどうか。

指定しない場合は、デフォルトで false になります。
cloudKnowledgeGraphTypes[]

string

サポートするエンティティ タイプを指定します。
enablePrivateKnowledgeGraph

boolean

エンジンで非公開ナレッジグラフを有効にするかどうか。

指定しない場合は、デフォルトで false になります。
privateKnowledgeGraphTypes[]

string

サポートするエンティティ タイプを指定します。
featureConfig

object (FeatureConfig)

省略可。ナレッジグラフの機能構成。

FeatureConfig

ナレッジグラフの機能構成。

JSON 表現 
{
  "disablePrivateKgQueryUnderstanding": boolean,
  "disablePrivateKgEnrichment": boolean,
  "disablePrivateKgAutoComplete": boolean,
  "disablePrivateKgQueryUiChips": boolean
}
フィールド
disablePrivateKgQueryUnderstanding

boolean

エンジンの非公開 KG クエリの理解を無効にするかどうか。

指定しない場合は、デフォルトで false になります。
disablePrivateKgEnrichment

boolean

エンジンのプライベート KG 拡充を無効にするかどうか。

指定しない場合は、デフォルトで false になります。
disablePrivateKgAutoComplete

boolean

エンジンのプライベート KG の自動補完を無効にするかどうか。

指定しない場合は、デフォルトで false になります。
disablePrivateKgQueryUiChips

boolean

クエリ UI チップの非公開 KG を無効にするかどうか。

指定しない場合は、デフォルトで false になります。

AppType

エンジンのアプリ。

列挙型
APP_TYPE_UNSPECIFIED 指定されていないすべてのアプリ。
APP_TYPE_INTRANET イントラネット検索と Agentspace のアプリタイプ。

FeatureState

エンジンの機能の状態。

列挙型
FEATURE_STATE_UNSPECIFIED 機能の状態が指定されていません。
FEATURE_STATE_ON この機能は、アクセスできるようにオンになっています。
FEATURE_STATE_OFF この機能はオフになっており、アクセスできません。

ConfigurableBillingApproach

構成可能な課金アプローチの構成。

列挙型
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED デフォルト値。Spark と Spark 以外の構成不可の課金アプローチに使用します。 一般的な料金モデル。
CONFIGURABLE_BILLING_APPROACH_ENABLED 課金はお客様が指定した構成に沿って行われます。

ModelState

エンジンのモデルのステータス。

列挙型
MODEL_STATE_UNSPECIFIED モデルの状態が指定されていません。
MODEL_ENABLED モデルは管理者によって有効になっています。
MODEL_DISABLED モデルは管理者によって無効になっています。

ObservabilityConfig

リソースのオブザーバビリティ構成。

JSON 表現 
{
  "observabilityEnabled": boolean,
  "sensitiveLoggingEnabled": boolean
}
フィールド
observabilityEnabled

boolean

省略可。オブザーバビリティを有効にします。false の場合、他のすべてのフラグは無視されます。
sensitiveLoggingEnabled

boolean

省略可。機密情報のロギングを有効にします。機密情報のロギングには、お客様のコアコンテンツ（プロンプト、レスポンスなど）が含まれます。false の場合、すべての機密フィールドがサニタイズされます。

AgentGatewaySetting

Agent Gateway の設定。Gemini Enterprise エージェントから Gemini Enterprise の外部のエージェントやツールへの下り（外向き）を制御するために、Gemini Enterprise リソースに適用される場合があります。

JSON 表現 
{
  "defaultEgressAgentGateway": {
    object (AgentGatewayReference)
  }
}
フィールド
defaultEgressAgentGateway

object (AgentGatewayReference)

省略可。この設定が Gemini Enterprise リソースに適用されたときに使用するデフォルトの下り（外向き）エージェント ゲートウェイ。

デプロイ モードは GOOGLE_MANAGED に、ガバナンス対象のアクセスパスは AGENT_TO_ANYWHERE にする必要があります。

AgentGatewayReference

エージェント ゲートウェイ リソースへの参照。

JSON 表現 
{
  "name": string
}
フィールド
name

string

必須。変更不可。エージェント ゲートウェイのリソース名。

適切な形式: projects/{projectNumber}/locations/{location}/agentGateways/{agent_gateway}。

MarketplaceAgentVisibility

エージェント ギャラリーでどの Marketplace エージェントがすべてのユーザーに表示されるかを表します。

列挙型
MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED デフォルトは MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED です。
SHOW_AVAILABLE_AGENTS_ONLY ユーザーが現在使用できるエージェントのみが表示されます。
SHOW_AGENTS_ALREADY_INTEGRATED ユーザーがまだアクセス権を持っていないが、エンジンに統合されているマーケットプレイス エージェントを表示します。このレベルには、SHOW_AVAILABLE_AGENTS_ONLY で表示されるすべてのエージェントも含まれます。
SHOW_AGENTS_ALREADY_PURCHASED SHOW_AGENTS_ALREADY_INTEGRATED で表示されるすべてのエージェントと、プロジェクト/組織ですでに購入済みのエージェント（現在エンジンに統合されていない場合でも）を表示します。
SHOW_ALL_AGENTS アクセス ステータスや購入ステータスに関係なく、マーケットプレイス内のすべてのエージェントが表示されます。このレベルには、前のレベルで示されたすべてのエージェントが含まれます。

メソッド

create

 Engine を作成します。

delete

 Engine を削除します。

get

 Engine を取得します。

getIamPolicy

 Engine の IAM アクセス制御ポリシーを取得します。

list

 プロジェクトに関連付けられているすべての Engine を一覧表示します。

patch

 Engine を更新します。

pause

 既存の Engine のトレーニングを一時停止します。

resume

 既存の Engine のトレーニングを再開します。

setIamPolicy

 Engine の IAM アクセス制御ポリシーを設定します。

tune

 既存の Engine を調整します。