Skip to content

Commit 274d955

Browse files
authored
Update README.md
1 parent 586f36e commit 274d955

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,43 @@
11
<div align="center">
22

33
# ChatGPT Java API
4-
[![Maven Central](https://img.shields.io/maven-central/v/com.cjcrafter/openai?color=blue&label=Download)](https://central.sonatype.com/namespace/com.cjcrafter)
4+
[![Maven Central](https://img.shields.io/maven-central/v/com.cjcrafter/openai?color=blue&label=Download)](https://central.sonatype.com/artifact/com.cjcrafter/openai)
55
[![](https://img.shields.io/badge/-docs%20-blueviolet?logo=Kotlin&colorA=gray)](https://openai.cjcrafter.com/)
66
[![](https://img.shields.io/badge/-examples%20-orange?logo=Read+The+Docs&colorA=gray)](https://github.com/CJCrafter/ChatGPT-Java-API/tree/master/examples/src/main)
77
[![](https://img.shields.io/github/discussions/CJCrafter/ChatGPT-Java-API)](https://github.com/CJCrafter/ChatGPT-Java-API/discussions)
88
[![License](https://img.shields.io/github/license/CJCrafter/ChatGPT-Java-API)](https://github.com/CJCrafter/ChatGPT-Java-API/blob/master/LICENSE)
99

10-
An unofficial, easy-to-use Java/Kotlin OpenAI API for ChatGPT, Text Completions, and more!
10+
An unofficial, easy-to-use Java/Kotlin OpenAI API for ChatGPT, Assistants, and more!
1111
</div>
1212

1313
## Features
14-
* [Completions](https://platform.openai.com/docs/api-reference/completions)
14+
* [Completions](https://github.com/CJCrafter/ChatGPT-Java-API/blob/master/src/main/kotlin/com/cjcrafter/openai/OpenAI.kt#L44-L57)
1515
* Streaming support via `OpenAI#streamCompletion`
16-
* [Chat Completions](https://platform.openai.com/docs/api-reference/chat)
16+
* [Chat Completions](https://github.com/CJCrafter/ChatGPT-Java-API/blob/master/src/main/kotlin/com/cjcrafter/openai/OpenAI.kt#L84-L92)
1717
* Streaming support via `OpenAI#streamChatCompletion`
1818
* Functions support, check out the [java examples](https://github.com/CJCrafter/ChatGPT-Java-API/blob/master/examples/src/main/java/chat/StreamChatCompletionFunction.java#L49) and [kotlin examples](https://github.com/CJCrafter/ChatGPT-Java-API/blob/master/examples/src/main/kotlin/chat/StreamChatCompletionFunction.kt#L37)
19-
* [Azure OpenAI](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/reference) support via `AzureOpenAI` class
20-
* [Embeddings](https://platform.openai.com/docs/api-reference/embeddings) (New!)
21-
* [Files](https://platform.openai.com/docs/api-reference/files) (New!)
19+
* [Azure Support](https://github.com/CJCrafter/ChatGPT-Java-API/blob/master/src/main/kotlin/com/cjcrafter/openai/OpenAI.kt#L271-L276)
20+
* [Embeddings](https://github.com/CJCrafter/ChatGPT-Java-API/blob/master/src/main/kotlin/com/cjcrafter/openai/OpenAI.kt#L113-L123) (New!)
21+
* [Files](https://github.com/CJCrafter/ChatGPT-Java-API/blob/master/src/main/kotlin/com/cjcrafter/openai/files/FileHandler.kt) (New!)
22+
* [Assistants](https://github.com/CJCrafter/ChatGPT-Java-API/blob/master/src/main/kotlin/com/cjcrafter/openai/assistants/AssistantHandler.kt) (New!)
23+
* Which includes [Threads](), [Runs](), and everything else you'll need to run your assistants!
2224

2325
## Installation
2426
For Kotlin DSL (`build.gradle.kts`), add this to your dependencies block:
2527
```kotlin
2628
dependencies {
27-
implementation("com.cjcrafter:openai:2.0.2")
29+
implementation("com.cjcrafter:openai:2.1.0")
2830
}
2931
```
3032
For Maven projects, add this to your `pom.xml` file in the `<dependencies>` block:
3133
```xml
3234
<dependency>
3335
<groupId>com.cjcrafter</groupId>
3436
<artifactId>openai</artifactId>
35-
<version>2.0.2</version>
37+
<version>2.1.0</version>
3638
</dependency>
3739
```
38-
See the [maven repository](https://central.sonatype.com/artifact/com.cjcrafter/openai/2.0.2) for gradle/ant/etc.
40+
See the [maven repository](https://central.sonatype.com/artifact/com.cjcrafter/openai/2.1.0) for gradle/ant/etc.
3941

4042

4143
## Working Example
@@ -131,4 +133,4 @@ If I have saved you time, please consider [sponsoring me](https://github.com/spo
131133

132134
## License
133135
ChatGPT-Java-API is an open-sourced software licensed under the [MIT License](https://github.com/CJCrafter/ChatGPT-Java-API/blob/master/LICENSE).
134-
**This is an unofficial library, and is not affiliated with OpenAI**.
136+
**This is an unofficial library, and is not affiliated with OpenAI**.

0 commit comments

Comments
 (0)