DescribeDataAgentSession - 获取DataAgent会话描述

获取DataAgent会话描述信息

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

DMSUnit

string

当前 DMS 单元

cn-hangzhou

SessionId

string

Agent 会话 ID

c61n7gm******rj

WorkspaceId

string

工作空间 ID。

12****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

18****-*****-*******7A3122F

Data

object

返回的结构体

SessionId

string

Agent 会话 Id

976*********p

SessionStatus

string

会话状态

RUNNING

AgentId

string

当前 Agent Id

cu0cs*******mf

AgentStatus

string

当前 Agent 状态

RUNNING

Title

string

标题

分析一下这份文件,给出报告。

ChatHistoryLocations

array<object>

会话回放历史

object

会话回放的元素

Key

string

会话回放历史的 Key

testKey1

Url

string

会话回放历史的 OSS 下载链接

****

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

是否开启联网搜索。

True

McpServerIds

array

string

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

CreateTime

integer

会话创建时间

1731645908000

Saved

boolean

是否被当前登录人收藏

true

FavoriteInWorkspace

string

是否在工作空间中被当前登录人收藏

true

UserId

string

会话拥有人 Id

2096******

Success

boolean

返回值说明。

  • true:删除成功。

  • false:删除失败。

true

ErrorCode

string

错误码。

success

ErrorMessage

string

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

UnknownError

示例

正常返回示例

JSON格式

{
  "RequestId": "18****-*****-*******7A3122F",
  "Data": {
    "SessionId": "976*********p",
    "SessionStatus": "RUNNING",
    "AgentId": "cu0cs*******mf",
    "AgentStatus": "RUNNING",
    "Title": "分析一下这份文件,给出报告。",
    "ChatHistoryLocations": [
      {
        "Key": "testKey1",
        "Url": "****"
      }
    ],
    "File": "f-8*******01m",
    "SessionConfig": {
      "Language": "CHINESE",
      "CustomAgentId": "ca-e*******ckd",
      "CustomAgentStage": "debug",
      "Mode": "ANALYSIS",
      "EnableSearch": true,
      "McpServerIds": [
        "2q1tu90**********6uttu2nw"
      ]
    },
    "CreateTime": 1731645908000,
    "Saved": true,
    "FavoriteInWorkspace": "true",
    "UserId": "2096******"
  },
  "Success": true,
  "ErrorCode": "success",
  "ErrorMessage": "UnknownError"
}

错误码

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

变更历史

更多信息,参考变更详情