セッション ID を指定して、指定されたセッションのメッセージ履歴と Pipeline スナップショットの一時的なダウンロード URL を取得します。
操作説明
操作の説明
V2 サービスを呼び出す際は、
AgentVersionパラメーターをV2に設定してください。この操作は、現在のユーザーの会話の
SessionIdのみを受け付けます。メッセージ配列を直接返すのではなく、session.jsonlおよびa2a-snapshot.jsonの署名付きダウンロード URL を返します。ダウンロード URL の有効期間は 1800 秒 (30 分) です。有効期間内にダウンロードを完了してください。
応答内の URL には署名パラメーターが含まれています。これらをログに記録したり、共有したり、長期間キャッシュしたりしないでください。
MaxResultsおよびNextTokenは互換性フィールドであり、V2 では使用されません。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| SessionId |
string |
必須 |
クエリするセッションの ID。現在のユーザーが所有するセッションのみをクエリできます。 |
7f4e2a8c6d9b4a1f8e3c5b7d2a6f9012 |
| MaxResults |
integer |
任意 |
互換性フィールド。V2 はページネーションされたメッセージ配列を返さず、サービスはこのフィールドを使用しません。 |
20 |
| NextToken |
string |
任意 |
互換性フィールド。V2 はページネーションされたメッセージ配列を返さず、サービスはこのフィールドを使用しません。 |
CAES.. |
| AgentVersion |
string |
任意 |
リクエストを ROS Agent V2 バックエンドにルーティングするには、このパラメーターを V2 に設定します。 |
V2 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマ。 |
||
| RequestId |
string |
リクエスト ID。 |
4C68F7A5-2D16-5C8F-A4B1-01E9C6A9B0D2 |
| Messages |
array<object> |
互換性フィールド。V2 の応答はメッセージ配列を返しません。 |
[] |
|
object |
互換性フィールド。V2 はメッセージオブジェクトを返しません。 |
{} |
|
| NextToken |
string |
互換性フィールド。V2 の応答は NextToken を返しません。 |
CAES.. |
| MaxResults |
integer |
互換性フィールド。V2 の応答は MaxResults を返しません。 |
20 |
| SessionMessagesDownloadUrl |
string |
会話メッセージファイル session.jsonl の署名付きダウンロード URL。URL の有効期間は 1800 秒です。 |
https://oss.example/session.jsonl?signature=REDACTED |
| PipelineSnapshotDownloadUrl |
string |
Pipeline スナップショットファイル a2a-snapshot.json の署名付きダウンロード URL。URL の有効期間は 1800 秒です。 |
https://oss.example/a2a-snapshot.json?signature=REDACTED |
| Title |
string |
セッションのタイトル。この値は空の場合があります。 |
VPC テンプレートの作成 |
| PipelineName |
string |
パイプライン名。有効な値: EvaluationFirstSelling、SolutionFirstSelling。 |
SolutionFirstSelling |
| WorkspaceTemplates |
array<object> |
セッションワークスペース内の ROS テンプレートのリスト。このフィールドはソリューション優先フローの場合にのみ返されます。公開済みのテンプレートが存在しない場合、このフィールドは返されないか、空の配列が返されます。 |
|
|
object |
単一の ROS テンプレートのパス、可用性ステータス、および一時的なダウンロード URL。 |
||
| TemplatePath |
string |
セッションワークスペース内のテンプレートの相対パス。サポートされている形式: |
templates/0-vpc.yml |
| Status |
string |
テンプレートのダウンロードステータス。有効な値:
|
available |
| DownloadUrl |
string |
テンプレートファイルの一時的なダウンロード URL。このフィールドは |
https://example.com/templates/0-vpc.yml?expires=300 |
例
成功レスポンス
JSONJSON
{
"RequestId": "4C68F7A5-2D16-5C8F-A4B1-01E9C6A9B0D2",
"Messages": [
{}
],
"NextToken": "CAES..",
"MaxResults": 20,
"SessionMessagesDownloadUrl": "https://oss.example/session.jsonl?signature=REDACTED",
"PipelineSnapshotDownloadUrl": "https://oss.example/a2a-snapshot.json?signature=REDACTED",
"Title": "VPC テンプレートの作成",
"PipelineName": "SolutionFirstSelling",
"WorkspaceTemplates": [
{
"TemplatePath": "templates/0-vpc.yml",
"Status": "available",
"DownloadUrl": "https://example.com/templates/0-vpc.yml?expires=300"
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。