honeymoose/OpenAI-J
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Readme

Browse Source 
Added version badge and download instructions
This commit is contained in:
Theo Kanning 2020-10-07 09:38:16 -05:00 committed by GitHub
parent fe48e8cfc3
commit 70019fa7bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,13 +1,20 @@
![version](https://img.shields.io/bintray/v/theokanning/openai-gpt3-java/api)
# OpenAI-Java # OpenAI-Java
Java libraries for using OpenAI's GPT-3 api. Java libraries for using OpenAI's GPT-3 api.
Includes the following artifacts: Includes the following artifacts:
- `api` : request/response POJOs for the GPT-3 engine, completion, and search APIs. - `api` : request/response POJOs for the GPT-3 engine, completion, and search APIs.
- `client` : a basic retrofit client for the GPT-3 endpoints - `client` : a basic retrofit client for the GPT-3 endpoints, includes the `api` module
as well as an example project using the client. as well as an example project using the client.
## Usage ## Usage
### Importing into a gradle project
`implementation 'com.theokanning.openai-gpt3-java:app:<version>'`
or
`implementation 'com.theokanning.openai-gpt3-java:client:<version>'`
### Using OpenAiService ### Using OpenAiService
If you're looking for the fastest solution, import the `client` and use [OpenAiService](client/src/main/java/openai/OpenAiService.java). If you're looking for the fastest solution, import the `client` and use [OpenAiService](client/src/main/java/openai/OpenAiService.java).
``` ```
@ -36,4 +43,4 @@ export OPENAI_TOKEN="sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
``` ```
## License ## License
Published under the MIT License Published under the MIT License