跳转到主要内容
GET
获取 AI 助手会话记录

使用方法

使用此端点从你的文档中导出 AI 助手的会话历史。每个会话都包括用户查询、助手回复、引用的来源、解决状态以及查询类别。 使用响应中返回的 cursor 参数对结果进行分页。当 hasMoretrue 时继续获取。

筛选

使用 dateFromdateTo 参数按日期范围过滤会话。

会话数据

每个会话包含:
  • query: 用户的问题
  • response: AI 助手的回答
  • sources: 回答中引用的页面,包括标题和 URL
  • resolutionStatus: AI 助手是否成功回答了问题。值为 answeredunanswered。使用此字段可跟踪并分析 AI 助手无法解答的用户问题所暴露出的文档缺口。
  • queryCategory: query 的类型分类(如果可用)
  • pageUrl: 会话开始时所在文档页面的完整 URL;如果没有可用的页面路径,则为 null。使用此字段可将会话归因到具体页面。

速率限制

此端点允许每个组织每小时最多 100 次请求。所有分析端点共享此限制。

授权

Authorization
string
header
必填

Authorization 请求头需要使用 Bearer 令牌。请使用管理员 API 密钥。这是仅供服务端使用的机密密钥。你可以在控制台的 API 密钥页面 中生成一个。

路径参数

projectId
string
必填

你的项目 ID,可在控制台的 API keys 页面中复制。

查询参数

dateFrom
string

ISO 8601 或 YYYY-MM-DD 格式的日期

示例:

"2024-01-01"

dateTo
string

ISO 8601 或 YYYY-MM-DD 格式的日期。dateTo 为不包含在内的上限。结果将包含早于该日期的记录,但不包含该日期当天的记录。

示例:

"2024-01-01"

limit
number
默认值:100

每页返回的最大结果数

必填范围: 1 <= x <= 1000
cursor
string<ulid>

分页游标(ULID 格式)

响应

包含分页信息的会话数据

conversations
object[]
必填

AI 助手会话列表。

nextCursor
string | null
必填

用于获取下一页结果的游标;如果没有更多结果则为 null。

hasMore
boolean
必填

指示在当前页之外是否还有更多可用结果。