すべてのプロダクト
Search

このプロダクト

    DataWorks:PromptAgentSession

    ドキュメントセンター

    DataWorks:PromptAgentSession

    最終更新日:May 06, 2026

    既存のセッションにプロンプトを送信し、エージェントの応答をストリーミングします。

    操作説明

    リクエスト

    • この API は、ユーザーのプロンプトを指定されたセッション ID に送信し、SSE（Server-Sent Events）経由でエージェントの応答をストリーミングします。

    • 応答には、メッセージチャンク、思考プロセス、ツール呼び出しステータスの更新が含まれる場合があります。

    • 指定されたセッションが存在しない場合、API は SSE エラーフレーム内で 400 エラーを返します。

    • stopReason フィールドは、エージェントがターンを終了した理由を示します。

    • プロンプトには、テキストや OSS ファイルダウンロードリンクなど、複数種類のコンテンツブロックを使用できます。

    • Meta パラメーターに追加のメタデータを指定することで、サーバーにさらにコンテキスト情報を渡すことができます。

    • 応答コンテンツは、オープンソースの Agent Client Protocol（ACP）仕様に準拠しています。詳細については、「https://agentclientprotocol.com」をご参照ください。

    • Data Agent の課金方法と料金体系を確認してから、この API を使用してください： https://www.alibabacloud.com/help/zh/dataworks/dataworks-data-agent-agent-billing

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Jsonrpc

    string

    任意

    JSON-RPC のバージョンです。この値は「2.0」に固定されています。

    2.0
    Id

    string

    任意

    クライアントが提供するリクエスト ID です。サーバーはこの値を変更せずに応答で返します。

    1021418411
    Params

    object

    任意

    ビジネスパラメーターです。

    SessionId

    string

    任意

    対象セッションの ID です。セッションが存在しない場合、SSE エラーフレームが返されます。

    sess_0f12abc34
    Prompt

    array<object>

    任意

    ユーザーのメッセージ用のコンテンツブロックの配列です。詳細については、「https://agentclientprotocol.com/protocol/content」をご参照ください。

    array<object>

    任意

    Type

    string

    任意

    コンテンツブロックのタイプです。

    目前支持：text，resource_link
    Text

    string

    任意

    テキストコンテンツです。

    Type=text下生效，示例值：近 7 天销售额
    Uri

    string

    任意

    ファイルの URI です。

    Type= resource_link下生效，示例值：oss://${bucket}/${ossKey}
    Name

    string

    任意

    ファイル名です。

    Type= resource_link下生效，示例值：xxx.csv
    MimeType

    string

    任意

    ファイルの MIME タイプです。

    Type= resource_link下生效，示例值：text/csv‌
    Size

    integer

    任意

    ファイルサイズ（バイト単位）です。

    Type= resource_link下生效，示例值：1231231
    Title

    string

    任意

    ファイルのタイトルです。

    Type= resource_link下生效，示例值：销售订单明细.csv
    Description

    string

    任意

    ファイルの説明です。

    Type= resource_link下生效，示例值：销售订单明细.csv
    Meta

    object

    任意

    DataWorks 拡張プロンプトメタデータです。

    Hide

    boolean

    任意

    このプロンプトをユーザーに表示するかどうかを指定します。たとえば、チャットダイアログでユーザーが「直近 7 日間の売上高はいくらでしたか？」と尋ねた場合、OpenAPI を呼び出す前に、ご利用のシステムが RAG を使用して関連するビジネスナレッジを検索し、エージェントのコンテキストに追加できます。この補足情報をユーザーに表示したくない場合は、このパラメーターを「true」に設定してください。

    true or false
    Meta

    object

    任意

    拡張メタデータです。

    Context

    any

    任意

    マップオブジェクトです。カスタムエージェントのシナリオでは、このパラメーターを使用してプレースホルダーを置き換えることができます。

    { "key1": "value1", "key2": "value2" }

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID です。

    D5D70885-7CC7-594A-80C7-2EF1B00FFB4B
    Timestamp

    integer

    応答のタイムスタンプです。

    1747447032
    Jsonrpc

    string

    JSON-RPC のバージョンです。この値は 2.0 に固定されています。

    2.0
    Id

    string

    リクエストから取得した ID を、変更せずに返します。

    631478864897630XXXX
    Result

    any

    SSE（Server-Sent Events）フレームの結果です。応答コンテンツは、オープンソースの Agent Client Protocol（ACP）に準拠しています。詳細については、「https://agentclientprotocol.com/protocol/prompt-turn」をご参照ください。

    {"stopReason":"end_turn"}

    Error

    any

    SSE フレームのエラー詳細です。応答コンテンツは、オープンソースの Agent Client Protocol（ACP）に準拠しています。詳細については、「https://agentclientprotocol.com/protocol/prompt-turn」をご参照ください。

    {"code": 400, "errorCode": "0x50000000001", "message": "not exist session", "data": null}
    Method

    string

    SSE フレームのメソッドです。応答コンテンツは、オープンソースの Agent Client Protocol（ACP）に準拠しています。詳細については、「https://agentclientprotocol.com/protocol/prompt-turn」をご参照ください。

    session/update
    Params

    any

    SSE フレームのパラメーターです。応答コンテンツは、オープンソースの Agent Client Protocol（ACP）に準拠しています。詳細については、「https://agentclientprotocol.com/protocol/prompt-turn」をご参照ください。

    {"sessionId":"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed","update":{"sessionUpdate":"agent_message_chunk","content":{"type":"text","text":"hello world"}}}

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "D5D70885-7CC7-594A-80C7-2EF1B00FFB4B",
  "Timestamp": 1747447032,
  "Jsonrpc": "2.0",
  "Id": "631478864897630XXXX",
  "Result": "{\"stopReason\":\"end_turn\"}\n",
  "Error": "{\"code\": 400, \"errorCode\": \"0x50000000001\", \"message\": \"not exist session\", \"data\": null}",
  "Method": "session/update",
  "Params": "{\"sessionId\":\"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed\",\"update\":{\"sessionUpdate\":\"agent_message_chunk\",\"content\":{\"type\":\"text\",\"text\":\"hello world\"}}}"
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。