互动应用管理

更新时间：2025-10-28

互动应用绑定Function模板

接口描述

在互动应用已创建后，绑定Function模板

请求语法

                JSON
                
                PUT /api/v{version}/apps/{appId}/llm HTTP/1.1
host: rtc-aiagent.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

除公共头域外，无其它特殊头域。

请求路径参数

名称	类型	是否必选	参数位置	描述
appId	String	是	RequestBody	大模型互动应用ID

请求体

名称	类型	是否必选	参数位置	描述
type	String	是	RequestBody	大模型类型，取值必须是SYSTEM
functionTemplateId	Long	是	RequestBody	Function模板id

请求示例

                JSON
                
            

                PUT /api/v1/apps/appxxx/llm  HTTP/1.1
host: rtc-aiagent.baidubce.com
content-type: application/json
authorization: {bce-authorization-string}
x-bce-request-id: {bce-request-id}
{
    "type": "SYSTEM",
    "functionTemplateId": 1000000
}
            

响应头域

除公共头域外，无其它特殊头域。

响应参数

N/A

响应示例

                JSON
                
            

                HTTP/1.1 200 OK
x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
date: Mon, 05 Sep 2022 03:25:43 GMT
transfer-encoding: chunked
content-type: application/json;charset=UTF-8
cache-control: no-cache
            

查询系统角色

接口描述

查询系统提供的角色列表

请求语法

                JSON
                
                GET /api/v{version}/scene_roles HTTP/1.1
host: rtc-aiagent.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

除公共头域外，无其它特殊头域。

请求参数

N/A

请求示例

                JSON
                
            

                GET /api/v1/scene_roles  HTTP/1.1
host: rtc-aiagent.baidubce.com
content-type: application/json
authorization: {bce-authorization-string}
x-bce-request-id: {bce-request-id}
            

响应头域

除公共头域外，无其它特殊头域。

响应参数

名称	类型	描述
data	List	系统角色列表
+ id	Long	角色id
+ name	String	角色名称
+ description	String	角色描述

响应示例

                JSON
                
            

                HTTP/1.1 200 OK
x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
date: Mon, 05 Sep 2022 03:25:43 GMT
transfer-encoding: chunked
content-type: application/json;charset=UTF-8
cache-control: no-cache

{
    "data": [
        {
            "id": 5,
            "name": "北极熊",
            "description": "北极熊"
        },
        {
            "id": 6,
            "name": "情感陪伴老师",
            "description": "情感陪伴老师"
        }
    ]
}
            

互动应用角色列表查询

接口描述

查询互动应用角色列表

请求语法

                JSON
                
                GET /api/v{version}/apps/{appId} HTTP/1.1
host: rtc-aiagent.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

除公共头域外，无其它特殊头域。

请求路径参数

名称	类型	是否必选	参数位置	描述
appId	String	是	RequestBody	大模型互动应用ID

请求参数

N/A

请求示例

                JSON
                
            

                GET /api/v1/apps/appxxx  HTTP/1.1
host: rtc-aiagent.baidubce.com
content-type: application/json
authorization: {bce-authorization-string}
x-bce-request-id: {bce-request-id}
            

响应头域

除公共头域外，无其它特殊头域。

响应参数

名称	类型	描述
llm	Object	互动应用大模型配置
+ roles	List	角色列表
++ id	Long	角色id
++ name	String	角色名称
++ description	String	角色描述
++ systemRoleId	Long	系统角色id，绑定系统角色的有此值
++ prompt	String	角色定义，自定义的角色有此值
++ model	String	角色使用的模型，自定义的角色有此值
++ defaultUsage	boolean	是否为默认角色

响应示例

                JSON
                
            

                HTTP/1.1 200 OK
x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
date: Mon, 05 Sep 2022 03:25:43 GMT
transfer-encoding: chunked
content-type: application/json;charset=UTF-8
cache-control: no-cache

