- REST リソース: tasks
- REST リソース: tasks.pushNotificationConfigs
- REST リソース: v1.projects.locations
- REST リソース: v1.projects.locations.apps
- REST リソース: v1.projects.locations.apps.agents
- REST リソース: v1.projects.locations.apps.changelogs
- REST リソース: v1.projects.locations.apps.conversations
- REST リソース: v1.projects.locations.apps.deployments
- REST リソース: v1.projects.locations.apps.deployments.message
- REST リソース: v1.projects.locations.apps.examples
- REST リソース: v1.projects.locations.apps.guardrails
- REST リソース: v1.projects.locations.apps.message
- REST リソース: v1.projects.locations.apps.sessions
- REST リソース: v1.projects.locations.apps.tools
- REST リソース: v1.projects.locations.apps.toolsets
- REST リソース: v1.projects.locations.apps.versions
- REST リソース: v1.projects.locations.apps.versions.message
- REST リソース: v1.projects.locations.operations
サービス: ces.googleapis.com
このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストの際に次の情報を使用してください。
ディスカバリ ドキュメント
ディスカバリ ドキュメントは、REST API を記述して使用するための機械で読み取り可能仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次のディスカバリ ドキュメントが用意されています。
サービス エンドポイント
サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することもあります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。
https://ces.googleapis.com
REST リソース: tasks
| メソッド | |
|---|---|
cancel |
POST /tasks/{id}:cancel 進行中のタスクをキャンセルします。 |
get |
GET /tasks/{id} タスクの最新の状態を取得します。 |
list |
GET /tasks 指定されたフィルタに一致するタスクを一覧表示します。 |
subscribe |
GET /tasks/{id}:subscribe 終了状態ではないタスクのタスク更新をサブスクライブします。 |
REST リソース: tasks.pushNotificationConfigs
| メソッド | |
|---|---|
create |
POST /tasks/{taskId}/pushNotificationConfigs タスクのプッシュ通知構成を作成します。 |
delete |
DELETE /tasks/{taskId}/pushNotificationConfigs/{id} タスクのプッシュ通知構成を削除します。 |
get |
GET /tasks/{taskId}/pushNotificationConfigs/{id} タスクのプッシュ通知構成を取得します。 |
list |
GET /tasks/{taskId}/pushNotificationConfigs タスクに設定されたプッシュ通知のリストを取得します。 |
REST リソース: v1.projects.locations
| メソッド | |
|---|---|
get |
GET /v1/{name=projects/*/locations/*} ロケーションに関する情報を取得します。 |
list |
GET /v1/{name=projects/*}/locations このサービスでサポートされているロケーションに関する情報のリストを取得します。 |
REST リソース: v1.projects.locations.apps
| メソッド | |
|---|---|
create |
POST /v1/{parent=projects/*/locations/*}/apps 指定されたプロジェクトとロケーションに新しいアプリを作成します。 |
delete |
DELETE /v1/{name=projects/*/locations/*/apps/*} 指定されたアプリを削除します。 |
executeTool |
POST /v1/{parent=projects/*/locations/*/apps/*}:executeTool 指定された引数を使用して、指定されたツールを実行します。 |
exportApp |
POST /v1/{name=projects/*/locations/*/apps/*}:exportApp 指定されたアプリをエクスポートします。 |
get |
GET /v1/{name=projects/*/locations/*/apps/*} 指定されたアプリの詳細を取得します。 |
getExtendedAgentCard |
GET /v1/{tenant=projects/*/locations/*/apps/*}/extendedAgentCard 認証されたエージェントの拡張エージェント カードを取得します。 |
importApp |
POST /v1/{parent=projects/*/locations/*}/apps:importApp 指定されたアプリをインポートします。 |
list |
GET /v1/{parent=projects/*/locations/*}/apps 指定されたプロジェクトとロケーションのアプリを一覧表示します。 |
patch |
PATCH /v1/{app.name=projects/*/locations/*/apps/*} 指定されたアプリを更新します。 |
retrieveToolSchema |
POST /v1/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema 指定されたツールのスキーマを取得します。 |
REST リソース: v1.projects.locations.apps.agents
| メソッド | |
|---|---|
create |
POST /v1/{parent=projects/*/locations/*/apps/*}/agents 指定されたアプリに新しいエージェントを作成します。 |
delete |
DELETE /v1/{name=projects/*/locations/*/apps/*/agents/*} 指定されたエージェントを削除します。 |
get |
GET /v1/{name=projects/*/locations/*/apps/*/agents/*} 指定されたエージェントの詳細を取得します。 |
list |
GET /v1/{parent=projects/*/locations/*/apps/*}/agents 指定されたアプリ内のエージェントを一覧表示します。 |
patch |
PATCH /v1/{agent.name=projects/*/locations/*/apps/*/agents/*} 指定されたエージェントを更新します。 |
REST リソース: v1.projects.locations.apps.changelogs
| メソッド | |
|---|---|
get |
GET /v1/{name=projects/*/locations/*/apps/*/changelogs/*} 指定された変更ログを取得します。 |
list |
GET /v1/{parent=projects/*/locations/*/apps/*}/changelogs 指定したアプリの変更ログを一覧表示します。 |
REST リソース: v1.projects.locations.apps.conversations
| メソッド | |
|---|---|
batchDelete |
POST /v1/{parent=projects/*/locations/*/apps/*}/conversations:batchDelete 指定された会話を一括削除します。 |
delete |
DELETE /v1/{name=projects/*/locations/*/apps/*/conversations/*} 指定された会話を削除します。 |
get |
GET /v1/{name=projects/*/locations/*/apps/*/conversations/*} 指定された会話の詳細を取得します。 |
list |
GET /v1/{parent=projects/*/locations/*/apps/*}/conversations 指定されたアプリの会話を一覧表示します。 |
REST リソース: v1.projects.locations.apps.deployments
| メソッド | |
|---|---|
create |
POST /v1/{parent=projects/*/locations/*/apps/*}/deployments 指定されたアプリに新しいデプロイを作成します。 |
delete |
DELETE /v1/{name=projects/*/locations/*/apps/*/deployments/*} 指定されたデプロイを削除します。 |
get |
GET /v1/{name=projects/*/locations/*/apps/*/deployments/*} 指定されたデプロイの詳細を取得します。 |
getExtendedAgentCard |
GET /v1/{tenant=projects/*/locations/*/apps/*/deployments/*}/extendedAgentCard 認証されたエージェントの拡張エージェント カードを取得します。 |
list |
GET /v1/{parent=projects/*/locations/*/apps/*}/deployments 指定されたアプリのデプロイを一覧表示します。 |
patch |
PATCH /v1/{deployment.name=projects/*/locations/*/apps/*/deployments/*} 指定されたデプロイを更新します。 |
REST リソース: v1.projects.locations.apps.deployments.message
| メソッド | |
|---|---|
send |
POST /v1/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:send エージェントにメッセージを送信します。 |
stream |
POST /v1/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:stream エージェントにストリーミング メッセージを送信し、リアルタイムのやり取りとステータスの更新を可能にします。 |
REST リソース: v1.projects.locations.apps.examples
| メソッド | |
|---|---|
create |
POST /v1/{parent=projects/*/locations/*/apps/*}/examples 指定されたアプリに新しいサンプルを作成します。 |
delete |
DELETE /v1/{name=projects/*/locations/*/apps/*/examples/*} 指定された例を削除します。 |
get |
GET /v1/{name=projects/*/locations/*/apps/*/examples/*} 指定された例の詳細を取得します。 |
list |
GET /v1/{parent=projects/*/locations/*/apps/*}/examples 指定されたアプリの例を一覧表示します。 |
patch |
PATCH /v1/{example.name=projects/*/locations/*/apps/*/examples/*} 指定された例を更新します。 |
REST リソース: v1.projects.locations.apps.guardrails
| メソッド | |
|---|---|
create |
POST /v1/{parent=projects/*/locations/*/apps/*}/guardrails 指定されたアプリに新しいガードレールを作成します。 |
delete |
DELETE /v1/{name=projects/*/locations/*/apps/*/guardrails/*} 指定されたガードレールを削除します。 |
get |
GET /v1/{name=projects/*/locations/*/apps/*/guardrails/*} 指定されたガードレールの詳細を取得します。 |
list |
GET /v1/{parent=projects/*/locations/*/apps/*}/guardrails 指定されたアプリのガードレールを一覧表示します。 |
patch |
PATCH /v1/{guardrail.name=projects/*/locations/*/apps/*/guardrails/*} 指定されたガードレールを更新します。 |
REST リソース: v1.projects.locations.apps.message
| メソッド | |
|---|---|
send |
POST /v1/{tenant=projects/*/locations/*/apps/*}/message:send エージェントにメッセージを送信します。 |
stream |
POST /v1/{tenant=projects/*/locations/*/apps/*}/message:stream エージェントにストリーミング メッセージを送信し、リアルタイムのやり取りとステータスの更新を可能にします。 |
REST リソース: v1.projects.locations.apps.sessions
| メソッド | |
|---|---|
generateChatToken |
POST /v1/{name=projects/*/locations/*/apps/*/sessions/*}:generateChatToken チャット ウィジェットが Session API で認証するためのセッション スコープ トークンを生成します。 |
runSession |
POST /v1/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession セッション内で CES エージェントとの 1 回のやり取りを開始します。 |
streamRunSession |
POST /v1/{config.session=projects/*/locations/*/apps/*/sessions/*}:streamRunSession CES エージェントとの単一ターンのインタラクションを開始します。 |
REST リソース: v1.projects.locations.apps.tools
| メソッド | |
|---|---|
create |
POST /v1/{parent=projects/*/locations/*/apps/*}/tools 指定されたアプリに新しいツールを作成します。 |
delete |
DELETE /v1/{name=projects/*/locations/*/apps/*/tools/*} 指定されたツールを削除します。 |
get |
GET /v1/{name=projects/*/locations/*/apps/*/tools/*} 指定されたツールの詳細を取得します。 |
list |
GET /v1/{parent=projects/*/locations/*/apps/*}/tools 指定されたアプリのツールを一覧表示します。 |
patch |
PATCH /v1/{tool.name=projects/*/locations/*/apps/*/tools/*} 指定されたツールを更新します。 |
REST リソース: v1.projects.locations.apps.toolsets
| メソッド | |
|---|---|
create |
POST /v1/{parent=projects/*/locations/*/apps/*}/toolsets 指定されたアプリに新しいツールセットを作成します。 |
delete |
DELETE /v1/{name=projects/*/locations/*/apps/*/toolsets/*} 指定されたツールセットを削除します。 |
get |
GET /v1/{name=projects/*/locations/*/apps/*/toolsets/*} 指定されたツールセットの詳細を取得します。 |
list |
GET /v1/{parent=projects/*/locations/*/apps/*}/toolsets 指定されたアプリのツールセットを一覧表示します。 |
patch |
PATCH /v1/{toolset.name=projects/*/locations/*/apps/*/toolsets/*} 指定されたツールセットを更新します。 |
retrieveTools |
POST /v1/{toolset=projects/*/locations/*/apps/*/toolsets/*}:retrieveTools 指定されたツールセットに含まれるツールのリストを取得します。 |
REST リソース: v1.projects.locations.apps.versions
| メソッド | |
|---|---|
create |
POST /v1/{parent=projects/*/locations/*/apps/*}/versions 指定されたアプリに新しいアプリ バージョンを作成します。 |
delete |
DELETE /v1/{name=projects/*/locations/*/apps/*/versions/*} 指定されたアプリのバージョンを削除します。 |
get |
GET /v1/{name=projects/*/locations/*/apps/*/versions/*} 指定されたアプリ バージョンの詳細を取得します。 |
getExtendedAgentCard |
GET /v1/{tenant=projects/*/locations/*/apps/*/versions/*}/extendedAgentCard 認証されたエージェントの拡張エージェント カードを取得します。 |
list |
GET /v1/{parent=projects/*/locations/*/apps/*}/versions 指定されたアプリのすべてのアプリ バージョンを一覧表示します。 |
restore |
POST /v1/{name=projects/*/locations/*/apps/*/versions/*}:restore 指定されたアプリのバージョンを復元します。 |
REST リソース: v1.projects.locations.apps.versions.message
| メソッド | |
|---|---|
send |
POST /v1/{tenant=projects/*/locations/*/apps/*/versions/*}/message:send エージェントにメッセージを送信します。 |
stream |
POST /v1/{tenant=projects/*/locations/*/apps/*/versions/*}/message:stream エージェントにストリーミング メッセージを送信し、リアルタイムのやり取りとステータスの更新を可能にします。 |
REST リソース: v1.projects.locations.operations
| メソッド | |
|---|---|
cancel |
POST /v1/{name=projects/*/locations/*/operations/*}:cancel 長時間実行オペレーションの非同期キャンセルを開始します。 |
delete |
DELETE /v1/{name=projects/*/locations/*/operations/*} 長時間実行オペレーションを削除します。 |
get |
GET /v1/{name=projects/*/locations/*/operations/*} 長時間実行オペレーションの最新状態を取得します。 |
list |
GET /v1/{name=projects/*/locations/*}/operations リクエスト内の指定したフィルタに一致するオペレーションを一覧表示します。 |