GetChatSessionList - 获取文档会话列表

更新时间:
复制为 MD 格式

获取用户问答会话列表。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

energy:GetChatSessionList

none

*全部资源

*

请求语法

POST /api/v2/aidoc/document/chat/session/list HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

body

object

请求参数。

name

string

会话名称。

oklabs

userId

string

用户的唯一标识,如果不填写默认使用 sdk 调用账号作为用户 ID。

12222

currentPage

integer

分页参数,页码,默认 1。

1

pageSize

integer

分页大小,默认 10。

10

返回参数

名称

类型

描述

示例值

object

返回结果。

requestId

string

请求 ID。

83A5A7DD-8974-5769-952E-590A97BEA34E

data

object

返回数据

sessionList

array<object>

会话列表。

object

sessionId

string

问答会话 ID,用于记录同一个用户的多次问答。

5c748ef9-3f23-4b5a-916f-966c0d2c6dcd

name

string

会话名称

student_app_spelling

userId

string

当前会话的用户 ID。

12222

folderId

string

文件夹 ID,用于指定查询的文档范围。

3493370b-4884-47dd-95ed-49038769af53

createTime

integer

报告创建时间戳,格式为毫秒时间戳。

2025-01-01T14:45:17Z

updateTime

integer

修改时间,格式为毫秒时间戳。

2024-12-30T02:05:03Z

total

integer

总记录数。

21

totalPage

integer

总页数

3

currentPage

integer

当前页码。

1

pageSize

integer

分页大小。

10

示例

正常返回示例

JSON格式

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E\n",
  "data": {
    "sessionList": [
      {
        "sessionId": "5c748ef9-3f23-4b5a-916f-966c0d2c6dcd",
        "name": "student_app_spelling",
        "userId": "12222",
        "folderId": "3493370b-4884-47dd-95ed-49038769af53",
        "createTime": 0,
        "updateTime": 0
      }
    ],
    "total": 21,
    "totalPage": 3,
    "currentPage": 1,
    "pageSize": 10
  }
}

错误码

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

变更历史

更多信息,参考变更详情