Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 515a5fc

Browse filesBrowse files
authored
Add deprecation info to README (TheoKanning#28)
Answers, Classifications, Searchs, and old v1/engine endpoints are all deprecated.
1 parent 553e22f commit 515a5fc
Copy full SHA for 515a5fc

File tree

Expand file treeCollapse file tree

1 file changed

+18
-2
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+18
-2
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
+18-2Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
![Maven Central](https://img.shields.io/maven-central/v/com.theokanning.openai-gpt3-java/client?color=blue)
2+
3+
> ⚠️The [Answers](https://help.openai.com/en/articles/6233728-answers-transition-guide),
4+
>[Classifications](https://help.openai.com/en/articles/6272941-classifications-transition-guide),
5+
>and [Searches](https://help.openai.com/en/articles/6272952-search-transition-guide) APIs are deprecated,
6+
>and will stop working on December 3rd, 2022.
7+
8+
> ⚠️OpenAI has deprecated all Engine-based APIs. See [Deprecated Endpoints](https://github.com/TheoKanning/openai-java#deprecated-endpoints) below for more info.
9+
210
# OpenAI-Java
311
Java libraries for using OpenAI's GPT-3 api.
412

@@ -9,18 +17,19 @@ Includes the following artifacts:
917
as well as an example project using the client.
1018

1119
## Supported APIs
12-
- [Engines](https://beta.openai.com/docs/api-reference/engines)
20+
- [Models](https://beta.openai.com/docs/api-reference/models)
1321
- [Completions](https://beta.openai.com/docs/api-reference/completions)
1422
- [Edits](https://beta.openai.com/docs/api-reference/edits)
1523
- [Embeddings](https://beta.openai.com/docs/api-reference/embeddings)
1624
- [Files](https://beta.openai.com/docs/api-reference/files)
1725
- [Fine-tunes](https://beta.openai.com/docs/api-reference/fine-tunes)
1826
- [Moderations](https://beta.openai.com/docs/api-reference/moderations)
1927

20-
#### Deprecated by OpenAI but still working as of 8/19/22
28+
#### Deprecated by OpenAI
2129
- [Searches](https://beta.openai.com/docs/api-reference/searches)
2230
- [Classifications](https://beta.openai.com/docs/api-reference/classifications)
2331
- [Answers](https://beta.openai.com/docs/api-reference/answers)
32+
- [Engines](https://beta.openai.com/docs/api-reference/engines)
2433

2534
## Usage
2635

@@ -56,5 +65,12 @@ export OPENAI_TOKEN="sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
5665
./gradlew example:run
5766
```
5867

68+
## Deprecated Endpoints
69+
OpenAI has deprecated engine-based endpoints in favor of model-based endpoints.
70+
For example, instead of using `v1/engines/{engine_id}/completions`, switch to `v1/completions` and specify the model in the `CompletionRequest`.
71+
The code includes upgrade instructions for all deprecated endpoints.
72+
73+
I won't remove the old endpoints from this library until OpenAI shuts them down.
74+
5975
## License
6076
Published under the MIT License

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.