Java SDK使用说明
安装Java SDK
注意:目前支持 Java版本 >= 8版本。
选择以下任一种方式安装。
- 使用Maven安装
在pom.xml的dependencies中添加依赖
<dependency>
<groupId>com.baidubce</groupId>
<artifactId>qianfan</artifactId>
<version>0.1.6</version>
</dependency>
- 使用Gradle安装
对于Kotlin DSL,在build.gradle.kts的dependencies中添加依赖
implementation("com.baidubce:qianfan:0.1.6")
对于Groovy DSL,在build.gradle的dependencies中添加依赖
implementation 'com.baidubce:qianfan:0.1.6'
SDK 调用方式说明
千帆平台提供了3种鉴权方式。调用API不同,使用的鉴权方式可能不同。开发者可以根据实际使用,选择合适的方式进行调用。
调用方式 | 平台功能OpenAPI | 推理服务V2 | 推理服务V1 |
---|---|---|---|
使用API Key值调用 | ✕ | ✓ | ✕ |
使用安全认证AK/SK调用 | ✓ | ✓ | ✓ |
(不推荐)使用应用AK/SK调用 | ✕ | ✕ | ✓ |
注意:
- 使用应用AK/SK调用,使用此方式,后续可能出现新功能不兼容的情况,不推荐使用
- 推理服务API V1版本相关文档,已迁移至SDK参考-历史文档
使用API Key值调用
步骤一,获取API Key
如何获取API Key值,请查看获取API Key值。
步骤二,初始化API Key
通过SDK调用API时,需通过参数初始化API Key值,SDK会根据提供的API Key值自动完成鉴权相关步骤。
// 替换下列示例中参数,API Key值替换your_APIKeyyour_APIKey
QianfanV2 client = new Qianfan("your_APIKey").v2();
步骤三,调用API
调用相关API,请参考对话Chat V2调用示例。
使用安全认证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初始化信息,并自动完成鉴权相关步骤。
- 方式一:通过环境变量初始化
SDK支持从环境变量 QIANFAN_ACCESS_KEY 和 QIANFAN_SECRET_KEY 获取配置,这一步骤会在使用 SDK 时自动完成
export QIANFAN_ACCESS_KEY=your_access_key
export QIANFAN_SECRET_KEY=your_secret_key
- 方式二:通过参数初始化
推理服务APIV2使用以下方式初始化
QianfanV2 client = new Qianfan("your_access_key", "your_secret_key").v2();
推理服务API V1和平台功能Open API使用以下方式初始化
Qianfan qianfan = new Qianfan("your_access_key", "your_secret_key");
步骤三,调用API
调用相关API,请参考各API文档调用示例。
【不推荐】使用应用AK/SK调用流程
说明:使用此方式进行鉴权,后续可能出现新功能不兼容的情况,不推荐使用。
步骤一,获取应用的AK和SK
(1)登录千帆ModelBuilder控制台。
登录千帆ModelBuilder控制台。注意:为保障服务稳定运行,账户最好不处于欠费状态。
(2)创建应用。
注意:应用需为旧版应用,如果是V2协议模型服务接口对应的应用,无API Key和Secret Key值。
(3)在应用接入页,获取应用的API Key、Secret Key。
步骤二,初始化AK和SK
通过SDK调用API时,SDK会获取安全认证AK和SK初始化信息,并自动完成鉴权相关步骤。支持通过环境变量、参数设置两种初始化方式,可以选择以下任一种方式初始化。
- 方式一:通过环境变量初始化
export QIANFAN_AK=应用API Key
export QIANFAN_SK=应用Secret Key
- 方式二:通过参数初始化
通过调用相关接口时设置参数初始化。
Qianfan qianfan = new Qianfan(Auth.TYPE_OAUTH, "应用API Key", "应用Secret Key");
步骤三,调用API
调用相关API,请参考各API文档调用示例。