Skip to content

Commit f7981d2

Browse files
committed
update README.md
1 parent 5a95874 commit f7981d2

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# JavaAI is an open-source Java library for interacting with the OpenAI API
2-
[![Maven Central](https://img.shields.io/maven-central/v/io.github.artemnefedov/openaisdk.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.github.artemnefedov%22%20AND%20a:%22openaisdk%22) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
2+
[![Maven Central](https://img.shields.io/maven-central/v/io.github.artemnefedov/openaisdk.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.github.artemnefedov%22%20AND%20a:%22openaisdk%22)
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
34

45
## The JavaAI Java SDK is a non-official open source library that allows Java developers to interact with OpenAI models with just a few lines of code.
56

@@ -15,13 +16,13 @@ Any help is welcome, I am always open to new ideas and criticism.
1516
```xml
1617
<dependency>
1718
<groupId>io.github.artemnefedov</groupId>
18-
<artifactId>openaisdk</artifactId>
19-
<version>0.1.1</version>
19+
<artifactId>javaai</artifactId>
20+
<version>0.2.3</version>
2021
</dependency>
2122
```
2223
#### Gradle:
2324
```groovy
24-
implementation 'io.github.artemnefedov:openaisdk:0.1.1'
25+
implementation group: 'io.github.artemnefedov', name: 'javaai', version: '0.2.3'
2526
```
2627
#### or download the JAR file from the [releases page](https://github.com/artemnefedov/OpenAI/releases)
2728

@@ -44,8 +45,14 @@ String result = completions.generateText();
4445
**Conclusion:** `The first line a programmer typically prints is "Hello World!"`
4546

4647
---
47-
## Only [GTP-3](https://platform.openai.com/docs/models/gpt-3) is supported at the moment, already working on making it work with DALL-E 2.
48-
48+
## Models JavaAI can work with:
49+
### Language models
50+
- [x] [Completions](https://platform.openai.com/docs/api-reference/completions)
51+
- [x] [Edits](https://platform.openai.com/docs/api-reference/edits)
52+
- [ ] [Chat](https://platform.openai.com/docs/api-reference/chat)
53+
54+
### Image models
55+
- [x] [Create image](https://platform.openai.com/docs/api-reference/images/create)
4956
---
5057
## Outside Dependencies.
5158
#### This library uses [Gson](https://github.com/google/gson), to convert JSON to Java objects.

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<groupId>io.github.artemnefedov</groupId>
88
<artifactId>javaai</artifactId>
9-
<version>0.2.4</version>
9+
<version>0.2.3</version>
1010
<packaging>jar</packaging>
1111

1212
<name>JavaAI</name>

0 commit comments

Comments
 (0)