completion 模式下,每次调用各自提交输入值并返回一条回复,调用之间不保留会话状态。
生成文本
- 发送消息:将
inputs中的取值填入应用的提示词模板并生成回复。阻塞式返回在生成完成后一次性返回全部内容;流式返回持续输出message事件,直至message_end(应用开启文字转语音自动播放时还会收到tts_message事件)。 - 停止响应:在回复完成前中断流式输出。
处理文件
- 上传文件:上传图片、文档、音频或视频文件,供 发送消息 引用。文件仅限上传的终端用户使用。
- 下载文件:预览或下载已上传的文件,前提是该文件属于当前应用内的某条消息。
- 获取终端用户信息:根据终端用户 ID(例如上传文件响应中的
created_by)查询该用户的详细信息。
语音转写与合成
获取应用信息与配置
- 获取应用基本信息:返回应用的名称、描述、标签和模式。
- 获取应用参数:返回调用需在
inputs中传入的字段(名称、类型、默认值),以及应用的功能开关,可据此构建请求或客户端界面。 - 获取应用元数据:返回工具图标等配置元数据。
- 获取应用 WebApp 设置:返回 WebApp 的站点配置、主题和自定义选项。