diff --git a/README.md b/README.md index 28a0be7..92ea544 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ Includes the following artifacts: as well as an example project using the client. -## How to use this -If you're looking for the fastest solution, import the `client` and use [OpenAiService](openai-client/src/main/java/openai/OpenAiService.java). +## Usage +If you're looking for the fastest solution, import the `client` and use [OpenAiService](client/src/main/java/openai/OpenAiService.java). ``` OpenAiService service = new OpenAiService(your_token) CompletionRequest completionRequest = new CompletionRequest(); @@ -17,8 +17,8 @@ completionRequest.setEcho(true); service.createCompletion("ada", completionRequest).getChoices().forEach(System.out::println); ``` -If you're using retrofit, you can import the `client` module and use the [OpenAiApi](openai-client/src/main/java/openai/OpenAiApi.java). -You'll have to add your auth token as a header (see [AuthenticationInterceptor](openai-client/src/main/java/openai/AuthenticationInterceptor.java)) +If you're using retrofit, you can import the `client` module and use the [OpenAiApi](client/src/main/java/openai/OpenAiApi.java). +You'll have to add your auth token as a header (see [AuthenticationInterceptor](client/src/main/java/openai/AuthenticationInterceptor.java)) and set your converter factory to use snake case and only include non-null fields. If you want to make your own client, just import the POJOs from the `api` module. @@ -28,4 +28,7 @@ All the [example](example/src/main/java/example/OpenAiApiExample.java) project r ``` export OPENAI_TOKEN="sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" ./gradlew example:run -``` \ No newline at end of file +``` + +## License +Published under the MIT License \ No newline at end of file diff --git a/openai-api/build.gradle b/api/build.gradle similarity index 100% rename from openai-api/build.gradle rename to api/build.gradle diff --git a/openai-api/src/main/java/openai/OpenAiResponse.java b/api/src/main/java/openai/OpenAiResponse.java similarity index 100% rename from openai-api/src/main/java/openai/OpenAiResponse.java rename to api/src/main/java/openai/OpenAiResponse.java diff --git a/openai-api/src/main/java/openai/completion/CompletionChoice.java b/api/src/main/java/openai/completion/CompletionChoice.java similarity index 100% rename from openai-api/src/main/java/openai/completion/CompletionChoice.java rename to api/src/main/java/openai/completion/CompletionChoice.java diff --git a/openai-api/src/main/java/openai/completion/CompletionRequest.java b/api/src/main/java/openai/completion/CompletionRequest.java similarity index 100% rename from openai-api/src/main/java/openai/completion/CompletionRequest.java rename to api/src/main/java/openai/completion/CompletionRequest.java diff --git a/openai-api/src/main/java/openai/completion/CompletionResult.java b/api/src/main/java/openai/completion/CompletionResult.java similarity index 100% rename from openai-api/src/main/java/openai/completion/CompletionResult.java rename to api/src/main/java/openai/completion/CompletionResult.java diff --git a/openai-api/src/main/java/openai/engine/Engine.java b/api/src/main/java/openai/engine/Engine.java similarity index 100% rename from openai-api/src/main/java/openai/engine/Engine.java rename to api/src/main/java/openai/engine/Engine.java diff --git a/openai-api/src/main/java/openai/search/SearchRequest.java b/api/src/main/java/openai/search/SearchRequest.java similarity index 100% rename from openai-api/src/main/java/openai/search/SearchRequest.java rename to api/src/main/java/openai/search/SearchRequest.java diff --git a/openai-api/src/main/java/openai/search/SearchResult.java b/api/src/main/java/openai/search/SearchResult.java similarity index 100% rename from openai-api/src/main/java/openai/search/SearchResult.java rename to api/src/main/java/openai/search/SearchResult.java diff --git a/openai-client/build.gradle b/client/build.gradle similarity index 95% rename from openai-client/build.gradle rename to client/build.gradle index 72ef524..7273903 100644 --- a/openai-client/build.gradle +++ b/client/build.gradle @@ -2,7 +2,7 @@ apply plugin: 'java-library' apply plugin: 'com.jfrog.bintray' dependencies { - api project(":openai-api") + api project(":api") api 'com.squareup.retrofit2:retrofit:2.9.0' implementation 'com.squareup.retrofit2:adapter-rxjava2:2.9.0' implementation 'com.squareup.retrofit2:converter-jackson:2.9.0' diff --git a/openai-client/src/main/java/openai/AuthenticationInterceptor.java b/client/src/main/java/openai/AuthenticationInterceptor.java similarity index 100% rename from openai-client/src/main/java/openai/AuthenticationInterceptor.java rename to client/src/main/java/openai/AuthenticationInterceptor.java diff --git a/openai-client/src/main/java/openai/OpenAiApi.java b/client/src/main/java/openai/OpenAiApi.java similarity index 100% rename from openai-client/src/main/java/openai/OpenAiApi.java rename to client/src/main/java/openai/OpenAiApi.java diff --git a/openai-client/src/main/java/openai/OpenAiService.java b/client/src/main/java/openai/OpenAiService.java similarity index 100% rename from openai-client/src/main/java/openai/OpenAiService.java rename to client/src/main/java/openai/OpenAiService.java diff --git a/example/build.gradle b/example/build.gradle index c7766a6..f7f95e5 100644 --- a/example/build.gradle +++ b/example/build.gradle @@ -6,5 +6,5 @@ application { } dependencies { - implementation project(":openai-client") + implementation project(":client") } \ No newline at end of file diff --git a/settings.gradle b/settings.gradle index fcfac6e..969e369 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,6 +1,5 @@ rootProject.name = 'openai-java' +include 'api' +include 'client' include 'example' -include 'openai-api' -include 'openai-client' -