域内知识搜索增强插件API调用说明

本文介绍了域内知识搜索增强插件API调用相关内容。

请求说明

基本信息

请求地址：https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/plugin/%7B%E6%9C%8D%E5%8A%A1%E5%90%8E%E7%BC%80%E5%90%8D%E7%A7%B0%7D

请求方式：POST

服务后缀名称说明

配置插件应用服务成功后，可以查看服务后缀名称、服务地址等信息。如何配置插件应用服务，详见插件编排使用说明。

（1）服务后缀名称，是用户在配置插件应用服务过程中，进行填写的。

服务后缀名称2.png

（2）配置插件应用成功后，查看服务地址、服务后缀名称。

说明：只有服务状态为上线状态，才可以查看服务地址、服务后缀名称。

服务地址2.png

Header参数

名称值
Content-Typeapplication/json

Query参数

名称类型必填描述
access_tokenstring是通过API Key和Secret Key获取的access_token，参考Access Token获取

Body参数

名称类型必填描述
querystring是查询信息。说明：
（1）成员不能为空
（2）长度不能超过2000个字符

响应说明

名称类型描述
log_idnumber唯一的log id，用于问题定位
querystring查询信息
resultstring返回结果

示例

请求示例

curl 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/plugin/[服务后缀名称]/?access_token=[调用鉴权接口获取的token]' 
    --data '{"query": "你是谁"}'
    --H 'Content-Type: application/json'

响应示例

{
    "log_id": 9021460472852588331,
    "query": "你是谁",
    "result": "我是文心一言，英文名是ERNIE Bot。 [内容来自ERNIE-Bot]"
}

错误码

错误码错误信息描述
4224001非常抱歉，系统出现错误，请稍后重试非常抱歉，系统出现错误，请稍后重试
4224002参数错误参数错误
4224003无操作权限无操作权限
4224004参数错误[%s]参数错误[%s]
4224005当前状态不支持该操作当前状态不支持该操作
4224006后台应用服务创建中，请稍后重试后台应用服务创建中，请稍后重试
4224007应用未安装插件，请先安装插件应用未安装插件，请先安装插件
4224008填写参数不符合要求填写参数不符合要求
4224009服务地址已存在服务地址已存在