CreateDataAgentSession - 创建DataAgent会话

更新时间:
复制为 MD 格式

创建DataAgent会话

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:CreateDataAgentSession

create

*全部资源

*

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

DMSUnit

string

当前 DMS 单元

cn-hangzhou

Title

string

标题,支持中英文,最大长度 128 位。

帮我分析一下这份数据,给出报告。

File

string

文件 Id

f-8*******01m

SessionConfig

object

会话配置信息

Language

string

语言

  • CHINESE 中文

  • ENGLISH 英语

CHINESE

CustomAgentId

string

自定义 Agent Id

ca-e*******ckd

CustomAgentStage

string

自定义 Agent 的使用阶段:

  • debug 调试阶段

  • prod 正式生产阶段

debug

Mode

string

模式:

  • ASK_DATA 问数模式

  • ANALYSIS 分析模式

  • INSIGHT 洞察模式

ANALYSIS

EnableSearch

boolean

是否开启联网搜索。

false

McpServerIds

array

会话配置中的 MCP 服务器 ID 列表

string

会话配置中的 MCP 服务器 ID

2q1tu90**********6uttu2nw

UserOssBucket

string

用户 OSS Bucket 名称

  • 分析过程文件、报告产物可上传到用户指定的 OSS Bucket

user-oss-bucket

WorkspaceId

string

工作空间 ID。

12****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

1CB***********3F1A

Data

object

返回结构体

SessionId

string

Agent 会话 Id

976*********p

SessionStatus

string

会话状态

RUNNING

AgentId

string

Agent Id

cu0cs*******mf

AgentStatus

string

Agent 状态

RUNNING

Title

string

标题

帮我分析一下这份数据,给出报告。

File

string

文件的基本信息。

f-8*******01m

SessionConfig

object

会话配置信息

Language

string

语言

  • CHINESE 中文

  • ENGLISH 英语

CHINESE

CustomAgentId

string

自定义 Agent Id

ca-e*******ckd

CustomAgentStage

string

自定义 Agent 的使用阶段:

  • debug 调试阶段

  • prod 正式生产阶段

debug

Mode

string

模式:

  • ASK_DATA 问数模式

  • ANALYSIS 分析模式

  • INSIGHT 洞察模式

ANALYSIS

EnableSearch

boolean

是否开启联网搜索。

true

McpServerIds

array

会话配置中的 MCP 服务器 ID 列表

string

会话配置中的 MCP 服务器 ID

2q1tu90**********6uttu2nw

UserOssBucket

string

用户 OSS Bucket 名称

  • 分析过程文件、报告产物可上传到用户指定的 OSS Bucket

user-oss-bucket

CreateTime

integer

会话的创建时间

1765262307992

Saved

boolean

是否被当前登录人收藏

false

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功。

  • false:请求失败。

true

ErrorCode

string

错误码。

success

ErrorMessage

string

调用失败时,返回的错误信息。

UnknownError

示例

正常返回示例

JSON格式

{
  "RequestId": "1CB***********3F1A",
  "Data": {
    "SessionId": "976*********p",
    "SessionStatus": "RUNNING",
    "AgentId": "cu0cs*******mf",
    "AgentStatus": "RUNNING",
    "Title": "帮我分析一下这份数据,给出报告。",
    "File": "f-8*******01m",
    "SessionConfig": {
      "Language": "CHINESE",
      "CustomAgentId": "ca-e*******ckd",
      "CustomAgentStage": "debug",
      "Mode": "ANALYSIS",
      "EnableSearch": true,
      "McpServerIds": [
        "2q1tu90**********6uttu2nw"
      ],
      "UserOssBucket": "user-oss-bucket"
    },
    "CreateTime": 1765262307992,
    "Saved": false
  },
  "Success": true,
  "ErrorCode": "success",
  "ErrorMessage": "UnknownError"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情