Skip to content

Commit a990304

Browse files
qianmoQqianmoQ
authored
[Release] Released for 2024.01.2 (#44)
2 parents 36c2891 + 88d40a1 commit a990304

22 files changed

+530
-31
lines changed

‎bin/publish-setDocs.sh

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#!/bin/sh
2+
OLD_VERSION=$1
3+
NEW_VERSION=$2
4+
HOME=$(pwd)
5+
6+
# shellcheck disable=SC2164
7+
cd "$HOME"/docs/
8+
9+
sed -i '' "s/${OLD_VERSION}/${NEW_VERSION}/g" mkdocs.yml
10+
11+
# shellcheck disable=SC2164
12+
cd "$HOME"

‎docs/docs/powered_by.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ hide:
3333

3434
DataCap is integrated software for data transformation, integration, and visualization. Support a variety of data sources, file types, big data related database, relational database, NoSQL database, etc. Through the software can realize the management of multiple data sources, the data under the source of various operations conversion ...
3535

36-
[:octicons-arrow-right-24: Getting started](https://github.com/EdurtIO/datacap)
36+
[Getting started](https://github.com/EdurtIO/datacap)
3737

3838
</div>
3939

@@ -49,7 +49,7 @@ hide:
4949

5050
Source code contributors who love open source projects.
5151

52-
[:octicons-arrow-right-24: Visit qianmoQ](https://github.com/qianmoQ)
52+
[Visit qianmoQ](https://github.com/qianmoQ)
5353

5454
</div>
5555

‎docs/docs/powered_by.zh.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ hide:
3333

3434
DataCap 是用于数据转换、集成和可视化的集成软件。支持多种数据源、文件类型、大数据相关数据库、关系型数据库、NoSQL数据库等。通过软件可以实现多种数据源的管理，对源下的数据进行各种操作转换...
3535

36-
[:octicons-arrow-right-24: Getting started](https://github.com/EdurtIO/datacap)
36+
[Getting started](https://github.com/EdurtIO/datacap)
3737

3838
</div>
3939

@@ -49,7 +49,7 @@ hide:
4949

5050
热爱开源项目的源代码贡献者。
5151

52-
[:octicons-arrow-right-24: Visit qianmoQ](https://github.com/qianmoQ)
52+
[Visit qianmoQ](https://github.com/qianmoQ)
5353

5454
</div>
5555

‎docs/docs/reference/openai/assistants.zh.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ client.assistantsFiles("asst_xv9N9dNXstuV8OVLElLqgV7U"));
142142
client.retrieveAssistant("asst_xv9N9dNXstuV8OVLElLqgV7U");
143143
```
144144

145-
Returns:
145+
返回:
146146

147147
```json
148148
{

‎docs/docs/reference/openai/threads.md

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: Threads <span style="font-weight:bold; margin-left:10px; color:red;">Beta</span>
3+
---
4+
5+
!!! Note
6+
7+
Please build the client before calling, the build code is as follows:
8+
9+
```java
10+
OpenAiClient client = OpenAiClient.builder()
11+
.apiHost("https://api.openai.com")
12+
.apiKey(System.getProperty("openai.token"))
13+
.build();
14+
```
15+
16+
`System.getProperty("openai.token")` is the key to access the API authorization.
17+
18+
### Create thread
19+
20+
---
21+
22+
```java
23+
ThreadEntity configure = ThreadEntity.builder()
24+
.build();
25+
client.createThread(configure);
26+
```
27+
28+
Returns:
29+
30+
```json
31+
{
32+
"id": "thread_abc123",
33+
"object": "thread",
34+
"created_at": 1699012949,
35+
"metadata": {}
36+
}
37+
```
38+
39+
### Retrieve thread
40+
41+
---
42+
43+
```java
44+
String threadId = "thread_lsfBRIATCECds5WYLVXnVcpU";
45+
client.retrieveThread(threadId);
46+
```
47+
48+
Returns:
49+
50+
```json
51+
{
52+
"id": "thread_abc123",
53+
"object": "thread",
54+
"created_at": 1699014083,
55+
"metadata": {}
56+
}
57+
```
58+
59+
### Modify thread
60+
61+
---
62+
63+
```java
64+
String threadId = "thread_lsfBRIATCECds5WYLVXnVcpU";
65+
ThreadEntity configure = ThreadEntity.builder()
66+
.build();
67+
client.updateThread(threadId, configure);
68+
```
69+
70+
Returns:
71+
72+
```json
73+
{
74+
"id": "thread_abc123",
75+
"object": "thread",
76+
"created_at": 1699014083,
77+
"metadata": {}
78+
}
79+
```
80+
81+
### Delete thread
82+
83+
---
84+
85+
```java
86+
String threadId = "thread_lsfBRIATCECds5WYLVXnVcpU";
87+
client.deleteThread(threadId);
88+
```
89+
90+
Returns:
91+
92+
```json
93+
{
94+
"id": "thread_abc123",
95+
"object": "thread.deleted",
96+
"deleted": true
97+
}
98+
```

‎docs/docs/reference/openai/threads.zh.md

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: Threads <span style="font-weight:bold; margin-left:10px; color:red;">Beta</span>
3+
---
4+
5+
!!! Note
6+
7+
调用前请先构建客户端，构建代码如下：
8+
9+
```java
10+
OpenAiClient client = OpenAiClient.builder()
11+
.apiHost("https://api.openai.com")
12+
.apiKey(System.getProperty("openai.token"))
13+
.build();
14+
```
15+
16+
`System.getProperty("openai.token")` 是访问 API 授权的关键。
17+
18+
### 创建线程
19+
20+
---
21+
22+
```java
23+
ThreadEntity configure = ThreadEntity.builder()
24+
.build();
25+
client.createThread(configure);
26+
```
27+
28+
返回:
29+
30+
```json
31+
{
32+
"id": "thread_abc123",
33+
"object": "thread",
34+
"created_at": 1699012949,
35+
"metadata": {}
36+
}
37+
```
38+
39+
### 检索线程
40+
41+
---
42+
43+
```java
44+
String threadId = "thread_lsfBRIATCECds5WYLVXnVcpU";
45+
client.retrieveThread(threadId);
46+
```
47+
48+
返回:
49+
50+
```json
51+
{
52+
"id": "thread_abc123",
53+
"object": "thread",
54+
"created_at": 1699014083,
55+
"metadata": {}
56+
}
57+
```
58+
59+
### 修改线程
60+
61+
---
62+
63+
```java
64+
String threadId = "thread_lsfBRIATCECds5WYLVXnVcpU";
65+
ThreadEntity configure = ThreadEntity.builder()
66+
.build();
67+
client.updateThread(threadId, configure);
68+
```
69+
70+
返回:
71+
72+
```json
73+
{
74+
"id": "thread_abc123",
75+
"object": "thread",
76+
"created_at": 1699014083,
77+
"metadata": {}
78+
}
79+
```
80+
81+
### 删除线程
82+
83+
---
84+
85+
```java
86+
String threadId = "thread_lsfBRIATCECds5WYLVXnVcpU";
87+
client.deleteThread(threadId);
88+
```
89+
90+
返回:
91+
92+
```json
93+
{
94+
"id": "thread_abc123",
95+
"object": "thread.deleted",
96+
"deleted": true
97+
}
98+
```

‎docs/docs/release/2023.12.1.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: 2023.12.1
3+
---
4+
5+
| Release version | Release Time |
6+
|:---------------:|:------------:|
7+
| `2023.12.1` | `2023-12-23` |
8+
9+
## OpenAi
10+
11+
---
12+
13+
- Create fine-tuning job
14+
- List fine-tuning jobs
15+
- List fine-tuning events
16+
- Retrieve fine-tuning job
17+
- Cancel fine-tuning

‎docs/docs/release/2023.12.1.zh.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: 2023.12.1
3+
---
4+
5+
| 发布版本 | 发布时间 |
6+
|:-----------:|:------------:|
7+
| `2023.12.1` | `2023-12-23` |
8+
9+
## OpenAi
10+
11+
---
12+
13+
- 创建微调作业
14+
- 列出微调作业
15+
- 列出微调事件
16+
- 检索微调作业
17+
- 取消微调作业

‎docs/docs/release/2024.01.1.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: 2024.01.1
3+
---
4+
5+
| Release version | Release Time |
6+
|:---------------:|:------------:|
7+
| `2024.01.1` | `2024-03-02` |
8+
9+
## OpenAi
10+
11+
---
12+
13+
- Create assistant
14+
- Create assistant file
15+
- List assistants
16+
- List assistant files
17+
- Retrieve assistant
18+
- Retrieve assistant file
19+
- Modify assistant
20+
- Delete assistant
21+
- Delete assistant file

‎docs/docs/release/2024.01.1.zh.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: 2024.01.1
3+
---
4+
5+
| 发布版本 | 发布时间 |
6+
|:-----------:|:------------:|
7+
| `2024.01.1` | `2024-03-02` |
8+
9+
## OpenAi
10+
11+
---
12+
13+
- 创建助手
14+
- 创建助手文件
15+
- 列出助手
16+
- 列出助手文件
17+
- 检索助手
18+
- 检索助手文件
19+
- 修改助手
20+
- 删除助手
21+
- 删除助手文件

‎docs/docs/release/latest.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
---
2-
title: 2023.12.1
2+
title: 2024.01.2
33
---
44

55
| Release version | Release Time |
66
|:---------------:|:------------:|
7-
| `2023.12.1` | `2023-12-23` |
7+
| `2024.01.2` | `2024-03-10` |
88

99
## OpenAi
1010

1111
---
1212

13-
- Create fine-tuning job
14-
- List fine-tuning jobs
15-
- List fine-tuning events
16-
- Retrieve fine-tuning job
17-
- Cancel fine-tuning
13+
- Create thread
14+
- Retrieve thread
15+
- Modify thread
16+
- Delete thread

‎docs/docs/release/latest.zh.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
---
2-
title: 2023.12.1
2+
title: 2024.01.2
33
---
44

55
| 发布版本 | 发布时间 |
66
|:-----------:|:------------:|
7-
| `2023.12.1` | `2023-12-23` |
7+
| `2024.01.2` | `2024-03-10` |
88

99
## OpenAi
1010

1111
---
1212

13-
- 创建微调作业
14-
- 列出微调作业
15-
- 列出微调事件
16-
- 检索微调作业
17-
- 取消微调作业
13+
- 创建线程
14+
- 检索线程
15+
- 修改线程
16+
- 删除线程

0 commit comments

Comments
 (0)