OpenAIJava is a lightweight, highly modular, reactive, type safe Java and Spring Library for working with OpenAI API.

This allows you to work with the OpenAI models, without the additional overhead of having to write your own integration code for the platform.

• Complete Implementation of the 20 OpenAI endpoints
• Implementation of request objects to easily create requests without interacting with JSON objects at all
• Implementation of response objects to easily interact with API responses.
• Comprehensive integration tests demonstrating a number of the above scenarios

• Utils library with some frequent used constant variables. For example, the list of available models
• CreateImageEditRequest and CreateImageVariationRequest contains parameter response_format which should be renamed to match Java standards. (JsonProperty won't work since POJO isn't sent as json)

It has four runtime dependencies:

• OpenFeign for its reactive-functional API
• OKHttp for HTTP connections
• Jackson Core for fast JSON serialisation/deserialization
• Lombok for automatation of methods and logging

It also uses JUnit and Spring-test-starter (Only test scope)

Add the following VM Options or Environment Variables to your project:

-Dspring.profiles.active=dev
-DopenAI.api.key=YOUR_OPENAI_SECRET_KEY

In the case that you are using vscode, add a directory at root path named .vscode and inside a file named settings.json, paste the following so that vmargs work:

{
"java.test.config": {
        "vmArgs": ["-Dspring.profiles.active=dev", "-DopenAI.api.key=YOUR_API_KEY"]
    },
}

Add the following yaml file named openAIJava-application.yaml to configure this library:

spring:
  application:
    name: openai-client
  profiles: dev, stage
feign:
  client:
    config:
      default:
        connect-timeout: 160000000
        read-timeout: 160000000
openAIApi:
  url: https://api.openai.com/v1

---

spring:
  profiles: prod

feign:
  client:
    config:
      openaiapi:
        connect-timeout: 1000
        read-timeout: 2000

openaiapi:
  url: https://api.openai.com/v1

Use our Maven plugin that will provide the OpenAIClient object.

Java:

<dependency>
    <groupId>com.vaysai</groupId>
    <artifactId>openaijava</artifactId>
    <version>0.1.0</version>
</dependency>

Use the @EnableOpenAIAPI annotation in your main class

@EnableOpenAIApiClient
@SpringApplication
public class SomeApplication{
    
    public static void main(String[] args){
        SpringApplication.run(SomeApplication.class, args)
    }
}

Autowire an OpenAIClient object

@Autowired
OpenAIClient openAIClient;

Create a method calling an endpoint

void listModels(){
    ListModelsResponse response = openAIClient.listModels();
    log.info(response);
}

Apache 2.0