Appearance
应用配置
获取已发布应用的交互配置(开场白、用户问题建议、语音、运行设置),用于客户端在对话前初始化界面。返回的是应用配置中的 interaction_config 扁平化结果。
- 接口路径:
POST /v1/openapi/app/parameters
INFO
Agent、AgentLite、ChatFlow 和 TextCompletion 均可调用,返回对应应用已发布版本的交互配置。
请求头
| 参数名 | 必填 | 说明 |
|---|---|---|
| Content-Type | 是 | application/json |
| Authorization | 是 | 鉴权凭证,格式 Bearer sk_xxx |
请求参数
json
{
"app_id": "", // 必填-应用ID
"version": "" // 版本号(可选),为空时获取最新发布版本
}| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| app_id | string(uuid) | 是 | 应用 ID |
| version | string | 否 | 语义版本号(如 1.0.1),为空时取最新发布版本 |
返回数据
json
{
"code": 200,
"message": "success",
"data": {
"chat_prologue": {
"status": 1,
"prologue": "您好,我是您的医疗助手,有什么可以帮您?",
"suggested_questions": [
{"question": "帮我解读体检报告", "icon": ""}
]
},
"user_suggestion": {
"status": 1,
"custom_prompt": 0,
"prologue": ""
},
"voice": {
"tts": {"status": 1, "provider": "doubao", "code": "zh_female_xxx"},
"asr": {"status": 1, "provider": "doubao"}
},
"vision": {
"status": 1,
"resolution": "high",
"upload_method": "local",
"upload_limit": 5
},
"runtime_setting": {
"max_steps": 40,
"reconnect": 1
}
}
}chat_prologue 开场白
| 字段 | 类型 | 说明 |
|---|---|---|
| status | uint8 | 是否启用:0-禁用、1-启用 |
| prologue | string | 开场白文案 |
| suggested_questions | array | 推荐问题列表,每项含 question 与 icon |
user_suggestion 用户问题建议
| 字段 | 类型 | 说明 |
|---|---|---|
| status | uint8 | 是否启用:0-禁用、1-启用 |
| custom_prompt | uint8 | 是否使用自定义提示词:0-否、1-是 |
| prologue | string | 自定义提示词内容 |
voice 语音配置
| 字段 | 类型 | 说明 |
|---|---|---|
| tts.status | uint8 | 文字转语音是否启用:0-禁用、1-启用 |
| tts.provider | string | TTS 服务提供方 |
| tts.code | string | 音色编码 |
| asr.status | uint8 | 语音转文字是否启用:0-禁用、1-启用 |
| asr.provider | string | ASR 服务提供方 |
vision 视觉配置
| 字段 | 类型 | 说明 |
|---|---|---|
| status | uint8 | 多模态图片输入是否启用:0-禁用、1-启用 |
| resolution | string | 图片分辨率档位:low / high / auto |
| upload_method | string | 上传方式:local-本地上传、url-URL 链接 |
| upload_limit | int | 单次最大上传图片数量 |
runtime_setting 运行设置
| 字段 | 类型 | 说明 |
|---|---|---|
| max_steps | uint16 | 单次对话的最大执行步骤数(默认 40) |
| reconnect | uint8 | SSE 断连续传是否启用:0-禁用、1-启用(默认启用)。启用时客户端可通过 action=reconnect 重连并回放错过的事件 |
