文心一言-千帆大模型平台
  1. 插件应用
文心一言-千帆大模型平台
  • 体验中心
  • 常见问题
  • 大模型技术测试服务协议
  • 账号与权限管理
    • 账号创建与权限分配
    • 通过子账户隔离实现账单隔离
  • 产品简介
    • 什么是百度智能云千帆大模型平台
    • 百度智能云千帆大模型平台产品优势
    • 百度智能云千帆大模型平台常用概念
  • 新手指南
    • SFT调优快速手册
    • SFT最佳实践
    • 平台使用快速开始
    • 导入并部署第三方模型
      • 快速导入并部署第三方模型
      • SQLCoder自定义模型导入·详细操作
  • 模型广场
    • 查看与管理预置模型
    • 预置调用免费模型列表
  • 我的模型
    • 创建我的模型
    • 查看与管理我的模型
  • Prompt 工程
    • 什么 Prompt 工程
    • Prompt 模板
    • Prompt 优化
    • Prompt 工程使用技巧
      • Prompt 的使用技巧
      • 基础的 Basic Prompt Framework
      • 丰富的 CRISPE Prompt Framework
      • 轻量化的 Few-shot Prompt
  • 模型服务
    • 应用接入
    • 在线服务
    • 调用统计
  • 模型调优
    • 模型精调
      • Post-pretrain
        • 什么是 Post-pretrain
        • 创建 Post-pretrain 任务
        • 查看与管理 Post-pretrain
      • SFT
        • 创建 SFT 任务
        • 查看与管理 SFT 运行
      • RLHF
        • 什么是 RLHF 训练
        • 创建奖励模型训练任务
        • 查看与管理奖励模型训练运行
        • 创建强化学习训练任务
        • 查看与管理强化学习训练运行
    • 模型评估
      • 创建模型评估任务
      • 查看与管理模型评估任务
    • 模型压缩
      • 创建模型压缩任务
      • 查看模型压缩任务
  • 数据管理
    • 数据回流
    • 数据集对应关系说明
    • 数据集管理
      • 创建数据集
      • 数据分析
      • 导入文本对话数据
      • 导入泛文本无标注数据
      • 导入 query 问题集数据
      • 导入文生图数据
      • 管理数据集版本
      • 导出数据
      • 数据集的其他操作
    • 数据标注
      • 在线标注
      • 众测标注
    • 数据处理
      • 数据清洗
      • 数据增强
    • 知识库
      • 什么是千帆大模型知识库
      • 知识库管理
      • 命中测试
  • 系统配置
    • 计算资源
    • 计费管理
    • 插件编排
      • 什么是插件应用
      • 插件编排使用说明
      • 应用创建
        • 对话场景类应用
        • 生成场景类应用
      • 插件
        • 插件列表
        • 自定义插件
        • 插件开发者文档
  • API 鉴权及调用
    • API 介绍
    • API 列表
    • API 调用指南
      • API 调用流程
      • 错误码
      • API 在线调试
    • 鉴权认证
      • 鉴权介绍
      • 使用网页调试工具获取 access_token
      • 获取 access_token
    • 对话 Chat
      • Llama-2
        • Llama-2-7b-chat
        • Llama-2-13b-chat
        • Llama-2-70b-chat
      • ERNIE-Bot 4.0
      • ERNIE-Bot
      • ERNIE-Bot-turbo
      • BLOOMZ-7B
      • Qianfan-BLOOMZ-7B-compressed
      • Mistral-7B-Instruct
      • Qianfan-Chinese-Llama-2-7B
      • Qianfan-Chinese-Llama-2-13B
      • Linly-Chinese-LLaMA-2-7B
      • Linly-Chinese-LLaMA-2-13B
      • ChatGLM2-6B
      • ChatGLM2-6B-32K
      • ChatGLM2-6B-INT4
      • Baichuan2-13B-Chat
      • XVERSE-13B-Chat
      • Falcon-7B
      • Falcon-40B-Instruct
      • AquilaChat-7B
      • RWKV-4-World
      • RWKV-4-pile-14B
      • RWKV-Raven-14B
      • OpenLLaMA-7B
      • Dolly-12B
      • MPT-7B-Instruct
      • MPT-30B-instruct
      • OA-Pythia-12B-SFT-4
      • Falcon-180B-Chat
      • RWKV-5-World
      • Flan-UL2
    • 续写 Completions
      • SQLCoder-7B
      • CodeLlama-7b-Instruct
      • AquilaCode-multi
      • Cerebras-GPT-13B
      • Pythia-12B
      • GPT-J-6B
      • GPT-NeoX-20B
      • GPT4All-J
      • StarCoder
      • StableLM-Alpha -7B
      • Pythia-6.9B
      • Cerebras-GPT-6.7B
    • 向量 Embeddings
      • Embedding-V1
      • bge-large-zh
      • bge-large-en
    • 图像 Images
      • Stable-Diffusion-XL
    • 自定义模型调用 API
      • 自定义模型调用 API
      • 续写模式
    • 模型服务
      • 创建服务
      • 查询服务详情
    • 模型管理
      • 获取模型版本详情
      • 获取模型详情
      • 训练任务发布为模型
    • 模型调优
      • 创建训练任务
      • 创建任务运行
      • 获取任务运行详情
      • 停止任务运行
    • 数据管理
      • 创建数据集
      • 发起数据集发布任务
      • 发起数据集导入任务
      • 获取数据集详情
      • 获取数据集状态详情
      • 发起数据集导出任务
      • 删除数据集
      • 获取数据集导出记录
      • 获取数据集导入错误详情
    • Prompt 工程
      • Prompt 模板
    • 插件应用
      • 知识库
        POST
      • 智慧图问
        POST
      • 天气
        POST
  • SDK 参考
    • 千帆 SDK 介绍
    • SDK 安装及使用流程
    • 对话 Chat
    • 续写 Completions
    • 向量 Embeddings
    • 模型服务
      • 创建服务
      • 查询服务详情
    • 模型管理
      • 获取模型详情
      • 获取模型版本详情
      • 训练任务发布为模型
    • 模型调优
      • 创建训练任务
      • 创建任务运行
      • 获取任务运行详情
      • 停止任务运行
    • 数据管理
      • 创建数据集
      • 发起数据集发布任务
      • 发起数据集导入任务
      • 获取数据集详情
      • 获取数据集状态详情
      • 发起数据集导出任务
      • 删除数据集
      • 获取数据集导出记录
      • 获取数据集导入错误详情
    • 插件应用
      • 知识库
      • 智能图问
      • 天气
  • 价格说明
    • 千帆大模型平台价格文档
  1. 插件应用

