# 百度千帆大模型平台 SDK
[](https://github.com/baidubce/bce-qianfan-sdk/blob/master/LICENSE)
[](https://github.com/baidubce/bce-qianfan-sdk/releases)
[](https://pypi.org/project/qianfan/)
[](https://qianfan.readthedocs.io/en/stable/README.html)
[](https://github.com/baidubce/bce-qianfan-sdk/issues)
[](https://console.bce.baidu.com/ticket/#/ticket/create?productId=279)
[Documentation](https://qianfan.readthedocs.io/en/stable/README.html) | [GitHub](https://github.com/baidubce/bce-qianfan-sdk) | [Cookbook](https://github.com/baidubce/bce-qianfan-sdk/tree/main/cookbook)
针对百度智能云千帆大模型平台，我们推出了一套 Python SDK（下称千帆 SDK），方便用户通过代码接入并调用千帆大模型平台的能力。
## 如何安装
目前千帆 SDK 已发布到 PyPI ，用户可使用 pip 命令进行安装。安装千帆 SDK 需要 3.7.0 或更高的 Python 版本
```
pip install qianfan
```
在安装完成后，用户即可在代码内引入千帆 SDK 并使用
```python
import qianfan
```
## 快速使用
在使用千帆 SDK 之前，用户需要 [百度智能云控制台 - 安全认证](https://console.bce.baidu.com/iam/#/iam/accesslist) 页面获取 Access Key 与 Secret Key，并在 [千帆控制台](https://console.bce.baidu.com/qianfan/ais/console/applicationConsole/application) 中创建应用，选择需要启用的服务，具体流程参见平台 [说明文档](https://cloud.baidu.com/doc/Reference/s/9jwvz2egb)。在获得了 Access Key 与 Secret Key 后，用户即可开始使用 SDK：
```python
import os
import qianfan
os.environ["QIANFAN_ACCESS_KEY"]="..."
os.environ["QIANFAN_SECRET_KEY"]="..."
chat_comp = qianfan.ChatCompletion(model="ERNIE-Bot")
resp = chat_comp.do(messages=[{
"role": "user",
"content": "你好，千帆"
}], top_p=0.8, temperature=0.9, penalty_score=1.0)
print(resp["result"])
```
除了通过环境变量设置外，千帆 SDK 还提供了 `.env` 文件和通过代码配置的方式，详细参见 [SDK 配置](https://qianfan.readthedocs.io/en/stable/docs/configurable.html) 部分。
除了模型调用外，千帆 SDK 还提供模型训练、数据管理等诸多功能，如何使用请参考 [SDK 使用文档](https://qianfan.readthedocs.io/en/stable/README.html)。
<details>
<summary> 其他认证方式 </summary>
> 这里是一些其他认证方式，请仅在无法获取 Access Key 与 Secret Key 时使用。这些认证方式已经过时，将在未来从 SDK 中移除。
API Key (**AK**) 和 Secret Key (**SK**）是用户在调用千帆模型相关功能时所需要的凭证。具体获取流程参见平台的[应用接入使用说明文档](https://cloud.baidu.com/doc/WENXINWORKSHOP/s/Slkkydake)，但该认证方式无法使用训练、发布模型等功能，若需使用请使用 Access Key 和 Secret Key 的方式进行认证。在获得并配置了 AK 以及 SK 后，用户即可开始使用 SDK：
```python
import os
import qianfan
os.environ["QIANFAN_AK"]="..."
os.environ["QIANFAN_SK"]="..."
chat_comp = qianfan.ChatCompletion(model="ERNIE-Bot")
resp = chat_comp.do(messages=[{
"role": "user",
"content": "你好，千帆"
}], top_p=0.8, temperature=0.9, penalty_score=1.0)
print(resp["result"])
```
适用范围：
| 功能 | API Key | Access Key |
|:---|:---:|:---:|
| Chat 对话 | ✅ | ✅ |
| Completion 续写 | ✅ | ✅ |
| Embedding 向量化 | ✅ | ✅ |
| Plugin 插件调用 | ✅ | ✅ |
| 文生图 | ✅ | ✅ |
| 大模型调优 | ❌ | ✅ |
| 大模型管理 | ❌ | ✅ |
| 大模型服务 | ❌ | ✅ |
| 数据集管理 | ❌ | ✅ |
</details>
## 功能导览
千帆平台提供了大模型相关的诸多能力，SDK 提供了对各能力的调用，具体介绍可以查看 [SDK 文档](https://qianfan.readthedocs.io/en/stable/README.html) 或者 [GitHub 仓库](https://github.com/baidubce/bce-qianfan-sdk)。
- **大模型能力** [[Doc](https://qianfan.readthedocs.io/en/stable/docs/inference.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/inference.md)]
- Chat 对话
- Completion 续写
- Embedding 向量化
- Plugin 插件调用
- Text2Image 文生图
- **模型调优** [[Doc](https://qianfan.readthedocs.io/en/stable/docs/train.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/train.md)]
- **模型管理** [[Doc](https://qianfan.readthedocs.io/en/stable/docs/model_management.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/model_management.md)]
- **模型服务** [[Doc](https://qianfan.readthedocs.io/en/stable/docs/service.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/service.md)]
- **数据集管理** [[Doc](https://qianfan.readthedocs.io/en/stable/docs/dataset.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/dataset.md)]
- **Prompt 管理** [[Doc](https://qianfan.readthedocs.io/en/stable/docs/prompt.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/prompt.md)]
- **其他**
- Tokenizer [[Doc](https://qianfan.readthedocs.io/en/stable/docs/utils.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/utils.md)]
- 接口流控 [[Doc](https://qianfan.readthedocs.io/en/stable/docs/configurable.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/configurable.md)]
> 还可以通过 [**API References**](https://qianfan.readthedocs.io/en/stable/qianfan.html) 查看每个接口的详细说明。
## 联系我们
如使用过程中遇到什么问题，或对SDK功能有建议，可通过如下方式联系我们
- [GitHub issues](https://github.com/baidubce/bce-qianfan-sdk/issues)
- [百度智能云工单](https://console.bce.baidu.com/ticket/#/ticket/create?productId=279) （百度专家即时服务）
## License
Apache-2.0
Raw data
{
"_id": null,
"home_page": "https://cloud.baidu.com/product/wenxinworkshop",
"name": "qianfan",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.7",
"maintainer_email": null,
"keywords": "baidu, qianfan",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/65/81/bd10fa32967875b9679db5cb9be01d5fc895906fd9816861ec82cde7f2b4/qianfan-0.3.10.tar.gz",
"platform": null,
"description": "# \u767e\u5ea6\u5343\u5e06\u5927\u6a21\u578b\u5e73\u53f0 SDK\n\n[](https://github.com/baidubce/bce-qianfan-sdk/blob/master/LICENSE)\n[](https://github.com/baidubce/bce-qianfan-sdk/releases)\n[](https://pypi.org/project/qianfan/)\n[](https://qianfan.readthedocs.io/en/stable/README.html)\n[](https://github.com/baidubce/bce-qianfan-sdk/issues)\n[](https://console.bce.baidu.com/ticket/#/ticket/create?productId=279)\n\n[Documentation](https://qianfan.readthedocs.io/en/stable/README.html) | [GitHub](https://github.com/baidubce/bce-qianfan-sdk) | [Cookbook](https://github.com/baidubce/bce-qianfan-sdk/tree/main/cookbook) \n\n\u9488\u5bf9\u767e\u5ea6\u667a\u80fd\u4e91\u5343\u5e06\u5927\u6a21\u578b\u5e73\u53f0\uff0c\u6211\u4eec\u63a8\u51fa\u4e86\u4e00\u5957 Python SDK\uff08\u4e0b\u79f0\u5343\u5e06 SDK\uff09\uff0c\u65b9\u4fbf\u7528\u6237\u901a\u8fc7\u4ee3\u7801\u63a5\u5165\u5e76\u8c03\u7528\u5343\u5e06\u5927\u6a21\u578b\u5e73\u53f0\u7684\u80fd\u529b\u3002\n\n## \u5982\u4f55\u5b89\u88c5\n\n\u76ee\u524d\u5343\u5e06 SDK \u5df2\u53d1\u5e03\u5230 PyPI \uff0c\u7528\u6237\u53ef\u4f7f\u7528 pip \u547d\u4ee4\u8fdb\u884c\u5b89\u88c5\u3002\u5b89\u88c5\u5343\u5e06 SDK \u9700\u8981 3.7.0 \u6216\u66f4\u9ad8\u7684 Python \u7248\u672c\n\n```\npip install qianfan\n```\n\n\u5728\u5b89\u88c5\u5b8c\u6210\u540e\uff0c\u7528\u6237\u5373\u53ef\u5728\u4ee3\u7801\u5185\u5f15\u5165\u5343\u5e06 SDK \u5e76\u4f7f\u7528\n\n```python\nimport qianfan\n```\n\n## \u5feb\u901f\u4f7f\u7528\n\n\u5728\u4f7f\u7528\u5343\u5e06 SDK \u4e4b\u524d\uff0c\u7528\u6237\u9700\u8981 [\u767e\u5ea6\u667a\u80fd\u4e91\u63a7\u5236\u53f0 - \u5b89\u5168\u8ba4\u8bc1](https://console.bce.baidu.com/iam/#/iam/accesslist) \u9875\u9762\u83b7\u53d6 Access Key \u4e0e Secret Key\uff0c\u5e76\u5728 [\u5343\u5e06\u63a7\u5236\u53f0](https://console.bce.baidu.com/qianfan/ais/console/applicationConsole/application) \u4e2d\u521b\u5efa\u5e94\u7528\uff0c\u9009\u62e9\u9700\u8981\u542f\u7528\u7684\u670d\u52a1\uff0c\u5177\u4f53\u6d41\u7a0b\u53c2\u89c1\u5e73\u53f0 [\u8bf4\u660e\u6587\u6863](https://cloud.baidu.com/doc/Reference/s/9jwvz2egb)\u3002\u5728\u83b7\u5f97\u4e86 Access Key \u4e0e Secret Key \u540e\uff0c\u7528\u6237\u5373\u53ef\u5f00\u59cb\u4f7f\u7528 SDK\uff1a\n\n```python\nimport os\nimport qianfan\n\nos.environ[\"QIANFAN_ACCESS_KEY\"]=\"...\"\nos.environ[\"QIANFAN_SECRET_KEY\"]=\"...\"\n\nchat_comp = qianfan.ChatCompletion(model=\"ERNIE-Bot\")\nresp = chat_comp.do(messages=[{\n \"role\": \"user\",\n \"content\": \"\u4f60\u597d\uff0c\u5343\u5e06\"\n}], top_p=0.8, temperature=0.9, penalty_score=1.0)\n\nprint(resp[\"result\"])\n```\n\n\u9664\u4e86\u901a\u8fc7\u73af\u5883\u53d8\u91cf\u8bbe\u7f6e\u5916\uff0c\u5343\u5e06 SDK \u8fd8\u63d0\u4f9b\u4e86 `.env` \u6587\u4ef6\u548c\u901a\u8fc7\u4ee3\u7801\u914d\u7f6e\u7684\u65b9\u5f0f\uff0c\u8be6\u7ec6\u53c2\u89c1 [SDK \u914d\u7f6e](https://qianfan.readthedocs.io/en/stable/docs/configurable.html) \u90e8\u5206\u3002\n\n\u9664\u4e86\u6a21\u578b\u8c03\u7528\u5916\uff0c\u5343\u5e06 SDK \u8fd8\u63d0\u4f9b\u6a21\u578b\u8bad\u7ec3\u3001\u6570\u636e\u7ba1\u7406\u7b49\u8bf8\u591a\u529f\u80fd\uff0c\u5982\u4f55\u4f7f\u7528\u8bf7\u53c2\u8003 [SDK \u4f7f\u7528\u6587\u6863](https://qianfan.readthedocs.io/en/stable/README.html)\u3002\n\n<details>\n<summary> \u5176\u4ed6\u8ba4\u8bc1\u65b9\u5f0f </summary>\n\n> \u8fd9\u91cc\u662f\u4e00\u4e9b\u5176\u4ed6\u8ba4\u8bc1\u65b9\u5f0f\uff0c\u8bf7\u4ec5\u5728\u65e0\u6cd5\u83b7\u53d6 Access Key \u4e0e Secret Key \u65f6\u4f7f\u7528\u3002\u8fd9\u4e9b\u8ba4\u8bc1\u65b9\u5f0f\u5df2\u7ecf\u8fc7\u65f6\uff0c\u5c06\u5728\u672a\u6765\u4ece SDK \u4e2d\u79fb\u9664\u3002\n\nAPI Key (**AK**) \u548c Secret Key (**SK**\uff09\u662f\u7528\u6237\u5728\u8c03\u7528\u5343\u5e06\u6a21\u578b\u76f8\u5173\u529f\u80fd\u65f6\u6240\u9700\u8981\u7684\u51ed\u8bc1\u3002\u5177\u4f53\u83b7\u53d6\u6d41\u7a0b\u53c2\u89c1\u5e73\u53f0\u7684[\u5e94\u7528\u63a5\u5165\u4f7f\u7528\u8bf4\u660e\u6587\u6863](https://cloud.baidu.com/doc/WENXINWORKSHOP/s/Slkkydake)\uff0c\u4f46\u8be5\u8ba4\u8bc1\u65b9\u5f0f\u65e0\u6cd5\u4f7f\u7528\u8bad\u7ec3\u3001\u53d1\u5e03\u6a21\u578b\u7b49\u529f\u80fd\uff0c\u82e5\u9700\u4f7f\u7528\u8bf7\u4f7f\u7528 Access Key \u548c Secret Key \u7684\u65b9\u5f0f\u8fdb\u884c\u8ba4\u8bc1\u3002\u5728\u83b7\u5f97\u5e76\u914d\u7f6e\u4e86 AK \u4ee5\u53ca SK \u540e\uff0c\u7528\u6237\u5373\u53ef\u5f00\u59cb\u4f7f\u7528 SDK\uff1a\n\n```python\nimport os\nimport qianfan\n\nos.environ[\"QIANFAN_AK\"]=\"...\"\nos.environ[\"QIANFAN_SK\"]=\"...\"\n\nchat_comp = qianfan.ChatCompletion(model=\"ERNIE-Bot\")\nresp = chat_comp.do(messages=[{\n \"role\": \"user\",\n \"content\": \"\u4f60\u597d\uff0c\u5343\u5e06\"\n}], top_p=0.8, temperature=0.9, penalty_score=1.0)\n\nprint(resp[\"result\"])\n```\n\n\u9002\u7528\u8303\u56f4\uff1a\n\n| \u529f\u80fd | API Key | Access Key |\n|:---|:---:|:---:|\n| Chat \u5bf9\u8bdd | \u2705 | \u2705 |\n| Completion \u7eed\u5199 | \u2705 | \u2705 |\n| Embedding \u5411\u91cf\u5316 | \u2705 | \u2705 |\n| Plugin \u63d2\u4ef6\u8c03\u7528 | \u2705 | \u2705 |\n| \u6587\u751f\u56fe | \u2705 | \u2705 |\n| \u5927\u6a21\u578b\u8c03\u4f18 | \u274c | \u2705 |\n| \u5927\u6a21\u578b\u7ba1\u7406 | \u274c | \u2705 |\n| \u5927\u6a21\u578b\u670d\u52a1 | \u274c | \u2705 |\n| \u6570\u636e\u96c6\u7ba1\u7406 | \u274c | \u2705 |\n\n</details>\n\n## \u529f\u80fd\u5bfc\u89c8\n\n\u5343\u5e06\u5e73\u53f0\u63d0\u4f9b\u4e86\u5927\u6a21\u578b\u76f8\u5173\u7684\u8bf8\u591a\u80fd\u529b\uff0cSDK \u63d0\u4f9b\u4e86\u5bf9\u5404\u80fd\u529b\u7684\u8c03\u7528\uff0c\u5177\u4f53\u4ecb\u7ecd\u53ef\u4ee5\u67e5\u770b [SDK \u6587\u6863](https://qianfan.readthedocs.io/en/stable/README.html) \u6216\u8005 [GitHub \u4ed3\u5e93](https://github.com/baidubce/bce-qianfan-sdk)\u3002\n\n- **\u5927\u6a21\u578b\u80fd\u529b** [[Doc](https://qianfan.readthedocs.io/en/stable/docs/inference.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/inference.md)]\n - Chat \u5bf9\u8bdd\n - Completion \u7eed\u5199\n - Embedding \u5411\u91cf\u5316\n - Plugin \u63d2\u4ef6\u8c03\u7528\n - Text2Image \u6587\u751f\u56fe\n- **\u6a21\u578b\u8c03\u4f18** [[Doc](https://qianfan.readthedocs.io/en/stable/docs/train.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/train.md)]\n- **\u6a21\u578b\u7ba1\u7406** [[Doc](https://qianfan.readthedocs.io/en/stable/docs/model_management.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/model_management.md)]\n- **\u6a21\u578b\u670d\u52a1** [[Doc](https://qianfan.readthedocs.io/en/stable/docs/service.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/service.md)]\n- **\u6570\u636e\u96c6\u7ba1\u7406** [[Doc](https://qianfan.readthedocs.io/en/stable/docs/dataset.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/dataset.md)]\n- **Prompt \u7ba1\u7406** [[Doc](https://qianfan.readthedocs.io/en/stable/docs/prompt.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/prompt.md)]\n- **\u5176\u4ed6**\n - Tokenizer [[Doc](https://qianfan.readthedocs.io/en/stable/docs/utils.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/utils.md)]\n - \u63a5\u53e3\u6d41\u63a7 [[Doc](https://qianfan.readthedocs.io/en/stable/docs/configurable.html)][[GitHub](https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/configurable.md)]\n\n> \u8fd8\u53ef\u4ee5\u901a\u8fc7 [**API References**](https://qianfan.readthedocs.io/en/stable/qianfan.html) \u67e5\u770b\u6bcf\u4e2a\u63a5\u53e3\u7684\u8be6\u7ec6\u8bf4\u660e\u3002\n\n## \u8054\u7cfb\u6211\u4eec\n\n\u5982\u4f7f\u7528\u8fc7\u7a0b\u4e2d\u9047\u5230\u4ec0\u4e48\u95ee\u9898\uff0c\u6216\u5bf9SDK\u529f\u80fd\u6709\u5efa\u8bae\uff0c\u53ef\u901a\u8fc7\u5982\u4e0b\u65b9\u5f0f\u8054\u7cfb\u6211\u4eec\n\n- [GitHub issues](https://github.com/baidubce/bce-qianfan-sdk/issues)\n- [\u767e\u5ea6\u667a\u80fd\u4e91\u5de5\u5355](https://console.bce.baidu.com/ticket/#/ticket/create?productId=279) \uff08\u767e\u5ea6\u4e13\u5bb6\u5373\u65f6\u670d\u52a1\uff09\n\n## License\n\nApache-2.0\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "\u6587\u5fc3\u5343\u5e06\u5927\u6a21\u578b\u5e73\u53f0 Python SDK",
"version": "0.3.10",
"project_urls": {
"Documentation": "https://qianfan.readthedocs.io/en/stable/README.html",
"Homepage": "https://cloud.baidu.com/product/wenxinworkshop",
"Repository": "https://github.com/baidubce/bce-qianfan-sdk"
},
"split_keywords": [
"baidu",
" qianfan"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "402a67c5a0bc97efdc046be96ed0acf8530bfa71ea031fb729137e887903363c",
"md5": "6a1c57fa4cde9eddd89aba09899b0d88",
"sha256": "c0b3fa75c8f3fc892073d0feb59974470488f73bd3bd4a33cbfab7ad3e3700d9"
},
"downloads": -1,
"filename": "qianfan-0.3.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a1c57fa4cde9eddd89aba09899b0d88",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.7",
"size": 376145,
"upload_time": "2024-04-26T13:16:33",
"upload_time_iso_8601": "2024-04-26T13:16:33.304660Z",
"url": "https://files.pythonhosted.org/packages/40/2a/67c5a0bc97efdc046be96ed0acf8530bfa71ea031fb729137e887903363c/qianfan-0.3.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6581bd10fa32967875b9679db5cb9be01d5fc895906fd9816861ec82cde7f2b4",
"md5": "60f4504eef4c5cdc4533f1385a0da211",
"sha256": "3e4f9dba151968df03d7b9beaf5afcf1f4104b9476fa866ef84320dd5ed8592e"
},
"downloads": -1,
"filename": "qianfan-0.3.10.tar.gz",
"has_sig": false,
"md5_digest": "60f4504eef4c5cdc4533f1385a0da211",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.7",
"size": 255437,
"upload_time": "2024-04-26T13:16:35",
"upload_time_iso_8601": "2024-04-26T13:16:35.379397Z",
"url": "https://files.pythonhosted.org/packages/65/81/bd10fa32967875b9679db5cb9be01d5fc895906fd9816861ec82cde7f2b4/qianfan-0.3.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 13:16:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "baidubce",
"github_project": "bce-qianfan-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "qianfan"
}
JSON
