https://github.com/metaglm/zhipuai-sdk-java-v4
https://github.com/metaglm/zhipuai-sdk-java-v4
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/metaglm/zhipuai-sdk-java-v4
- Owner: MetaGLM
- License: mit
- Created: 2024-01-31T07:21:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-27T05:29:12.000Z (about 1 year ago)
- Last Synced: 2025-03-28T21:01:51.477Z (about 1 year ago)
- Language: Java
- Size: 6.28 MB
- Stars: 138
- Watchers: 5
- Forks: 23
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 智谱大模型开放接口SDK
智谱[开放平台](http://open.bigmodel.cn/howuse/platformintroduced)大模型接口Java SDK（Big Model API SDK in
Java），让开发者更便捷的调用智谱开放API
## 简介
- **java sdk仍在开发测试阶段，有bug请留言联系**
- 对所有接口进行了类型封装，无需查阅API文档即可完成接入
## 安装
- 运行环境：JDK1.8+
- maven坐标
```
cn.bigmodel.openapi
oapi-java-sdk
release-V4-2.3.0
```
- 运行单元测试依赖您环境变量中的APIKey和BaseUrl信息，建议您提前设置好环境变量；运行过程中会消耗APIKey对应账户下的少量token
```
export ZHIPUAI_BASE_URL=https://open.bigmodel.cn/api/paas/v4/ # 默认智谱开放平台API地址
export ZHIPUAI_API_KEY=6082424a4dxxxxxxxxxxb9d.svyyyyyyyyyK8K # 替换为你自己的APIKey
```
### 依赖信息
```text
okhttp_3.14.9
java-jwt_4.2.2
jackson_2.11.3
retrofit2_2.9.0
```
## 使用
- 调用流程：
1. 使用APIKey创建Client
2. 调用Client对应的成员方法
- [V4Test.java](src/test/java/com/zhipu/oapi/V4Test.java)有完整的demo示例，请替换自己的ApiKey进行测试
> SDK提供了ClientV4的构造器，此方法可以在创建Client时进行配置，可配置项如下：
- enableTokenCache：是否开启token缓存，开启后会缓存token，减少token请求次数
- networkConfig：设置连接超时、读取超时、写入超时、ping间隔、ping超时时间
- connectionPool：设置连接池
```
String API_SECRET_KEY = "your api";
private static final ClientV4 client = new ClientV4.Builder(API_SECRET_KEY)
.enableTokenCache()
.networkConfig(30, 10, 10, 10, TimeUnit.SECONDS)
.connectionPool(new okhttp3.ConnectionPool(8, 1, TimeUnit.SECONDS))
.build();
```
### spring Controller 示例
```java
package com.zhipu.controller;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.wd.common.core.domain.R;
import com.zhipu.oapi.ClientV4;
import com.zhipu.oapi.Constants;
import com.zhipu.oapi.service.v4.deserialize.MessageDeserializeFactory;
import com.zhipu.oapi.service.v4.model.ChatCompletionRequest;
import com.zhipu.oapi.service.v4.model.ModelApiResponse;
import com.zhipu.oapi.service.v4.model.ModelData;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.concurrent.TimeUnit;
@RestController
public class TestController {
private final static Logger logger = LoggerFactory.getLogger(TestController.class);
private static final String API_SECRET_KEY = Constants.getApiKey();
private static final ClientV4 client = new ClientV4.Builder(API_SECRET_KEY)
.networkConfig(300, 100, 100, 100, TimeUnit.SECONDS)
.connectionPool(new okhttp3.ConnectionPool(8, 1, TimeUnit.SECONDS))
.build();
private static final ObjectMapper mapper = MessageDeserializeFactory.defaultObjectMapper();
@RequestMapping("/test")
public R test(@RequestBody ChatCompletionRequest chatCompletionRequest) {
ModelApiResponse sseModelApiResp = client.invokeModelApi(chatCompletionRequest);
return R.ok(sseModelApiResp.getData());
}
}
```
## 升级内容
#### release-V4-2.3.0
- 知识库业务
- 智能助手业务
- 增加embedding-3支持
#### release-V4-2.2.0
- 重构代码
- 高级检索接口
- codegeex接口
- 视频生成功能
#### release-V4-2.1.0
- 增加拓展报文序列化工具类
- 增加测试样例
- 修改为使用api key鉴权
- 统一通信客户端
- 删除部分序列化框架依赖
- 增加批处理API
#### release-V4-2.0.2
- readTimeOut时间设置为300s
- 修改测试demo中apiKey命名
#### release-V4-2.0.1
- 统一client4构造apikey入参
- 延长token过期时间