Gemini Enterprise for Customer Experience API

サービス: ces.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストの際に次の情報を使用してください。

ディスカバリ ドキュメント

ディスカバリ ドキュメントは、REST API を記述して使用するための機械で読み取り可能仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次のディスカバリ ドキュメントが用意されています。

サービス エンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することもあります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。

  • https://ces.googleapis.com

REST リソース: v1beta.projects.locations

メソッド
get GET /v1beta/{name=projects/*/locations/*}
ロケーションに関する情報を取得します。
getSecuritySettings GET /v1beta/{name=projects/*/locations/*/securitySettings}
プロジェクトとロケーションのセキュリティ設定を取得します。
list GET /v1beta/{name=projects/*}/locations
このサービスでサポートされているロケーションに関する情報のリストを取得します。
updateSecuritySettings PATCH /v1beta/{securitySettings.name=projects/*/locations/*/securitySettings}
プロジェクトとロケーションのセキュリティ設定を更新します。

REST リソース: v1beta.projects.locations.apps

メソッド
create POST /v1beta/{parent=projects/*/locations/*}/apps
指定されたプロジェクトとロケーションに新しいアプリを作成します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*}
指定されたアプリを削除します。
executeTool POST /v1beta/{parent=projects/*/locations/*/apps/*}:executeTool
指定された引数を使用して、指定されたツールを実行します。
exportApp POST /v1beta/{name=projects/*/locations/*/apps/*}:exportApp
指定されたアプリをエクスポートします。
generateAppResource POST /v1beta/{parent=projects/*/locations/*/apps/*}:generateAppResource
特定のリソース（
get GET /v1beta/{name=projects/*/locations/*/apps/*}
指定されたアプリの詳細を取得します。
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*}/extendedAgentCard
認証されたエージェントの拡張エージェント カードを取得します。
importApp POST /v1beta/{parent=projects/*/locations/*}/apps:importApp
指定されたアプリをインポートします。
importEvaluations POST /v1beta/{parent=projects/*/locations/*/apps/*}:importEvaluations
評価をアプリにインポートします。
list GET /v1beta/{parent=projects/*/locations/*}/apps
指定されたプロジェクトとロケーションのアプリを一覧表示します。
patch PATCH /v1beta/{app.name=projects/*/locations/*/apps/*}
指定されたアプリを更新します。
retrieveToolSchema POST /v1beta/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema
指定されたツールのスキーマを取得します。
runEvaluation POST /v1beta/{app=projects/*/locations/*/apps/*}:runEvaluation
アプリの評価を実行します。
testPersonaVoice POST /v1beta/{app=projects/*/locations/*/apps/*}:testPersonaVoice
ペルソナの音声をテストします。

REST リソース: v1beta.projects.locations.apps.agents

メソッド
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/agents
指定されたアプリに新しいエージェントを作成します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/agents/*}
指定されたエージェントを削除します。
get GET /v1beta/{name=projects/*/locations/*/apps/*/agents/*}
指定されたエージェントの詳細を取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/agents
指定されたアプリ内のエージェントを一覧表示します。
patch PATCH /v1beta/{agent.name=projects/*/locations/*/apps/*/agents/*}
指定されたエージェントを更新します。

REST リソース: v1beta.projects.locations.apps.changelogs

メソッド
get GET /v1beta/{name=projects/*/locations/*/apps/*/changelogs/*}
指定された変更ログを取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/changelogs
指定したアプリの変更ログを一覧表示します。

REST リソース: v1beta.projects.locations.apps.conversations

メソッド
batchDelete POST /v1beta/{parent=projects/*/locations/*/apps/*}/conversations:batchDelete
指定された会話を一括削除します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/conversations/*}
指定された会話を削除します。
generateEvaluation POST /v1beta/{conversation=projects/*/locations/*/apps/*/conversations/*}:generateEvaluation
会話からゴールデン評価を作成します。
get GET /v1beta/{name=projects/*/locations/*/apps/*/conversations/*}
指定された会話の詳細を取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/conversations
指定されたアプリの会話を一覧表示します。

REST リソース: v1beta.projects.locations.apps.deployments

メソッド
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/deployments
指定されたアプリに新しいデプロイを作成します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/deployments/*}
指定されたデプロイを削除します。
get GET /v1beta/{name=projects/*/locations/*/apps/*/deployments/*}
指定されたデプロイの詳細を取得します。
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/extendedAgentCard
認証されたエージェントの拡張エージェント カードを取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/deployments
指定されたアプリのデプロイを一覧表示します。
patch PATCH /v1beta/{deployment.name=projects/*/locations/*/apps/*/deployments/*}
指定されたデプロイを更新します。

REST リソース: v1beta.projects.locations.apps.deployments.message

メソッド
send POST /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:send
エージェントにメッセージを送信します。
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:stream
エージェントにストリーミング メッセージを送信し、リアルタイムのやり取りとステータスの更新を可能にします。

REST リソース: v1beta.projects.locations.apps.evaluationDatasets

メソッド
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets
評価データセットを作成します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*}
評価データセットを削除します。
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*}
指定された評価データセットの詳細を取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets
指定されたアプリのすべての評価データセットを一覧表示します。
patch PATCH /v1beta/{evaluationDataset.name=projects/*/locations/*/apps/*/evaluationDatasets/*}
評価データセットを更新します。

REST リソース: v1beta.projects.locations.apps.evaluationExpectations

メソッド
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationExpectations
評価の期待値を作成します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationExpectations/*}
評価の期待値を削除します。
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationExpectations/*}
指定された評価の期待値の詳細を取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationExpectations
特定のアプリのすべての評価の期待値を一覧表示します。
patch PATCH /v1beta/{evaluationExpectation.name=projects/*/locations/*/apps/*/evaluationExpectations/*}
評価の期待値を更新します。

REST リソース: v1beta.projects.locations.apps.evaluationRuns

メソッド
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*}
評価実行を削除します。
export POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns:export
評価実行をエクスポートします。
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*}
指定された評価実行の詳細を取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns
指定されたアプリのすべての評価実行を一覧表示します。

REST リソース: v1beta.projects.locations.apps.evaluations

メソッド
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations
評価を作成します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}
評価を削除します。
export POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations:export
評価をエクスポートします。
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}
指定された評価の詳細を取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations
指定されたアプリのすべての評価を一覧表示します。
patch PATCH /v1beta/{evaluation.name=projects/*/locations/*/apps/*/evaluations/*}
評価を更新します。
uploadEvaluationAudio POST /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}:uploadEvaluationAudio
ゴールデン評価で使用する音声をアップロードします。

REST リソース: v1beta.projects.locations.apps.evaluations.results

メソッド
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
評価結果を削除します。
export POST /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results:export
評価結果をエクスポートします。
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
指定された評価結果の詳細を取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results
特定の評価のすべての評価結果を一覧表示します。
runEvaluationResultMetrics POST /v1beta/{evaluationResultId=projects/*/locations/*/apps/*/evaluations/*/results/*}:runEvaluationResultMetrics
既存の評価結果に対して指標を実行します。

REST リソース: v1beta.projects.locations.apps.examples

メソッド
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/examples
指定されたアプリに新しいサンプルを作成します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/examples/*}
指定された例を削除します。
get GET /v1beta/{name=projects/*/locations/*/apps/*/examples/*}
指定された例の詳細を取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/examples
指定されたアプリの例を一覧表示します。
patch PATCH /v1beta/{example.name=projects/*/locations/*/apps/*/examples/*}
指定された例を更新します。

REST リソース: v1beta.projects.locations.apps.guardrails

メソッド
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/guardrails
指定されたアプリに新しいガードレールを作成します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/guardrails/*}
指定されたガードレールを削除します。
get GET /v1beta/{name=projects/*/locations/*/apps/*/guardrails/*}
指定されたガードレールの詳細を取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/guardrails
指定されたアプリのガードレールを一覧表示します。
patch PATCH /v1beta/{guardrail.name=projects/*/locations/*/apps/*/guardrails/*}
指定されたガードレールを更新します。

REST リソース: v1beta.projects.locations.apps.message

メソッド
send POST /v1beta/{tenant=projects/*/locations/*/apps/*}/message:send
エージェントにメッセージを送信します。
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*}/message:stream
エージェントにストリーミング メッセージを送信し、リアルタイムのやり取りとステータスの更新を可能にします。

REST リソース: v1beta.projects.locations.apps.scheduledEvaluationRuns

メソッド
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/scheduledEvaluationRuns
スケジュールされた評価実行を作成します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
スケジュールされた評価実行を削除します。
get GET /v1beta/{name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
指定されたスケジュールされた評価実行の詳細を取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/scheduledEvaluationRuns
指定されたアプリでスケジュールされたすべての評価実行を一覧表示します。
patch PATCH /v1beta/{scheduledEvaluationRun.name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
スケジュールされた評価実行を更新します。

REST リソース: v1beta.projects.locations.apps.sessions

メソッド
generateChatToken POST /v1beta/{name=projects/*/locations/*/apps/*/sessions/*}:generateChatToken
チャット ウィジェットが Session API で認証するためのセッション スコープ トークンを生成します。
runSession POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession
セッション内で CES エージェントとの 1 回のやり取りを開始します。
streamRunSession POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:streamRunSession
CES エージェントとの単一ターンのインタラクションを開始します。

REST リソース: v1beta.projects.locations.apps.tools

メソッド
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/tools
指定されたアプリに新しいツールを作成します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/tools/*}
指定されたツールを削除します。
get GET /v1beta/{name=projects/*/locations/*/apps/*/tools/*}
指定されたツールの詳細を取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/tools
指定されたアプリのツールを一覧表示します。
patch PATCH /v1beta/{tool.name=projects/*/locations/*/apps/*/tools/*}
指定されたツールを更新します。

REST リソース: v1beta.projects.locations.apps.toolsets

メソッド
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/toolsets
指定されたアプリに新しいツールセットを作成します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/toolsets/*}
指定されたツールセットを削除します。
get GET /v1beta/{name=projects/*/locations/*/apps/*/toolsets/*}
指定されたツールセットの詳細を取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/toolsets
指定されたアプリのツールセットを一覧表示します。
patch PATCH /v1beta/{toolset.name=projects/*/locations/*/apps/*/toolsets/*}
指定されたツールセットを更新します。
retrieveTools POST /v1beta/{toolset=projects/*/locations/*/apps/*/toolsets/*}:retrieveTools
指定されたツールセットに含まれるツールのリストを取得します。

REST リソース: v1beta.projects.locations.apps.versions

メソッド
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/versions
指定されたアプリに新しいアプリ バージョンを作成します。
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/versions/*}
指定されたアプリのバージョンを削除します。
get GET /v1beta/{name=projects/*/locations/*/apps/*/versions/*}
指定されたアプリ バージョンの詳細を取得します。
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/extendedAgentCard
認証されたエージェントの拡張エージェント カードを取得します。
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/versions
指定されたアプリのすべてのアプリ バージョンを一覧表示します。
restore POST /v1beta/{name=projects/*/locations/*/apps/*/versions/*}:restore
指定されたアプリのバージョンを復元します。

REST リソース: v1beta.projects.locations.apps.versions.message

メソッド
send POST /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/message:send
エージェントにメッセージを送信します。
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/message:stream
エージェントにストリーミング メッセージを送信し、リアルタイムのやり取りとステータスの更新を可能にします。

REST リソース: v1beta.projects.locations.operations

メソッド
cancel POST /v1beta/{name=projects/*/locations/*/operations/*}:cancel
長時間実行オペレーションの非同期キャンセルを開始します。
delete DELETE /v1beta/{name=projects/*/locations/*/operations/*}
長時間実行オペレーションを削除します。
get GET /v1beta/{name=projects/*/locations/*/operations/*}
長時間実行オペレーションの最新状態を取得します。
list GET /v1beta/{name=projects/*/locations/*}/operations
リクエスト内の指定したフィルタに一致するオペレーションを一覧表示します。