{
    "llm": {
        "roles": [
            {
                "id": 10,
                "name": "情感陪伴老师",
                "description": "情感陪伴老师",
                "systemRoleId": 6,
                "defaultUsage": true
            },
            {                
                "id": 11,
                "name": "更新测试角色",
                "description": "",
                "prompt": "",
                "model": "DEEPSEEK_3_2",
                "defaultUsage": false
            },
            {
                "id": 12,
                "name": "北极熊",
                "description": "北极熊",
                "systemRoleId": 5,
                "defaultUsage": false
            },
            {
                "id": 13,
                "name": "新增测试角色",
                "description": "",
                "prompt": "",
                "model": "QIANFAN_IPCHARACTER",
                "defaultUsage": false
            }
        ]
    }
}
            

互动应用角色的增、改、删

接口描述

在互动应用已创建时，新增角色、修改角色、删除角色

请求语法

                JSON
                
                PUT /api/v{version}/apps/{appId}/llm HTTP/1.1
host: rtc-aiagent.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

除公共头域外，无其它特殊头域。

请求路径参数

名称	类型	是否必选	参数位置	描述
appId	String	是	RequestBody	大模型互动应用ID

请求体

名称	类型	是否必选	参数位置	描述
type	String	是	RequestBody	大模型类型，取值必须是SYSTEM
role	Object	是	RequestBody	角色信息
+addItems	Array	否	RequestBody	新增角色列表
++systemRoleId	Long	是	RequestBody	此参数设置，则表示添加系统角色，其他参数则不需要在设置（defaultUsage除外）
++defaultUsage	boolean	否	RequestBody	是否设置为默认
++name	String	是	RequestBody	角色名称
++description	String	否	RequestBody	角色描述
++prompt	String	是	RequestBody	角色定义
++model	String	是	RequestBody	角色使用的模型，取值参考
+updateItems	Array	否	RequestBody	更新角色列表
++id	Long	是	RequestBody	角色id，对于绑定的系统角色，只能设置defaultUsage
++defaultUsage	boolean	否	RequestBody	是否设置为默认
++name	String	是	RequestBody	角色名称
++description	String	否	RequestBody	角色描述
++prompt	String	是	RequestBody	角色定义
++model	String	是	RequestBody	角色使用的模型，取值参考
+removeItems	Array	否	RequestBody	移除角色列表
++id	Long	是	RequestBody	角色id

请求示例

                JSON
                
            

                PUT /api/v1/apps/appxxx/llm  HTTP/1.1
host: rtc-aiagent.baidubce.com
content-type: application/json
authorization: {bce-authorization-string}
x-bce-request-id: {bce-request-id}
{

    "type": "SYSTEM",
    "role": {
        "addItems": [
            {
                "systemRoleId": 5,
                "defaultUsage": false
            },
            {
                "name": "新增测试角色",
                "description": "",
                "prompt": "",
                "model": "QIANFAN_IPCHARACTER",
                "defaultUsage": false
            }
        ],
        "updateItems": [
            {
                "id": 10,
                "defaultUsage": true
            },
            {
                "id": 11,
                "name": "更新测试角色",
                "description": "",
                "prompt": "",
                "model": "DEEPSEEK_3_2",
                "defaultUsage": false
            }
        ],
        "removeItems": [
            9
        ]
    }
}
            

响应头域

除公共头域外，无其它特殊头域。

响应参数

N/A

响应示例

                JSON
                
            

                HTTP/1.1 200 OK
x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
date: Mon, 05 Sep 2022 03:25:43 GMT
transfer-encoding: chunked
content-type: application/json;charset=UTF-8
cache-control: no-cache
            

错误响应码

Code	Message	HTTP Status Code	说明
NoSuchAppSceneRoleList	No such app scene role=[]	400	角色id不存在
DuplicateNamesException	Duplicate name:xxx	400	角色名称重复

Function Call管理

第三方服务开放协议

RTC 实时音视频

互动应用管理

互动应用绑定Function模板

接口描述

请求语法

请求头域

请求路径参数

请求体

请求示例

响应头域

响应参数

响应示例

查询系统角色

接口描述

请求语法

请求头域

请求参数

请求示例

响应头域

响应参数

响应示例

互动应用角色列表查询

接口描述

请求语法

请求头域

请求路径参数

请求参数

请求示例

响应头域

响应参数

响应示例

互动应用角色的增、改、删

接口描述

请求语法

请求头域

请求路径参数

请求体

请求示例

响应头域

响应参数

响应示例

错误响应码