すべてのプロダクト
Search

このプロダクト

    DataWorks:CreateAgentSession

    ドキュメントセンター

    DataWorks:CreateAgentSession

    最終更新日:May 06, 2026

    新しいエージェントセッションを作成し、セッション ID を返します。

    操作説明

    概要

    • この API は、新しいエージェントセッションを作成します。

    • セッションにバインドするエージェント名を _meta.agent.agentName パラメーターで指定する必要があります。

    • _meta.config.sessionSource パラメーターでセッションソース識別子を指定できます。これにより、後からソースごとにセッションを検索できます。

    • _meta.config.sessionTags[].sessionTagCode パラメーターを使用して、セッションタグを追加できます。

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Jsonrpc

    string

    任意

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

    2.0
    Id

    string

    任意

    クライアントが提供するリクエスト ID です。この ID は、応答で変更されずに返されます。

    4758330557805415712
    Params

    object

    任意

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

    Meta

    object

    任意

    拡張メタデータです。エージェントのバインド、セッションソース、セッションタグなどの情報が含まれます。

    Agent

    object

    任意

    このセッションのエージェント構成です。ListAgents API によって返されたエージェントのいずれかである必要があります。

    AgentName

    string

    任意

    セッションにバインドするエージェント名です。このパラメーターは必須です。

    chat_cli_chatbi
    Config

    object

    任意

    セッションの構成パラメーターです。セッションソースやセッションタグに基づくフィルターなどが含まれます。

    SessionSource

    string

    任意

    セッションソースの識別子です。これにより、ソースごとにセッションを検索できます。たとえば、エージェントをページ A とページ B の複数のページで使用している場合、このパラメーターを使用してページ A で作成されたセッションのみをフィルター表示できます。識別子は最大 128 文字で、英数字、ハイフン (-)、アンダースコア (_) を使用できます。

    openapi_sdk
    SessionTags

    array<object>

    任意

    セッションタグのリストです。これらのタグを使用して、セッションを検索およびフィルターできます。

    object

    任意

    SessionTagCode

    string

    任意

    セッションタグです。セッションタグを使用して、セッションをフィルターできます。たとえば、アプリケーションが固定の RAM サブアカウントを使用して API を呼び出しつつ、独自のユーザーアカウントシステムを維持している場合、ユーザーのアカウント ID をタグとして渡すことができます。これにより、内部のアカウント ID でセッションリストをフィルターできます。タグは最大 128 文字で、英数字、ハイフン (-)、アンダースコア (_) を使用できます。

    chatbi

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーターです。

    RequestId

    string

    リクエストの ID です。

    8A9D5E6C-5817-5837-9715-6E3967EC6123
    JsonRpcResponse

    object

    JSON-RPC 応答です。

    Jsonrpc

    string

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

    2.0
    Id

    string

    クライアントが提供するリクエスト ID です。この ID は、応答で変更されずに返されます。

    1
    Result

    object

    ビジネスデータです。エラーが発生した場合は、このフィールドは null になります。

    SessionId

    string

    作成されたセッションの ID です。

    sess_0f12abc34

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "8A9D5E6C-5817-5837-9715-6E3967EC6123",
  "JsonRpcResponse": {
    "Jsonrpc": "2.0",
    "Id": "1",
    "Result": {
      "SessionId": "sess_0f12abc34"
    }
  }
}

    エラーコード

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

    変更履歴

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