You need to enable JavaScript to run this app.
文档中心
数据智能体 DataAgent(私有化)

数据智能体 DataAgent(私有化)

复制全文
下载 pdf
会话管理
IDA-获取会话详情
复制全文
下载 pdf
IDA-获取会话详情

获取会话详情(Session Info)

根据 sessionId 获取会话基本信息;可选返回消息列表与(DeepResearch/A2A 场景下的)任务历史。

请求说明

项目

内容

请求方式

GET

请求地址

https://${IDA_DOMAIN}/dataAgent/llm/openApi/v2/signed/agent/sessionInfo

默认鉴权

Authorization: Bearer ${JWT_TOKEN}

请求参数(Query)

参数名

类型

必填

默认值

示例

说明

sessionId

integer

是

14468

会话 ID。

needMsg

boolean

否

false

true

是否返回会话消息列表。false 时 data.messageList 为空数组。

maxMsgCount

integer

否

20

返回的最大消息条数。仅在 needMsg=true 时生效。

说明:如果会话属于 DeepResearch/A2A 类型,响应中可能包含 data.tasks 作为任务历史;其他会话类型可能返回空数组。任务仍在执行时,接口会结合最新任务状态更新会话状态(如 latestTaskStatus)。

请求示例

标准 Curl 示例:

curl -X GET \
  "https://${IDA_DOMAIN}/dataAgent/llm/openApi/v2/signed/agent/sessionInfo?sessionId=14468&needMsg=true&maxMsgCount=20" \
  -H "Authorization: Bearer ${JWT_TOKEN}" \
  -H 'Content-Type: application/json' \
  --silent | jq

HTTP 示例:

GET https://${IDA_DOMAIN}/dataAgent/llm/openApi/v2/signed/agent/sessionInfo?sessionId=8350&needMsg=true&maxMsgCount=20

返回参数

返回参数

参数名

类型

说明

code

string

请求结果码,成功为 llm/ok。

msg

object

提示信息,成功时通常为空对象。

data

object

业务数据。

data.messageList

array

会话消息列表;needMsg=false 时为空数组。

data.tasks

array

会话关联任务列表(DeepResearch/A2A 会话可能返回);无任务时为空数组。

data.sessionInfo

object

会话详情。

data.sessionInfo.id

integer

会话 ID。

data.sessionInfo.name

string

会话名称。

data.sessionInfo.emailPrefix

string

会话创建人邮箱前缀。

data.sessionInfo.dataSetId

integer

null

data.sessionInfo.sessionType

string

会话类型,例如 normal。

data.sessionInfo.scene

string

会话场景,例如 data_set。

data.sessionInfo.version

string

会话上下文版本,例如 v5。

data.sessionInfo.createTime

string

会话创建时间。

data.sessionInfo.lastActiveTime

string

会话最后活跃时间。

data.sessionInfo.serverTime

string

服务端当前时间。

data.sessionInfo.isExpired

boolean

会话是否已过期。

data.sessionInfo.isKnowledgeQA

boolean

是否为知识问答会话。

data.sessionInfo.isMixed

boolean

是否为混合会话。

data.sessionInfo.isBackendCreated

boolean

是否由后端创建。

data.sessionInfo.submittedViaInternalA2a

boolean

是否通过内部 A2A 提交。

data.sessionInfo.restrictMode

integer

会话限制模式。

data.sessionInfo.latestTaskStatus

string

null

data.sessionInfo.fileList

array

会话上传文件列表。

data.sessionInfo.linkEmbed

array

会话关联链接资源。

data.sessionInfo.mcpServers

array

会话启用的 MCP Server 列表。

data.sessionInfo.customTag

array

会话自定义标签。

data.sessionInfo.extraInfo

object

会话扩展信息。

data.sessionInfo.generalAgentInfo

object

通用 Agent 扩展信息。

data.sessionInfo.reportId

integer

null

data.sessionInfo.storageId

string

null

data.sessionInfo.queryHistoryId

integer

null

data.sessionInfo.relatedQueryId

integer

null

data.sessionInfo.relatedQueryQuestion

string

null

data.sessionInfo.relatedQueryDataSetId

integer

null

data.sessionInfo.relatedQueryDataSetIdList

array

null

data.sessionInfo.originReportStorageId

string

null

data.sessionInfo.originDataPreviewMode

string

null

data.sessionInfo.xPageUrl

string

null

data.sessionInfo.agentInfo

