知识库
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/plugin/{服务后缀名称}/
功能介绍
服务后缀名称说明


请求示例(流式)
响应示例(流式)
# 首包需要的回显信息
data: {"plugin_id":"uuid-zhishiku","request":{"query":"数据集创建案例","kbIds":["64f59e7c779fb0a5a92d987f"],"score":0,"topN":5},"response":{"retCode":1,"message":"","result":{"besQueryCostMilsec3":381,"dbQueryCostMilsec1":0,"embeddedCostMilsec2":364,"responses":[{"contentUrl":"http://easydata.bj.bcebos.com/_system_/knowledge/kb-qzpqzj0usrk3zje8/doc/9bca5802-a1e9-4e83-a375-21d2009641d1/shard/e35fb73f-9194-4337-a545-d81479c4c657?authorization=bce-auth-v1%2F50c8bb753dcb4e1d8646bb1ffefd3503%2F2023-09-25T06%3A46%3A08Z%2F1800%2Fhost%2F79d06cadc07837227e913a6b9268b542dcf248411292b0b166fa1d7e53845789","docId":"9bca5802-a1e9-4e83-a375-21d2009641d1","docName":"EasyData产品4.1.2测试用例.xlsx","kbId":"64f59e7c779fb0a5a92d987f","score":0.5065146,"shardId":"e35fb73f-9194-4337-a545-d81479c4c657","shardIndex":0,"content":"预期结果\u0001跳转至智能数据-数据总览页\u0001实测结果\u0001案例执行人\u0001功能模块\u0001数据集管理\u0001功能点\u0001创建数据集\u0001执行用户\u0001系统管理员admin\u0001案例测试编号\u0001ST-ED-02\u0001案例名称\u0001数据集创建\u0001案例描述\u00011.点击左侧导航栏的数据总览2.点击页面左上方『创建数据集』按钮3.弹窗填写数据集信息:数据集名称:img_cls_multi 数据类型:图片标注类型:图像分类标注模板:单图多标签4.点击右下角『完成』按钮。"},{"contentUrl":"http://easydata.bj.bcebos.com/_system_/knowledge/kb-qzpqzj0usrk3zje8/doc/9bca5802-a1e9-4e83-a375-21d2009641d1/shard/bd30a9df-d17f-4ad3-a182-d0d644122c8a?authorization=bce-auth-v1%2F50c8bb753dcb4e1d8646bb1ffefd3503%2F2023-09-25T06%3A46%3A08Z%2F1800%2Fhost%2F44419753b3cf0cefd32e872575aab499bd9b2a23c94fae677d8e7335dd5fd1bb","docId":"9bca5802-a1e9-4e83-a375-21d2009641d1","docName":"EasyData产品4.1.2测试用例.xlsx","kbId":"64f59e7c779fb0a5a92d987f","score":0.47083926,"shardId":"bd30a9df-d17f-4ad3-a182-d0d644122c8a","shardIndex":0,"content":"Overview\u0001Sheet 1: EasyData验收用例\u0001功能模块\u0001数据总览\u0001功能点\u0001登录系统\u0001执行用户\u0001系统管理员admin\u0001案例测试编号\u0001ST-01\u0001案例名称\u0001首页-使用流程-登录\u0001案例描述\u0001在console页面登录(http//master8136)点击右上角登录按钮默认管理员账号/密码(一般为admin/123qweasd!)。"},{"contentUrl":"http://easydata.bj.bcebos.com/_system_/knowledge/kb-qzpqzj0usrk3zje8/doc/edb5229e-ad27-49b9-b945-e421255e06ee/shard/d4d72e12-47f1-475f-b68f-e071415a3802?authorization=bce-auth-v1%2F50c8bb753dcb4e1d8646bb1ffefd3503%2F2023-09-25T06%3A46%3A08Z%2F1800%2Fhost%2Ffb9cfd99832733f61d96dd1e7fb9e0bf3d59568205df0e3b123c74ad773c62f0","docId":"edb5229e-ad27-49b9-b945-e421255e06ee","docName":"test2.txt","kbId":"64f59e7c779fb0a5a92d987f","score":0.4332734,"shardId":"d4d72e12-47f1-475f-b68f-e071415a3802","shardIndex":0,"content":"我很【满意】这次的旅行体验。\u0001It's a perfect blend of sweet, spicy, and savory flavors.。"}],"urlSignedCostMilsec4":383}},"log_id":2385836841933227644}
# 后续为用户请求的响应结果
data: {"id":"as-6np8kdry8x","object":"chat.completion","created":1695624371,"sentence_id":0,"is_end":false,"is_truncated":false,"result":"数据集创建的步骤","need_clear_history":false,"usage":{"prompt_tokens":433,"completion_tokens":8,"total_tokens":441},"log_id":2385836841933227644}
data: {"id":"as-6np8kdry8x","object":"chat.completion","created":1695624372,"sentence_id":1,"is_end":false,"is_truncated":false,"result":"包括:\n1. 点击左侧导航栏的数据总览;\n2. 点击页面左上方『创建数据集』按钮;\n3. 弹窗填写数据集信息:数据集名称:img_cls_multi 数据类型:图片","need_clear_history":false,"usage":{"prompt_tokens":433,"completion_tokens":55,"total_tokens":496},"log_id":2385836841933227644}
data: {"id":"as-6np8kdry8x","object":"chat.completion","created":1695624373,"sentence_id":2,"is_end":false,"is_truncated":false,"result":"标注;\n 类型:图像分类标注;模板:单图多标签;\n4. 点击右下角『完成』按钮。","need_clear_history":false,"usage":{"prompt_tokens":433,"completion_tokens":27,"total_tokens":523},"log_id":2385836841933227644}
data: {"id":"as-6np8kdry8x","object":"chat.completion","created":1695624373,"sentence_id":3,"is_end":true,"is_truncated":false,"result":"","need_clear_history":false,"usage":{"prompt_tokens":433,"completion_tokens":0,"total_tokens":523},"log_id":2385836841933227644}
错误码
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
{
"error_code": 110,
"error_msg": "Access token invalid or no longer valid"
}
错误码 | 错误信息 | 描述 |
---|---|---|
1000 | 知识库不存在或状态异常 | 指定的知识库被删除或者无法使用 |
1001 | 知识库无法访问 | 知识库服务器无法访问 |
1002 | 知识库文档链接无法访问 | 知识库数据下载异常 |
1004 | 用户提示词过长 | 用户提示词过长,超过文心一言支持的最大请求长度,需要缩短提示词 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/plugin//?access_token =' \
--header 'Content-Type: application/json' \
--data-raw '{
"query": "string",
"plugins": [
"string"
],
"stream": true,
"llm\t": {},
"input_variables": {},
"history\t": {},
"verbose\t": true
}'
响应示例响应示例
{
"id": "as-yu10xg1umt",
"object": "chat.completion",
"created": 1695622860,
"result": "数据集创建的案例执行以下步骤:
1. 点击左侧导航栏的数据总览;
2. 点击页面左上方“创建数据集”按钮;
3. 弹窗填写数据集信息:数据集名称img_cls_multi,数据类型为图片标注;
4. 选择类型为图像分类标注,并使用单图多标签作为标注模板;
5. 点击右下角“完成”按钮。",
"is_truncated": false,
"need_clear_history": false,
"usage": {
"prompt_tokens": 433,
"completion_tokens": 107,
"total_tokens": 540
},
"meta_info": {
"plugin_id": "uuid-zhishiku",
"request": {
"query": "数据集创建案例",
"kbIds": [
"64f59e7c779fb0a5a92d987f"
],
"score": 0,
"topN": 5
},
"response": {
"retCode": 1,
"message": "",
"result": {
"besQueryCostMilsec3": 340,
"dbQueryCostMilsec1": 0,
"embeddedCostMilsec2": 330,
"responses": [
{
"contentUrl": "http://easydata.bj.bcebos.com/_system_/knowledge/kb-qzpqzj0usrk3zje8/doc/9bca5802-a1e9-4e83-a375-21d2009641d1/shard/e35fb73f-9194-4337-a545-d81479c4c657?authorization=bce-auth-v1%2F50c8bb753dcb4e1d8646bb1ffefd3503%2F2023-09-25T06%3A20%3A55Z%2F1800%2Fhost%2Fa1a2aa03882d1cfc5ea0dc4a230b259700ce678ad7be952ce6811efd6743fda2",
"docId": "9bca5802-a1e9-4e83-a375-21d2009641d1",
"docName": "EasyData产品4.1.2测试用例.xlsx",
"kbId": "64f59e7c779fb0a5a92d987f",
"score": 0.5065146,
"shardId": "e35fb73f-9194-4337-a545-d81479c4c657",
"shardIndex": 0,
"content": "预期结果跳转至智能数据-数据总览页实测结果案例执行人功能模块数据集管理功能点创建数据集执行用户系统管理员admin案例测试编号ST-ED-02案例名称数据集创建案例描述1.点击左侧导航栏的数据总览2.点击页面左上方『创建数据集』按钮3.弹窗填写数据集信息:数据集名称:img_cls_multi 数据类型:图片标注类型:图像分类标注模板:单图多标签4.点击右下角『完成』按钮。"
},
{
"contentUrl": "http://easydata.bj.bcebos.com/_system_/knowledge/kb-qzpqzj0usrk3zje8/doc/9bca5802-a1e9-4e83-a375-21d2009641d1/shard/bd30a9df-d17f-4ad3-a182-d0d644122c8a?authorization=bce-auth-v1%2F50c8bb753dcb4e1d8646bb1ffefd3503%2F2023-09-25T06%3A20%3A55Z%2F1800%2Fhost%2F789a2fc0d5d00ed632ff1498804e0433e7f1b6e2e7a716c2a028d2597294fdf9",
"docId": "9bca5802-a1e9-4e83-a375-21d2009641d1",
"docName": "EasyData产品4.1.2测试用例.xlsx",
"kbId": "64f59e7c779fb0a5a92d987f",
"score": 0.47083926,
"shardId": "bd30a9df-d17f-4ad3-a182-d0d644122c8a",
"shardIndex": 0,
"content": "OverviewSheet 1: EasyData验收用例功能模块数据总览功能点登录系统执行用户系统管理员admin案例测试编号ST-01案例名称首页-使用流程-登录案例描述在console页面登录(http//master8136)点击右上角登录按钮默认管理员账号/密码(一般为admin/123qweasd!)。"
},
{
"contentUrl": "http://easydata.bj.bcebos.com/_system_/knowledge/kb-qzpqzj0usrk3zje8/doc/edb5229e-ad27-49b9-b945-e421255e06ee/shard/d4d72e12-47f1-475f-b68f-e071415a3802?authorization=bce-auth-v1%2F50c8bb753dcb4e1d8646bb1ffefd3503%2F2023-09-25T06%3A20%3A55Z%2F1800%2Fhost%2F5db7b80596d097fd2f627e864083b4e45fa40a5bc21feff85b95ec762d1f3269",
"docId": "edb5229e-ad27-49b9-b945-e421255e06ee",
"docName": "test2.txt",
"kbId": "64f59e7c779fb0a5a92d987f",
"score": 0.4332734,
"shardId": "d4d72e12-47f1-475f-b68f-e071415a3802",
"shardIndex": 0,
"content": "我很【满意】这次的旅行体验。It's a perfect blend of sweet, spicy, and savory flavors.。"
}
],
"urlSignedCostMilsec4": 341
}
}
},
"log_id": 4600987778375255377
}
请求参数
Path 参数
服务后缀名称
string
必需
Query 参数
access_token
string
必需
Body 参数application/json