对话型应用 API

本文档由 AI 自动翻译。如有任何不准确之处，请参考 英文原版。

​

发送消息并接收流式回复

• 发送对话消息：向聊天助手或 Agent 应用发送用户提问。阻塞式返回在回复完成后一次性返回全部内容；Agent 应用仅支持流式返回。
• 停止响应：在回复完成前中断流式输出。
• 获取下一轮建议问题列表：回复完成后，基于当前对话内容推荐后续问题。

​

管理会话

• 获取会话列表：按最近活跃时间排序，返回当前用户的会话。
• 获取会话历史消息：返回某个会话的历史消息，适合滚动加载的聊天界面。
• 重命名会话：设置或自动生成会话名称。
• 删除会话：删除指定会话。
• 获取对话变量：读取会话在多轮对话间保留的变量值。
• 更新对话变量：直接修改其中某个变量的值。

​

处理文件

• 上传文件：上传图片、文档、音频或视频文件，供 发送对话消息 引用。文件仅限上传的终端用户使用。
• 下载文件：预览或下载已上传的文件，前提是该文件属于当前应用内的某条消息。
• 获取终端用户信息：根据终端用户 ID（例如上传文件响应中的 created_by）查询该用户的详细信息。

​

语音转写与合成

• 语音转文字：将上传的音频文件（MP3、M4A、WAV、AMR 或 MPGA，最大 30 MB）转写为文字，让终端用户用语音代替打字输入。
• 文字转语音：将回复合成为语音。

​

获取应用信息与配置

• 获取应用基本信息：返回应用的名称、描述、标签和模式。
• 获取应用参数：返回调用需在 inputs 中传入的字段（名称、类型、默认值），以及应用的功能开关，可据此构建请求或客户端界面。
• 获取应用元数据：返回工具图标等配置元数据。
• 获取应用 WebApp 设置：返回 WebApp 的站点配置、主题和自定义选项。

​

收集反馈

• 提交消息反馈：终端用户将回复评为 like 或 dislike，并可附加文字说明。
• 获取应用的消息反馈：返回应用内终端用户和管理员提交的全部反馈。

​

管理标注

• 创建标注、获取标注列表、更新标注、删除标注：管理标注集合。
• 配置标注回复：开启或关闭标注匹配。该变更异步执行。
• 查询标注回复配置任务状态：使用返回的任务 ID 轮询，确认变更已完成。