知识库

开发环境
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/{服务后缀名称}/

功能介绍#

本接口用于使用知识库中存储的相关内容进行问答增强。

服务后缀名称说明#

配置插件应用服务成功后,可以查看服务后缀名称、服务地址等信息。如何配置插件应用服务,详见插件编排使用说明。
配置插件应用成功后,查看服务地址、服务后缀名称。
说明:只有服务状态为上线状态,才可以查看自动生成的服务地址、服务后缀名称。
image.png
在插件的详情页中,查看完整的服务地址。
image.png

请求示例(流式)#

bash
Python

响应示例(流式)#

# 首包需要的回显信息
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}

错误码#

若请求错误,服务器将返回的JSON文本包含以下参数:
名称描述
error_code错误码
error_msg错误描述信息,帮助理解和解决发生的错误
例如Access Token失效返回:
{
  "error_code": 110,
  "error_msg": "Access token invalid or no longer valid"
}
需要重新获取新的Access Token再次请求。
错误码错误信息描述
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 
必需
通过API Key和Secret Key获取的access_token,参考Access Token获取
Body 参数application/json
query
string 
必需
查询信息。说明: (1)成员不能为空 (2)长度不能超过1000个字符
plugins
array[string]
必需
需要调用的插件,参数为插件ID,插件ID可在插件列表-插件详情中获取。 (1)最多3个插件,最少1个插件。 (2)当多个插件时,插件触发由大模型意图判断控制。 (3)当只有1个插件时,强制指定使用该插件工具。 参数示例:["...", "..."]
stream
boolean 
可选
是否以流式接口的形式返回数据,默认false,可选值如下: (1)true: 是,以流式接口的形式返回数据 (2)false:否,非流式接口形式返回数据
llm
object 
可选
llm相关参数,不指定参数时,使用调试过程中的默认值。 参数示例:"llm":{"temperature":0.1,"top_p":1,"penalty_score":1}
input_variables
object 
可选
说明: (1)如果prompt中使用了变量,推理时可以填写具体值; (2)如果prompt中未使用变量,该字段不填。 参数示例:"input_variables":{"key1":"value1","key2":"value2",} key1、key2为配置时prompt中使用了变量key
history
object 
可选
聊天上下文信息。 参数示例: [{"role":"user","content":"..."},{"role":"assistant","content":"..."},...]
verbose
boolean 
可选
是否返回插件的原始请求信息,默认false,可选值如下: true:是,返回插件的原始请求信息meta_info false:否,不返回插件的原始请求信息meta_info
示例

返回响应

🟢200成功
application/json
Body
id
string 
本轮对话的id
必需
object
string 
必需
回包类型。 chat.completion:多轮对话返回
created
integer 
时间戳
必需
result
string 
插件返回结果
必需
need_clear_history
boolean 
必需
表示用户输入是否存在安全,是否关闭当前会话,清理历史会话信息 true:是,表示用户输入存在安全风险,建议关闭当前会话,清理历史会话信息 false:否,表示用户输入无安全风险
usage
object 
必需
token统计信息,token数 = 汉字数+单词数*1.3 (仅为估算逻辑)
prompt_tokens
integer 
问题tokens数
必需
completion_tokens
integer 
回答tokens数
必需
total_tokens
integer 
tokens总数
必需
meta_info
object 
插件的原始请求信息
必需
plugin_id
string 
必需
插件 Id,为“uuid-zhishiku”
request
object 
知识库原始请求参数
必需
response
object 
知识库原始返回结果
必需
log_id
integer 
必需
唯一的log id,用于问题定位
上一页
Prompt 模板
下一页
智慧图问
Built with