Python SDK使用说明
安装Python SDK
pip install qianfan
注意:目前支持 Python >= 3.7版本。
SDK 使用流程简介
千帆ModelBuilder提供了2种调用方式。API不同,调用方式可能不同。开发者可以根据实际使用,选择合适的方式进行调用。
- 方式一,【推荐】使用安全认证AK/SK调用
- 方式二,【不推荐】使用应用AK/SK调用,使用此方式,后续可能出现新功能不兼容的情况,不推荐使用
【推荐】使用安全认证AK/SK调用流程
步骤一,获取安全认证AK/SK
(1)登录千帆ModelBuilder控制台。
登录千帆ModelBuilder控制台,点击用户账号 >安全认证,进入Access Key管理界面。
(2)获取安全认证Access Key/Secret Key。
在安全认证/Access Key 页面,查看Access Key(即安全认证AK)、Secret Key(即安全认证SK)。
注意:安全认证Access Key/Secret Key,和应用API Key/和 Secret Key不同。安全认证Access Key/Secret Key,更多介绍请参考如何获取AK/SK。
步骤二,初始化AK/SK
通过SDK调用API,SDK会获取安全认证AK和SK初始化信息,并自动完成鉴权相关步骤。
支持通过环境变量或参数初始化方式,优先级由低到高为:环境变量初始化<参数初始化。
- 方式一:【推荐】通过环境变量初始化
# 通过环境变量传递(作用于全局,优先级最低)
import os
os.environ["QIANFAN_ACCESS_KEY"] = "..."
os.environ["QIANFAN_SECRET_KEY"] = "..."
- 方式二:【不推荐】通过内置函数初始化
注意:不推荐使用此方式,后续功能更新可能出现不兼容问题,建议通过方式一环境变量初始化。
# 通过内置函数传递(作用于全局,优先级大于环境变量)
import qianfan
qianfan.AccessKey("...")
qianfan.SecretKey("...")
步骤三,调用API
调用相关API,请参考各API文档调用示例。
【不推荐】使用应用AK/SK调用流程
说明:使用此方式进行鉴权,后续可能出现新功能不兼容的情况,不推荐使用。
步骤一,获取应用的AK和SK
(1)登录千帆ModelBuilder控制台。
登录控制台。注意:为保障服务稳定运行,账户最好不处于欠费状态。
(2)创建应用。
如果已有千帆ModelBuilder应用,此步骤可跳过。如果无应用,进入控制台创建应用 ,如何创建应用也可以参考应用接入使用。
(3)在应用接入页,获取应用的API Key、Secret Key。
步骤二,初始化AK和SK
通过SDK调用API时,SDK会获取安全认证AK和SK初始化信息,并自动完成鉴权相关步骤。
支持通过参数初始化、内置函数初始化、环境变量初始化三种方式进行初始化。
- 方式一:通过参数初始化
通过调用相关接口时设置参数初始化。
chat_completion = qianfan.ChatCompletion(ak="应用API Key", sk="应用Secret Key")
- 方式二:通过内置函数初始化
import qianfan
qianfan.AK("应用API Key")
qianfan.SK("应用Secret Key")
- 方式三:通过环境变量初始化
import os
os.environ["QIANFAN_AK"] = "应用API Key"
os.environ["QIANFAN_SK"] = "应用Secret Key"
步骤三,调用API
调用相关API,请参考各API文档调用示例。
使用教程
请查看Python SDK调用教程。