SDK 安装及使用流程
安装SDK
pip install qianfan
注意:目前支持 Python >= 3.7版本。
SDK 使用流程简介
千帆平台提供了2种鉴权方式。调用API不同,使用的鉴权方式可能不同。开发者可以根据实际使用,选择合适的方式进行调用。
方式一,使用应用AK/SK鉴权
调用SDK前,需确保已完成SDK安装。安装后,调用SDK使用流程如下:
步骤一,获取应用的API Key(AK) 和 Secret Key(SK);如果无应用,需先创建应用。
步骤二,初始化AK 和 SK。
步骤三,调用相关SDK。适用以下:
- 对话Chat
- 续写Completions
- 向量Embeddings
- 插件
方式二,使用安全认证AK/SK鉴权
调用SDK前,需确保已完成SDK安装。安装后,调用SDK使用流程如下:
步骤一,获取“安全认证/Access Key”中的Access Key ID(AK) 和 Secret Access Key(SK)。
步骤二,初始化AK 和 SK。
步骤三,调用对应的SDK。适用以下:
- 模型调优
- 模型管理
- 模型服务
使用应用AK/SK鉴权调用流程
步骤一,获取应用的AK和SK
注意:应用AK、SK分别指应用的 API Key(即AK) 和 Secret Key(即SK)。
(1)登录百度智能云千帆控制台。
登录百度智能云千帆控制台 。注意:为保障服务稳定运行,账户最好不处于欠费状态。
(2)创建千帆应用。
如果已有应用,此步骤可跳过。如果无应用,进入控制台创建应用 ,如何创建应用也可以参考应用接入使用。
(3)在应用接入页,获取应用的API Key、Secret Key。
步骤二,初始化AK和SK
在调用 SDK 前,需要先初始化 应用API Key(即AK) 和 应用Secret Key(即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
不同类型的模型,调用方法不同。支持以下调用:
- 对话Chat,请查看对话Chat 调用说明文档。
- 续写Completions,请查看续写Completions 调用说明文档。
- 向量Embeddings,请查看向量Embeddings 调用说明文档。
- 插件应用相关
使用安全认证AK/SK鉴权调用流程
步骤一,获取安全认证AK/SK
通过以下步骤获取Access Key ID (AK)/Secret Access Key(SK),更多介绍请参考如何获取AK/SK。
(1)登录百度智能云千帆控制台,点击“用户账号->安全认证”进入Access Key管理界面。
注意:此处的AK/SK是指安全认证/Access Key,分别是Access Key ID (AK)/Secret Access Key(SK),和使用的获取AcessToken的应用API Key(AK) 和 Secret Key(SK)不同。
(2)点击Access Key ID右侧的“显示”,可查看其对应的Secret Access Key。
注意:初始化鉴权时,使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key进行鉴权,更多鉴权认证机制请参考鉴权认证机制。
步骤二,初始化鉴权
支持通过参数、内置函数初始化、环境变量三种初始化方式,其优先级由高到低为:参数初始化>内置函数初始化>环境变量初始化。
- 方式一:通过参数初始化
通过调用相关接口时设置参数初始化。
# 调用相关接口时传递(仅作用于该请求,优先级最高)
import qianfan
task = qianfan.FineTune.create_task(ak="...", sk="...")
- 方式二:通过内置函数初始化
# 通过内置函数传递(作用于全局,优先级大于环境变量)
import qianfan
qianfan.AccessKey("...")
qianfan.SecretKey("...")
- 方式三:通过环境变量初始化
# 通过环境变量传递(作用于全局,优先级最低)
import os
os.environ["QIANFAN_ACCESS_KEY"] = "..."
os.environ["QIANFAN_SECRET_KEY"] = "..."
步骤三,调用API
调用以下SDK支持的功能:
- 模型调优
- 模型管理
- 模型服务