OpenAI ChatKit 线程接口
2026-11-20 13:54 更新
线程接口用于读取或删除聊天线程,也可以分页查询单个线程的消息、组件和其他条目。
| 请求 | 接口参考 | 用途 |
|---|---|---|
GET /chatkit/threads/{thread_id} |
获取 ChatKit 线程 | 按线程 ID 返回线程信息。 |
DELETE /chatkit/threads/{thread_id} |
删除 ChatKit 线程 | 按线程 ID 删除线程并返回删除结果。 |
GET /chatkit/threads |
列出 ChatKit 线程 | 分页查询线程。 |
GET /chatkit/threads/{thread_id}/items |
列出 ChatKit 线程条目 | 分页查询指定线程中的条目。 |
线程对象与分页
| 类型 | 字段要点 |
|---|---|
ChatKitThread |
包含 ID、创建时间、用户、可为 null 的标题,以及 active、locked 或 closed 状态。后两种状态可查看原因字段。 |
ThreadDeleteResponse |
包含线程 ID 和布尔值 deleted,对象类型为 chatkit.thread.deleted。 |
ChatKitThreadItemList |
data 包含本页条目,has_more 表示还有后续条目,页首和页尾 ID 可为 null。 |
线程条目与内容
| 类型 | 字段要点 |
|---|---|
ChatKitThreadUserMessageItem |
包含用户输入或引用文本、附件以及可为 null 的推理选项。 |
ChatKitThreadAssistantMessageItem |
content 为助手生成的文本条目列表。 |
ChatKitResponseOutputText |
包含文本和注释列表;注释按 type 区分文件与 URL。 |
ChatKitAttachment |
包含 ID、名称、MIME 类型、可为 null 的预览地址,以及 image 或 file 类型。 |
ChatKitWidgetItem |
widget 字段为字符串,条目类型为 chatkit.widget。 |
条目列表还可包含 ChatKitClientToolCall、ChatKitTask 和 ChatKitTaskGroup。它们与消息和组件的完整字段见列出 ChatKit 线程条目。
会话类型索引
线程参考也列出 11 个会话相关类型,供查阅请求配置和响应结构。创建 ChatKit 会话包含这些字段,取消 ChatKit 会话返回更新后的会话对象。
| 用途 | 类型 |
|---|---|
| 会话响应 | ChatSession、ChatSessionStatus |
| 生效配置 | ChatSessionChatKitConfiguration、ChatSessionAutomaticThreadTitling、ChatSessionFileUpload、ChatSessionHistory、ChatSessionRateLimits |
| 创建时的参数 | ChatSessionChatKitConfigurationParam、ChatSessionExpiresAfterParam、ChatSessionRateLimitsParam、ChatSessionWorkflowParam |
工作流响应类型见 ChatKit 接口总览。
以上内容是否对您有帮助:

TRAE-AI编程


更多建议: