全部產品
Search

搜尋本產品

    DataWorks：CreateAgentSession

    文件中心

    DataWorks：CreateAgentSession

    更新時間：Jul 13, 2026

    建立新的 Agent 工作階段並傳回工作階段 ID。

    介面說明

    請求說明

    • 此介面用於建立新的 Agent 工作階段。

    • 透過 _meta.agent.agentName 指定綁定的 Agent 名稱，此為必填項目。

      • dataworks_data_agent：DataWorks 系統內建智慧代理 (Agent) — Data Agent，涵蓋資料整合、開發、維運、治理與分析全鏈路的智慧化資料開發 AI 能力。

      • dataworks_chatbi_agent：DataWorks 系統內建智慧代理 (Agent) — ChatBI，基於自然語言處理與智慧分析技術，透過對話互動實現從需求解析、資料擷取、程式碼自動產生到視覺化報告輸出的全流程自動化分析。

    • 可以透過 _meta.config.sessionSource 透傳工作階段來源識別碼，便於後續按來源檢索。

    • 支援透過 _meta.config.sessionTags[].sessionTagCode 傳入工作階段標籤。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dataworks:CreateAgentSession

    create

    *全部資源。

    *

    		 無 無

    請求文法

    POST  HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Jsonrpc

    string

    否

    JSON-RPC 版本，固定為 2.0。

    2.0
    Id

    string

    否

    請求方傳入的 id，原樣回顯。

    4758330557805415712
    Params

    object

    否

    業務參數。

    Meta

    object

    否

    擴充中繼資訊，承載 Agent 綁定、工作階段來源、標籤等。

    Agent

    object

    否

    該工作階段執行的 Agent 設定，取值範圍為 ListAgents 介面傳回的結果。

    AgentName

    string

    否

    會話綁定的 Agent 名稱，必填

    dataworks_data_agent
    Config

    object

    否

    Session 設定參數，例如基於 Session 來源、Session Tag 的篩選參數設定。

    SessionSource

    string

    否

    會話來源標識，便於按來源檢索。比如 Agent 可以在 A 頁面使用，也可以在 B 頁面進行使用，此時如果有需求需要在 A 頁面只展示 A 頁面建立出來的 Session，就可以基於該參數進行過濾。長度不超過 128 位，支援英文字母+數字+中劃線+底線組合。

    openapi_sdk
    SessionTags

    array<object>

    否

    會話標籤列表，後續可以基於會話標籤進行搜尋過濾。

    object

    否

    SessionTagCode

    string

    否

    會話標籤。可以基於會話標籤進行過濾，比如調用 OpenAPI 的時候用的是固定的 RAM 子帳號，但是調用系統中有自己的帳號體系，此時需要基於帳號 ID 過濾 Session 列表，該標籤就可以傳調用系統的帳號 ID。長度不超過 128 位，支援英文字母+數字+中劃線+底線組合。

    chatbi
    InitialConfigOptions

    object

    否

    Agent 執行環境的進階參數設定。

    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 of the request

    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

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。