すべてのプロダクト
Search

このプロダクト

    DataWorks:CreateAgentSession

    ドキュメントセンター

    DataWorks:CreateAgentSession

    最終更新日:Jul 13, 2026

    新しいエージェントの会話を作成し、会話 ID を返します。

    操作説明

    操作の説明

    • この操作は、新しいエージェントの会話を作成します。

    • _meta.agent.agentName を使用して、バインドするエージェント名を指定します。このパラメーターは必須です。

      • dataworks_data_agent: DataWorks 組み込みエージェント — Data Agent。Data Integration、開発、O&M、ガバナンス、データ分析の全プロセスをカバーするインテリジェントなデータ開発 AI 機能を提供します。

      • dataworks_chatbi_agent: DataWorks 組み込みエージェント — ChatBI。自然言語処理とインテリジェント分析を使用して、要件の解析、データ抽出、自動コード生成から可視化レポート出力までの全プロセスをチャットによるインタラクションを通じて自動化します。

    • _meta.config.sessionSource を使用して、ソースによる後続の取得のために会話ソース識別子を渡します。

    • _meta.config.sessionTags[].sessionTagCode を使用して会話タグを渡します。

    今すぐお試しください

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

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dataworks:CreateAgentSession

    create

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Jsonrpc

    string

    任意

    JSON-RPC バージョン。値を 2.0 に設定します。

    2.0
    Id

    string

    任意

    呼び出し元によって指定されたリクエスト ID。値はそのまま返されます。

    4758330557805415712
    Params

    object

    任意

    ビジネスパラメーター。

    Meta

    object

    任意

    エージェントのバインド、会話ソース、タグ情報を含む拡張メタデータ。

    Agent

    object

    任意

    会話のエージェント構成。有効な値は、ListAgents 操作によって返される結果です。

    AgentName

    string

    任意

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

    dataworks_data_agent
    Config

    object

    任意

    会話のパラメータ設定 (会話ソースや会話タグに基づくパラメータ設定のフィルターなど)。

    SessionSource

    string

    任意

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

    openapi_sdk
    SessionTags

    array<object>

    任意

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

    object

    任意

    SessionTagCode

    string

    任意

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

    chatbi
    InitialConfigOptions

    object

    任意

    エージェント実行環境の高度なパラメータ設定。

    ExecutionLane

    string

    任意

    chat，cli
    Mode

    string

    任意

    yolo
    Skills

    string

    任意

    skill-name-1,skill-name2,skill-name-3
    ResourceGroupId

    string

    任意

    Serverless_res_group_123123123_564657857

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター (result)。

    RequestId

    string

    リクエスト ID。

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

    object

    JSON-RPC 応答。

    Jsonrpc

    string

    JSON-RPC バージョン。値を 2.0 に設定します。

    2.0
    Id

    string

    呼び出し元によって指定されたリクエスト 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"
    }
  }
}

    エラーコード

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

    変更履歴

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