object

会话所属 Agent 信息。

data.sessionInfo.agentInfo.id

integer

Agent ID。

data.sessionInfo.agentInfo.name

string

Agent 名称。

data.sessionInfo.agentInfo.description

string

Agent 描述。

data.sessionInfo.agentInfo.detail

object

null

data.sessionInfo.agentInfo.avatar

string

Agent 头像标识。

data.sessionInfo.agentInfo.agentType

string

Agent 类型,例如 Expert。

data.sessionInfo.agentInfo.agentMode

string

Agent 当前模式,例如 knowledgeQA。

data.sessionInfo.agentInfo.creatorPrefix

string

Agent 创建人邮箱前缀。

data.sessionInfo.agentInfo.privilegeType

string

权限类型,例如 agent。

data.sessionInfo.agentInfo.modelTypeStandardName

string

模型类型标准名称。

data.sessionInfo.agentInfo.isAgentAdmin

boolean

当前用户是否为 Agent 管理员。

data.sessionInfo.agentInfo.isDeepResearchOpen

boolean

是否开启深度研究能力。

data.sessionInfo.agentInfo.isDeepResearchQueryOpen

boolean

是否开启深度研究取数链路。

data.sessionInfo.agentInfo.isInsightReportOpen

boolean

是否开启洞察报告能力。

data.sessionInfo.agentInfo.isSmartQueryOpen

boolean

是否开启智能问数能力。

data.sessionInfo.agentInfo.isKnowledgeQASeen

boolean

是否展示知识问答能力。

data.sessionInfo.agentInfo.isSkillMarketPlaceEnable

boolean

是否开启技能市场。

data.sessionInfo.agentInfo.uploadSkillOnSessionEnable

boolean

会话内是否允许上传技能。

data.sessionInfo.agentInfo.deepResearchUploadSkillOnSessionEnable

boolean

深度研究会话内是否允许上传技能。

data.sessionInfo.agentInfo.isBuiltinPPTTemplateSelectionEnable

boolean

是否开启内置 PPT 模板选择。

data.sessionInfo.agentInfo.enableMultiReport

boolean

是否开启多报告能力。

data.sessionInfo.agentInfo.multiReportNums

integer

多报告数量上限。

data.sessionInfo.agentInfo.supportKnowledgeEngine

boolean

是否支持知识引擎。

data.sessionInfo.agentInfo.knowledgeEngines

object

不同模式使用的知识引擎配置。

data.sessionInfo.agentInfo.knowledgeEngines.knowledgeQA

string

知识问答使用的知识引擎。

data.sessionInfo.agentInfo.knowledgeEngines.deepresearch

string

深度研究使用的知识引擎。

data.sessionInfo.agentInfo.config

object

Agent 配置。

data.sessionInfo.agentInfo.config.isNewAgent

boolean

是否为新版 Agent 配置。

data.sessionInfo.agentInfo.config.dateCalcSw

boolean

是否开启日期计算开关。

data.sessionInfo.agentInfo.config.defaultKnowledgeBaseId

integer

默认知识库 ID。

data.sessionInfo.agentInfo.config.defaultKnowledgeTenantId

integer

默认知识库租户 ID。

data.sessionInfo.agentInfo.config.defaultKnowledgeBaseInitd

boolean

默认知识库是否已初始化。

data.sessionInfo.agentInfo.config.useKnowledgeEngineKb

boolean

是否使用知识引擎知识库。

data.sessionInfo.agentInfo.config.knowledgeEnginePriority

string

知识引擎优先级,例如 user。

data.sessionInfo.agentInfo.config.isInsightReportOpen

boolean

配置层洞察报告开关。

data.sessionInfo.agentInfo.config.visibleAgentModes

array

可见 Agent 模式列表。

data.sessionInfo.agentInfo.config.oncallEntrance

string

Oncall 入口 URL。

data.sessionInfo.agentInfo.config.knowledgeQa

object

知识问答配置。

data.sessionInfo.agentInfo.config.knowledgeQa.scene

object

知识问答场景配置。

data.sessionInfo.agentInfo.config.knowledgeQa.tools

object

知识问答可用工具配置。

data.sessionInfo.agentInfo.config.knowledgeQa.tools.python.enabled

boolean

是否启用 Python 工具。

data.sessionInfo.agentInfo.config.knowledgeQa.tools.sql.enabled

boolean

是否启用 SQL 工具。

