インデックス
A2AService(インターフェース)APIKeySecurityScheme(メッセージ)AgentCapabilities(メッセージ)AgentCard(メッセージ)AgentCardSignature(メッセージ)AgentExtension(メッセージ)AgentInterface(メッセージ)AgentProvider(メッセージ)AgentSkill(メッセージ)Artifact(メッセージ)AuthenticationInfo(メッセージ)AuthorizationCodeOAuthFlow(メッセージ)CancelTaskRequest(メッセージ)ClientCredentialsOAuthFlow(メッセージ)DeleteTaskPushNotificationConfigRequest(メッセージ)DeviceCodeOAuthFlow(メッセージ)GetExtendedAgentCardRequest(メッセージ)GetTaskPushNotificationConfigRequest(メッセージ)GetTaskRequest(メッセージ)HTTPAuthSecurityScheme(メッセージ)ImplicitOAuthFlow(メッセージ)ListTaskPushNotificationConfigsRequest(メッセージ)ListTaskPushNotificationConfigsResponse(メッセージ)ListTasksRequest(メッセージ)ListTasksResponse(メッセージ)Message(メッセージ)MutualTlsSecurityScheme(メッセージ)OAuth2SecurityScheme(メッセージ)OAuthFlows(メッセージ)OpenIdConnectSecurityScheme(メッセージ)Part(メッセージ)PasswordOAuthFlow(メッセージ)Role(列挙型)SecurityRequirement(メッセージ)SecurityScheme(メッセージ)SendMessageConfiguration(メッセージ)SendMessageRequest(メッセージ)SendMessageResponse(メッセージ)StreamResponse(メッセージ)StringList(メッセージ)SubscribeToTaskRequest(メッセージ)Task(メッセージ)TaskArtifactUpdateEvent(メッセージ)TaskPushNotificationConfig(メッセージ)TaskState(列挙型)TaskStatus(メッセージ)TaskStatusUpdateEvent(メッセージ)
A2AService
A2A プロトコルを使用してエージェントとやり取りするためのオペレーションを提供します。
| CancelTask |
|---|
|
進行中のタスクをキャンセルします。
|
| CreateTaskPushNotificationConfig |
|---|
|
タスクのプッシュ通知構成を作成します。
|
| DeleteTaskPushNotificationConfig |
|---|
|
タスクのプッシュ通知構成を削除します。
|
| GetExtendedAgentCard |
|---|
|
認証されたエージェントの拡張エージェントカードを取得します。
|
| GetTask |
|---|
|
タスクの最新の状態を取得します。
|
| GetTaskPushNotificationConfig |
|---|
|
タスクのプッシュ通知構成を取得します。
|
| ListTaskPushNotificationConfigs |
|---|
|
タスクに構成されているプッシュ通知のリストを取得します。
|
| ListTasks |
|---|
|
指定されたフィルタに一致するタスクを一覧表示します。
|
| SendMessage |
|---|
|
エージェントにメッセージを送信します。
|
| SendStreamingMessage |
|---|
|
エージェントにストリーミング メッセージを送信し、リアルタイムのやり取りとステータスの更新を可能にします。
|
| SubscribeToTask |
|---|
|
終了状態ではないタスクのタスク更新をサブスクライブします。タスクがすでに終了状態(完了、失敗、キャンセル、拒否)の場合、
|
APIKeySecurityScheme
API キーを使用してセキュリティ スキームを定義します。
| フィールド | |
|---|---|
description |
セキュリティ スキームの説明(省略可)。 |
location |
必須。API キーの場所。有効な値は「query」、「header」、「cookie」です。 |
name |
必須。使用するヘッダー、クエリ、Cookie パラメータの名前。 |
AgentCapabilities
エージェントでサポートされるオプションの機能を定義します。
| フィールド | |
|---|---|
extensions[] |
エージェントがサポートするプロトコル拡張機能のリスト。 |
streaming |
エージェントがレスポンスのストリーミングをサポートしているかどうかを示します。 |
push_notifications |
エージェントが非同期タスクの更新に関するプッシュ通知の送信をサポートしているかどうかを示します。 |
extended_agent_card |
認証時に拡張エージェント カードの提供をサポートするかどうかを示します。 |
AgentCard
エージェントの自己記述型マニフェスト。エージェントの ID、機能、スキル、サポートされている通信方法、セキュリティ要件などの重要なメタデータを提供します。次の ID: 20
| フィールド | |
|---|---|
name |
必須。人が読める形式のエージェントの名前。例: 「レシピ エージェント」 |
description |
必須。エージェントの目的をユーザーや他のエージェントが理解するのに役立つ、人が読める形式の説明。例: 「レシピや料理についてユーザーをサポートするエージェント。」 |
supported_interfaces[] |
必須。サポートされているインターフェースの順序付きリスト。最初のエントリが優先されます。 |
provider |
エージェントのサービス提供者。 |
version |
必須。エージェントのバージョン。例: 「1.0.0」 |
capabilities |
必須。エージェントがサポートする A2A 機能セット。 |
security_schemes |
このエージェントとの認証に使用されるセキュリティ スキームの詳細。 |
security_requirements[] |
エージェントへの連絡に関するセキュリティ要件。 |
default_input_modes[] |
必須。protolint:enable REPEATED_FIELD_NAMES_PLURALIZED エージェントがすべてのスキルでサポートするインタラクション モードのセット。これはスキルごとにオーバーライドできます。メディアタイプとして定義されます。 |
default_output_modes[] |
必須。このエージェントの出力としてサポートされているメディアタイプ。 |
skills[] |
必須。スキルは、エージェントの能力を表します。これは主に説明的なコンセプトですが、エージェントが成功する可能性が高い、より絞り込まれた一連の動作を表しています。 |
signatures[] |
この |
documentation_url |
エージェントに関する追加のドキュメントを提供する URL。 |
icon_url |
省略可。エージェントのアイコンへの URL。 |
AgentCardSignature
AgentCardSignature は、AgentCard の JWS 署名を表します。これは、RFC 7515 JSON Web Signature(JWS)の JSON 形式に準拠しています。
| フィールド | |
|---|---|
protected |
必須。必須。署名の保護された JWS ヘッダー。これは常に base64url エンコードの JSON オブジェクトです。 |
signature |
必須。計算された署名(base64url でエンコード)。 |
header |
保護されていない JWS ヘッダー値。 |
AgentExtension
エージェントがサポートするプロトコル拡張機能の宣言。
| フィールド | |
|---|---|
uri |
拡張機能を識別する一意の URI。 |
description |
このエージェントが拡張機能を使用する方法の説明(人が読める形式)。 |
required |
true の場合、クライアントは拡張機能の要件を理解し、遵守する必要があります。 |
params |
省略可。拡張機能固有の構成パラメータ。 |
AgentInterface
エージェントとやり取りするためのターゲット URL、トランスポート、プロトコル バージョンの組み合わせを宣言します。これにより、エージェントは複数のプロトコル バインディング メカニズムで同じ機能を公開できます。
| フィールド | |
|---|---|
url |
必須。このインターフェースが利用可能な URL。本番環境では、有効な絶対 HTTPS URL である必要があります。例: 「https://api.example.com/a2a/v1」、「https://grpc.example.com/a2a」 |
protocol_binding |
必須。この URL でサポートされているプロトコル バインディング。これはオープン フォーム文字列であり、他のプロトコル バインディングに簡単に拡張できます。正式にサポートされているコアは、 |
tenant |
省略可。複数のエージェントが単一の A2A エンドポイントの背後でサービスを提供している場合に、リクエストを特定のエージェントまたはテナントに転送するために使用される不透明な文字列。設定されている場合、クライアントは、このインターフェースに送信されるすべてのリクエスト メッセージの |
protocol_version |
必須。このインターフェースが公開する A2A プロトコルのバージョン。メジャー バージョンごとに、サポートされている最新のマイナー バージョンを使用します。例: 「0.3」、「1.0」 |
AgentProvider
エージェントのサービス提供者を表します。
| フィールド | |
|---|---|
url |
必須。エージェント プロバイダのウェブサイトまたは関連ドキュメントの URL。例: "https://ai.google.dev" |
organization |
必須。エージェント プロバイダの組織の名前。例: 「Google」 |
AgentSkill
エージェントが実行できる個別の機能を表します。
| フィールド | |
|---|---|
id |
必須。エージェントのスキルの一意の識別子。 |
name |
必須。人が読める形式のスキルの名前。 |
description |
必須。スキルの詳細な説明。 |
tags[] |
必須。スキルの機能を説明するキーワードのセット。 |
examples[] |
このスキルで処理できるプロンプトやシナリオの例。 |
input_modes[] |
このスキルでサポートされている入力メディア タイプのセット。エージェントのデフォルトをオーバーライドします。 |
output_modes[] |
このスキルでサポートされている出力メディア タイプのセット。エージェントのデフォルトをオーバーライドします。 |
security_requirements[] |
このスキルに必要なセキュリティ スキーム。 |
アーティファクト
アーティファクトはタスクの出力を表します。
| フィールド | |
|---|---|
artifact_id |
必須。アーティファクトの一意の識別子(UUID など)。タスク内で一意にする必要があります。 |
name |
人が読める形式のアーティファクトの名前。 |
description |
省略可。アーティファクトの説明(人が読める形式)。 |
parts[] |
必須。アーティファクトのコンテンツ。少なくとも 1 つのパーツを含める必要があります。 |
metadata |
省略可。アーティファクトに含まれるメタデータ。 |
extensions[] |
このアーティファクトに存在する、またはコントリビューションされた拡張機能の URI。 |
AuthenticationInfo
プッシュ通知に使用される認証の詳細を定義します。
| フィールド | |
|---|---|
scheme |
必須。IANA レジストリの HTTP 認証スキーム。例: |
credentials |
プッシュ通知の認証情報。形式はスキームによって異なります(Bearer の場合はトークンなど)。 |
AuthorizationCodeOAuthFlow
OAuth 2.0 認可コードフローの構成の詳細を定義します。
| フィールド | |
|---|---|
authorization_url |
必須。このフローで使用される認証 URL。 |
token_url |
必須。このフローで使用するトークン URL。 |
refresh_url |
更新トークンの取得に使用する URL。 |
scopes |
必須。OAuth2 セキュリティ スキームで使用可能なスコープ。 |
pkce_required |
このフローに PKCE(RFC 7636)が必要かどうかを示します。PKCE は常に公開クライアントで使用する必要があり、すべてのクライアントで推奨されます。 |
CancelTaskRequest
CancelTask メソッドのリクエストを表します。
| フィールド | |
|---|---|
tenant |
省略可。不透明なルーティング識別子。このフィールドが設定されている場合、エージェント カードで選択した |
id |
必須。キャンセルするタスクのリソース ID。 |
metadata |
追加のコンテキストやパラメータを渡すための柔軟な Key-Value マップ。 |
ClientCredentialsOAuthFlow
OAuth 2.0 クライアント認証情報フローの構成の詳細を定義します。
| フィールド | |
|---|---|
token_url |
必須。このフローで使用するトークン URL。 |
refresh_url |
更新トークンの取得に使用する URL。 |
scopes |
必須。OAuth2 セキュリティ スキームで使用可能なスコープ。 |
DeleteTaskPushNotificationConfigRequest
DeleteTaskPushNotificationConfig メソッドのリクエストを表します。
| フィールド | |
|---|---|
tenant |
省略可。不透明なルーティング識別子。このフィールドが設定されている場合、エージェント カードで選択した |
task_id |
必須。親タスクのリソース ID。 |
id |
必須。削除する構成のリソース ID。 |
DeviceCodeOAuthFlow
OAuth 2.0 デバイスコードフロー(RFC 8628)の構成の詳細を定義します。このフローは、IoT デバイスなどの入力が制限されたデバイスや、ユーザーが別のデバイスで認証を行う CLI ツール向けに設計されています。
| フィールド | |
|---|---|
device_authorization_url |
必須。デバイス認証エンドポイントの URL。 |
token_url |
必須。このフローで使用するトークン URL。 |
refresh_url |
更新トークンの取得に使用する URL。 |
scopes |
必須。OAuth2 セキュリティ スキームで使用可能なスコープ。 |
GetExtendedAgentCardRequest
GetExtendedAgentCard メソッドのリクエストを表します。
| フィールド | |
|---|---|
tenant |
省略可。不透明なルーティング識別子。このフィールドが設定されている場合、エージェント カードで選択した |
GetTaskPushNotificationConfigRequest
GetTaskPushNotificationConfig メソッドのリクエストを表します。
| フィールド | |
|---|---|
tenant |
省略可。不透明なルーティング識別子。このフィールドが設定されている場合、エージェント カードで選択した |
task_id |
必須。親タスクのリソース ID。 |
id |
必須。取得する構成のリソース ID。 |
GetTaskRequest
GetTask メソッドのリクエストを表します。
| フィールド | |
|---|---|
tenant |
省略可。不透明なルーティング識別子。このフィールドが設定されている場合、エージェント カードで選択した |
id |
必須。取得するタスクのリソース ID。 |
history_length |
取得するタスクの履歴の最新メッセージの最大数。値が設定されていない場合、クライアントは制限を課しません。値 0 は、メッセージを含めないリクエストです。サーバーは、指定された値よりも多くのメッセージを返してはなりませんが、下限を適用しても構いません。 |
HTTPAuthSecurityScheme
HTTP 認証を使用してセキュリティ スキームを定義します。
| フィールド | |
|---|---|
description |
セキュリティ スキームの説明(省略可)。 |
scheme |
必須。RFC7235 で定義されている Authorization ヘッダーで使用される HTTP 認証スキームの名前(例: "Bearer")。この値は、IANA 認証スキーム レジストリに登録する必要があります。 |
bearer_format |
ベアラートークンの形式(「JWT」など)を識別するためのクライアントへのヒント。主にドキュメント化を目的としています。 |
ImplicitOAuthFlow
非推奨: 代わりに Authorization Code + PKCE を使用してください。
| フィールド | |
|---|---|
authorization_url |
このフローで使用される認証 URL。これは URL の形式でなければなりません。OAuth2 標準では TLS の使用が義務付けられています |
refresh_url |
更新トークンの取得に使用する URL。これは URL の形式でなければなりません。OAuth2 標準では TLS の使用が義務付けられています。 |
scopes |
OAuth2 セキュリティ スキームで使用可能なスコープ。スコープ名とその簡単な説明のマッピング。マップは空でも構いません。 |
ListTaskPushNotificationConfigsRequest
ListTaskPushNotificationConfigs メソッドのリクエストを表します。
| フィールド | |
|---|---|
tenant |
省略可。不透明なルーティング識別子。このフィールドが設定されている場合、エージェント カードで選択した |
task_id |
必須。親タスクのリソース ID。 |
page_size |
返す構成の最大数。 |
page_token |
前回の |
ListTaskPushNotificationConfigsResponse
ListTaskPushNotificationConfigs メソッドの成功レスポンスを表します。
| フィールド | |
|---|---|
configs[] |
プッシュ通知構成のリスト。 |
next_page_token |
結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。 |
ListTasksRequest
フィルタ条件(省略可)を指定してタスクを一覧表示するためのパラメータ。
| フィールド | |
|---|---|
tenant |
省略可。不透明なルーティング識別子。このフィールドが設定されている場合、エージェント カードで選択した |
context_id |
コンテキスト ID でタスクをフィルタして、特定の会話またはセッションからタスクを取得します。 |
status |
タスクを現在のステータスでフィルタします。 |
page_token |
前回の |
status_timestamp_after |
ISO 8601 形式(例: 「2023-10-27T10:00:00Z」)で指定されたタイムスタンプ以降にステータスが更新されたタスクをフィルタします。ステータスのタイムスタンプがこの値以上のタスクのみが返されます。 |
page_size |
返されるタスクの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のタスクが返されます。最小値は 1 です。最大値は 100 です。 |
history_length |
各タスクの履歴に含めるメッセージの最大数。 |
include_artifacts |
返されたタスクにアーティファクトを含めるかどうか。ペイロード サイズを小さくするため、デフォルトは false です。 |
ListTasksResponse
ListTasks メソッドの結果オブジェクト。タスクの配列とページネーション情報が含まれます。
| フィールド | |
|---|---|
tasks[] |
必須。指定された条件に一致するタスクの配列。 |
next_page_token |
必須。結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。 |
page_size |
必須。このレスポンスに使用されたページサイズ。 |
total_size |
必須。使用可能なタスクの合計数(ページネーション前)。 |
メッセージ
Message は、クライアントとサーバー間の通信の単位です。コンテキストやタスクに関連付けることができます。サーバー メッセージの場合、context_id は必須です。task_id は、タスクが作成された場合にのみ指定します。クライアント メッセージの場合、両方のフィールドは省略可能です。ただし、両方が指定されている場合は、一致している必要があります(context_id はタスクに設定されているものである必要があります)。task_id のみが指定されている場合、サーバーはそこから context_id を推測します。
| フィールド | |
|---|---|
message_id |
必須。メッセージの一意の識別子(UUID など)。これはメッセージの作成者によって作成されます。 |
context_id |
省略可。メッセージのコンテキスト ID。設定されている場合、メッセージは指定されたコンテキストに関連付けられます。 |
task_id |
省略可。メッセージのタスク ID。設定されている場合、メッセージは指定されたタスクに関連付けられます。 |
role |
必須。メッセージの送信者を識別します。 |
parts[] |
必須。Parts はメッセージ コンテンツのコンテナです。 |
metadata |
省略可。メッセージとともに提供するメタデータ。 |
extensions[] |
このメッセージに存在する、またはこのメッセージに提供された拡張機能の URI。 |
reference_task_ids[] |
このメッセージが追加のコンテキストを参照するタスク ID のリスト。 |
MutualTlsSecurityScheme
mTLS 認証を使用するセキュリティ スキームを定義します。
| フィールド | |
|---|---|
description |
セキュリティ スキームの説明(省略可)。 |
OAuth2SecurityScheme
OAuth 2.0 を使用してセキュリティ スキームを定義します。
| フィールド | |
|---|---|
description |
セキュリティ スキームの説明(省略可)。 |
flows |
必須。サポートされている OAuth 2.0 フローの構成情報を含むオブジェクト。 |
oauth2_metadata_url |
OAuth2 認証サーバー メタデータ RFC 8414 の URL。TLS が必要です。 |
OAuthFlows
サポートされている OAuth 2.0 フローの構成を定義します。
| フィールド | |
|---|---|
共用体フィールド
|
|
authorization_code |
OAuth 認可コードフローの構成。 |
client_credentials |
OAuth クライアント認証情報フローの構成。 |
implicit |
非推奨: 代わりに Authorization Code + PKCE を使用してください。 |
password |
非推奨: 認証コード + PKCE またはデバイスコードを使用してください。 |
device_code |
OAuth デバイスコードフローの構成。 |
OpenIdConnectSecurityScheme
OpenID Connect を使用してセキュリティ スキームを定義します。
| フィールド | |
|---|---|
description |
セキュリティ スキームの説明(省略可)。 |
open_id_connect_url |
必須。OIDC プロバイダのメタデータの OpenID Connect Discovery URL。 |
Part
Part は、コミュニケーション コンテンツのセクションのコンテナを表します。パーツは、純粋なテキスト、何らかのファイル(画像、動画など)、構造化データ BLOB(JSON など)にすることができます。
| フィールド | |
|---|---|
metadata |
省略可。この部分に関連付けられたメタデータ。 |
filename |
ファイルのオプションの |
media_type |
パート コンテンツの |
共用体フィールド
|
|
text |
|
raw |
ファイルの |
url |
ファイルのコンテンツを指す |
data |
任意の構造化された |
PasswordOAuthFlow
非推奨: 認証コード + PKCE またはデバイスコードを使用してください。
| フィールド | |
|---|---|
token_url |
このフローで使用するトークン URL。これは URL の形式でなければなりません。OAuth2 標準では TLS の使用が義務付けられています。 |
refresh_url |
更新トークンの取得に使用する URL。これは URL の形式でなければなりません。OAuth2 標準では TLS の使用が義務付けられています。 |
scopes |
OAuth2 セキュリティ スキームで使用可能なスコープ。スコープ名とその簡単な説明のマッピング。マップは空でも構いません。 |
ロール
A2A プロトコル通信のメッセージの送信者を定義します。
| 列挙型 | |
|---|---|
ROLE_UNSPECIFIED |
ロールが指定されていません。 |
ROLE_USER |
メッセージはクライアントからサーバーに送信されます。 |
ROLE_AGENT |
メッセージはサーバーからクライアントに送信されます。 |
SecurityRequirement
エージェントのセキュリティ要件を定義します。
| フィールド | |
|---|---|
schemes |
セキュリティ スキームと必要なスコープのマッピング。 |
SecurityScheme
エージェントのエンドポイントの保護に使用できるセキュリティ スキームを定義します。これは、OpenAPI 3.2 セキュリティ スキーム オブジェクトに基づく判別共用体型です。参照: https://spec.openapis.org/oas/v3.2.0.html#security-scheme-object
| フィールド | |
|---|---|
共用体フィールド
|
|
api_key_security_scheme |
API キーベースの認証。 |
http_auth_security_scheme |
HTTP 認証(Basic、Bearer など)。 |
oauth2_security_scheme |
OAuth 2.0 認証。 |
open_id_connect_security_scheme |
OpenID Connect 認証。 |
mtls_security_scheme |
相互 TLS 認証。 |
SendMessageConfiguration
送信メッセージ リクエストの構成。
| フィールド | |
|---|---|
accepted_output_modes[] |
クライアントがレスポンス パーツで受け入れる準備ができているメディアタイプのリスト。エージェントは、これを使用して出力を調整すべきです。 |
task_push_notification_config |
タスクの更新に関するプッシュ通知を送信するエージェントの構成。 |
return_immediately |
|
history_length |
レスポンスで取得するタスクの履歴から取得する最新のメッセージの最大数。値が設定されていない場合、クライアントは制限を課しません。値 0 は、メッセージを含めないリクエストです。サーバーは、指定された値よりも多くのメッセージを返してはなりませんが、下限を適用しても構いません。 |
SendMessageRequest
SendMessage メソッドのリクエストを表します。
| フィールド | |
|---|---|
tenant |
省略可。不透明なルーティング識別子。このフィールドが設定されている場合、エージェント カードで選択した |
message |
必須。エージェントに送信するメッセージ。 |
configuration |
送信リクエストの構成。 |
metadata |
追加のコンテキストやパラメータを渡すための柔軟な Key-Value マップ。 |
SendMessageResponse
SendMessage メソッドのレスポンスを表します。
| フィールド | |
|---|---|
共用体フィールド payload。レスポンスのペイロード。payload は次のいずれかになります。 |
|
task |
メッセージによって作成または更新されたタスク。 |
message |
エージェントからのメッセージ。 |
StreamResponse
ストリーミング オペレーションで使用され、さまざまなタイプのレスポンス データをカプセル化するラッパー オブジェクト。
| フィールド | |
|---|---|
共用体フィールド payload。ストリーム レスポンスのペイロード。payload は次のいずれかになります。 |
|
task |
タスクの現在の状態を含む Task オブジェクト。 |
message |
エージェントからのメッセージを含む Message オブジェクト。 |
status_update |
タスクのステータス更新を示すイベント。 |
artifact_update |
タスク アーティファクトの更新を示すイベント。 |
StringList
protolint:disable REPEATED_FIELD_NAMES_PLURALIZED 文字列のリスト。
| フィールド | |
|---|---|
list[] |
個々の文字列値。 |
SubscribeToTaskRequest
SubscribeToTask メソッドのリクエストを表します。
| フィールド | |
|---|---|
tenant |
省略可。不透明なルーティング識別子。このフィールドが設定されている場合、エージェント カードで選択した |
id |
必須。登録するタスクのリソース ID。 |
タスク
Task は、A2A のアクションのコア単位です。現在のステータスがあり、タスクの結果が作成されると、アーティファクトに保存されます。タスクに複数のターンがある場合、それらは履歴に保存されます。
| フィールド | |
|---|---|
id |
必須。タスクの一意の識別子(UUID など)。新しいタスクに対してサーバーによって生成されます。 |
context_id |
コンテキスト内のインタラクション(タスクとメッセージ)のコレクションの一意の識別子(UUID など)。 |
status |
必須。 |
artifacts[] |
|
history[] |
protolint:disable REPEATED_FIELD_NAMES_PLURALIZED |
metadata |
protolint:enable REPEATED_FIELD_NAMES_PLURALIZED タスクに関するカスタム メタデータを保存する Key-Value オブジェクト。 |
TaskArtifactUpdateEvent
アーティファクトが生成されたタスクの差分。
| フィールド | |
|---|---|
task_id |
必須。このアーティファクトのタスクの ID。 |
context_id |
必須。このタスクが属するコンテキストの ID。 |
artifact |
必須。生成または更新されたアーティファクト。 |
append |
true の場合、このアーティファクトのコンテンツは、同じ ID の以前に送信されたアーティファクトに追加されます。 |
last_chunk |
true の場合、これはアーティファクトの最後のチャンクです。 |
metadata |
省略可。アーティファクトの更新に関連付けられたメタデータ。 |
TaskPushNotificationConfig
プッシュ通知構成を特定のタスクに関連付けるコンテナ。
| フィールド | |
|---|---|
tenant |
省略可。不透明なルーティング識別子。このフィールドが設定されている場合、エージェント カードで選択した |
id |
プッシュ通知の構成の詳細。このプッシュ通知構成の固有識別子(UUID など)。 |
task_id |
この構成が関連付けられているタスクの ID。 |
url |
必須。通知の送信先 URL。 |
token |
このタスクまたはセッションに固有のトークン。 |
authentication |
通知の送信に必要な認証情報。 |
TaskState
Task のライフサイクル ステータスを定義します。
| 列挙型 | |
|---|---|
TASK_STATE_UNSPECIFIED |
タスクの状態が不明または未確定です。 |
TASK_STATE_SUBMITTED |
タスクが正常に送信され、確認されたことを示します。 |
TASK_STATE_WORKING |
タスクがエージェントによってアクティブに処理されていることを示します。 |
TASK_STATE_COMPLETED |
タスクが正常に終了したことを示します。これは終了状態です。 |
TASK_STATE_FAILED |
タスクがエラーで終了したことを示します。これは終了状態です。 |
TASK_STATE_CANCELED |
タスクが完了前にキャンセルされたことを示します。これは終了状態です。 |
TASK_STATE_INPUT_REQUIRED |
エージェントが続行するために追加のユーザー入力を必要としていることを示します。これは中断状態です。 |
TASK_STATE_REJECTED |
エージェントがタスクを実行しないことを決定したことを示します。これは、最初のタスク作成時、またはエージェントが続行できないと判断した後に実行されることがあります。これは終了状態です。 |
TASK_STATE_AUTH_REQUIRED |
続行するには認証が必要であることを示します。これは中断状態です。 |
TaskStatus
タスクのステータスのコンテナ
| フィールド | |
|---|---|
state |
必須。このタスクの現在の状態。 |
message |
ステータスに関連付けられたメッセージ。 |
timestamp |
ステータスが記録されたときの ISO 8601 タイムスタンプ。例: 「2023-10-27T10:00:00Z」 |
TaskStatusUpdateEvent
エージェントがタスクのステータスの変更をクライアントに通知するために送信するイベント。
| フィールド | |
|---|---|
task_id |
必須。変更されたタスクの ID。 |
context_id |
必須。タスクが属するコンテキストの ID。 |
status |
必須。タスクの新しいステータス。 |
metadata |
省略可。タスクの更新に関連付けられたメタデータ。 |