data.sessionInfo.agentInfo.config.knowledgeQa.tools.webSearch.enabled

boolean

是否启用 Web 搜索工具。

data.sessionInfo.agentInfo.config.knowledgeQa.tools.queryAeolusReport.enabled

boolean

是否启用 Aeolus 报告查询工具。

data.sessionInfo.agentInfo.config.knowledgeQa.tools.queryHiveTableInfo.enabled

boolean

是否启用 Hive 表信息查询工具。

data.sessionInfo.agentInfo.config.knowledgeQa.tools.search.knowledgeBase.enabled

boolean

是否启用知识库搜索。

data.sessionInfo.agentInfo.config.knowledgeQa.tools.search.aeolusAsset.enabled

boolean

是否启用 Aeolus 资产搜索。

返回示例

{
  "JSONIFY_PRETTYPRINT_REGULAR": false,
  "code": "llm/ok",
  "data": {
    "messageList": [],
    "sessionInfo": {
      "agentInfo": {
        "agentMode": "knowledgeQA",
        "agentType": "Expert",
        "avatar": "system3",
        "config": {
          "dateCalcSw": true,
          "defaultKnowledgeBaseId": 118,
          "defaultKnowledgeBaseInitd": true,
          "defaultKnowledgeTenantId": 8000000000001,
          "isInsightReportOpen": false,
          "isNewAgent": true,
          "knowledgeEnginePriority": "user",
          "knowledgeQa": {
            "scene": {},
            "tools": {
              "python": {
                "enabled": true
              },
              "queryAeolusReport": {
                "enabled": true
              },
              "queryHiveTableInfo": {
                "enabled": true
              },
              "search": {
                "aeolusAsset": {
                  "enabled": false
                },
                "knowledgeBase": {
                  "enabled": true
                }
              },
              "sql": {
                "enabled": true
              },
              "webSearch": {
                "enabled": true
              }
            }
          },
          "oncallEntrance": "https://cloud.bytedance.net/oncall/chats/user/index?lang=zh-CN&open_in_browser=true&x-resource-account=public&x-bc-region-id=bytedance&tenantId=28603&step=self-solve",
          "useKnowledgeEngineKb": true,
          "visibleAgentModes": []
        },
        "creatorPrefix": "admin",
        "deepResearchUploadSkillOnSessionEnable": false,
        "description": "openApi 测试",
        "detail": null,
        "enableMultiReport": false,
        "id": 430,
        "isAgentAdmin": true,
        "isBuiltinPPTTemplateSelectionEnable": false,
        "isDeepResearchOpen": true,
        "isDeepResearchQueryOpen": true,
        "isInsightReportOpen": true,
        "isKnowledgeQASeen": true,
        "isSkillMarketPlaceEnable": true,
        "isSmartQueryOpen": true,
        "knowledgeEngines": {
          "deepresearch": "knowledgeBase",
          "knowledgeQA": "knowledgeBase"
        },
        "modelTypeStandardName": "GPT模型",
        "multiReportNums": 1,
        "name": "openApi",
        "privilegeType": "agent",
        "supportKnowledgeEngine": true,
        "uploadSkillOnSessionEnable": true
      },
      "createTime": "2026-08-11 16:41:55",
      "customTag": [],
      "dataSetId": null,
      "emailPrefix": "admin",
      "extraInfo": {},
      "fileList": [],
      "generalAgentInfo": {},
      "id": 14468,
      "isBackendCreated": false,
      "isExpired": false,
      "isKnowledgeQA": false,
      "isMixed": false,
      "lastActiveTime": "2026-08-11 16:41:55",
      "latestTaskStatus": null,
      "linkEmbed": [],
      "mcpServers": [],
      "name": "OpenAPI 数据问答",
      "originDataPreviewMode": null,
      "originReportStorageId": null,
      "queryHistoryId": null,
      "relatedQueryDataSetId": null,
      "relatedQueryDataSetIdList": null,
      "relatedQueryId": null,
      "relatedQueryQuestion": null,
      "reportId": null,
      "restrictMode": 0,
      "scene": "data_set",
      "serverTime": "2026-08-12 10:01:27",
      "sessionType": "normal",
      "storageId": null,
      "submittedViaInternalA2a": false,
      "version": "v5",
      "xPageUrl": null
    },
    "tasks": []
  },
  "msg": {}
}
最近更新时间:2026.08.17 14:12:01
这个页面对您有帮助吗?
有用
有用
无用
无用