Simple-OpenAI: The OpenAI Java Client

sashirestela · September 2, 2023, 5:27pm

Let me introduce Simple OpenAI a Java http client library for sending requests to and receiving responses from the OpenAI Api. It exposes a consistent interface across all the services, yet as simple as you can find in other languages like Python or NodeJs.

Simple-OpenAI uses the CleverClient library for http communication, Jackson for Json parsing, and Lombok to minimize boilerplate code.

PaulBellow · September 2, 2023, 7:20pm

Nice. Thanks for sharing with us. … Appreciate it!

sashirestela · September 4, 2023, 12:42am

Hello OpenAI community !!

I would really like to get feedback/thoughts/concerns about this Java library in order to improve it or include any necessary functionality. Please feel free to drop a few lines here, I would appreciate it.

King regards

Sashir

sashirestela · September 14, 2023, 8:15pm

A new release of Simple OpenAI is available. It has fixes for some minor issues and testing coverage of 95%.

sashirestela · February 19, 2024, 7:35pm

New Major Release 2.0.0

I’m happy to announce that we have released a new major version of our simple-openai library.

The main change is that from now on we support the use of OpenAI with two additional providers: Azure and Anyscale. Currently, we are supporting the chat completion service for both providers.

For the original provider we have full updated support for all the OpenAI services: audio, chat completion, completion, embedding, file, fine tuning, image, model, moderation, assistant, thread.

Take a look for more detail.

sashirestela · April 9, 2024, 12:23am

New Release 2.2.0

The library has been updated with the latest changes from OpenAI:

Support for Assistant Stream Events.
Sync changes in Audio API.
Sync changes in FineTuning API.
Sync changes in Assistant API.

Other internal improvements:

Improve field validation.
Split OpenAI interface.
Automate code formatting.
Add contribution instructions.
Setup for deploying to Maven Central.

Take a look at simple-openai.

sashirestela · April 19, 2024, 7:53pm

New Release 2.3.0

Simple-OpenAI has been updated with the latest changes from OpenAI until Apr 16:

Support for new Batch API.
Support for new Project Key.
Enabling Assistant API for Azure.
Fixing SonarCloud issues.

Take a look at simple-openai .

atulsmailbox · April 27, 2024, 4:48pm

Sashi, this is some great stuff - thank you very much for this. I will be looking to test porting my existing code from another java client to yours. Would love to see you tackle Assistants V2 API as well. Keep up the good work!

sashirestela · May 7, 2024, 12:51pm

New Release 3.0.0

Simple-OpenAI has been updated with the latest changes from OpenAI until Apr 29th:

Full Support for Assistants API v2
- Assistants, Threads, Messages, Runs, Run Steps.
- File Search Tool, Vector Stores, Vector Stores Batches.
- Full Streaming, Pooling Helpers if not using streaming.
- Demo code using Functions, File Search and Streaming.
Functions & Tools code was revamped to be shared between
Assistants and Chat Completions.
Code for Assistants API v1 was entirely removed.

Take a look at simple-openai .

sashirestela · May 8, 2024, 12:04am

New Release 3.1.0

Simple-OpenAI has been updated with the latest changes from OpenAI until May 6th, 2024:

Support for the stream_options parameter
for Chat Completions and Completions APIs

Take a look at simple-openai .

sashirestela · May 12, 2024, 7:56pm

“AI is like electricity. Just as electricity transformed every major industry a century ago, AI is now poised to do the same.” By Andrew Ng

New Release 3.2.0

Simple-OpenAI seeks to stay up to date with the most recent changes in OpenAI. Currently, it supports all existing features until May 9th, 2024 and will continue to update with future changes.

What’s new in this release?

Support for image inputs to the Assistants API
Fix some minor issues

If you are a Java developer venturing into the world of AI, don’t miss the opportunity to take a look at simple-openai.

sashirestela · May 27, 2024, 4:01pm

New Release 3.3.0

What’s new?

FunctionExecutor allows functions auto selection based on toolChoice
Conversation examples with gpt-4o with streaming and functions
Enable ToolFunctionDef instantiation (for custom function handlers)
Fix some minor issues (AssistantTool, File Path Windows, Javadoc)

Take a look at simple-openai and enjoy the most up-to-date OpenAI features available for use in your Java projects.

sashirestela · June 5, 2024, 11:23am

New Release 3.4.0

Simple-OpenAI has been updated with the latest changes from OpenAI until Jun 3rd, 2024:

Support for File Search Customizations

Take a look at simple-openai and enjoy the most up-to-date OpenAI features available for use in your Java projects.

sashirestela · June 7, 2024, 3:38pm

New Release 3.5.0

Simple-OpenAI has been updated with the latest changes from OpenAI until Jun 6th, 2024:

Support for disabling Parallel Function Calling

Take a look at simple-openai and enjoy the most up-to-date OpenAI features available for use in your Java projects.

sashirestela · July 22, 2024, 2:21pm

New Release 3.6.0

Simple-OpenAI has been updated with the latest changes from OpenAI:

Support for the new Upload API
Examples were updated to use gpt-4o-mini
Customizing JsonSchema for functions
Fix for creating VectorStoreFile

Take a look at simple-openai.

sashirestela · August 8, 2024, 5:05pm

Who Is Using Simple-OpenAI?

ChatMotor: A framework for OpenAI services. Thanks for credits!
OpenOLAT: A learning managment system.
Willy: A multi-channel assistant.
SuperTurtyBot: A multi-purpose discord bot.
Woolly: A code generation IntelliJ plugin.
Vinopener: A wine recommender app.

New additions to the list:

Cryptik.ai GPT Chatbot: A Telegram chatbot factory.

sashirestela · August 19, 2024, 10:22pm

New Release 3.7.0

Simple-OpenAI has been updated to support Structured Outputs to ensure the model will always generate responses that adhere to a Json Schema defined through Java classes.

Take a look at simple-openai.

sashirestela · August 31, 2024, 3:44am

New Release 3.8.0

Simple-OpenAI has been updated with the latest changes from OpenAI:

File Search Improvements in Assistants API :
- Configure Ranking Options.
- Inspecting details for File Steps.
Fixing issue to handle Functions without parameters

Take a look at simple-openai.

sashirestela · September 1, 2024, 5:28pm

Take a look at my latest article about Simple-OpenAI and learn about the library that allows you to integrate cutting-edge AI services into your Java applications in the easiest way possible.

sashirestela · October 21, 2024, 9:59pm

New Release 3.9.0

simple-openai has been updated to support Audio on Chat Completions API.

You can take a look at the following demo code to see async speech to speech interactions with a model (audio in, audio out):

github.com

sashirestela/simple-openai/blob/main/src/demo/java/io/github/sashirestela/openai/demo/ChatDemo.java#L163-L194


      
          public void demoCallChatWithAudioInputOutput() {
              var messages = new ArrayList<ChatMessage>();
              messages.add(SystemMessage.of("Respond in a short and concise way."));
              messages.add(UserMessage.of(List.of(ContentPartInputAudio.of(InputAudio.of(
                      Base64Util.encode("src/demo/resources/question1.mp3", null), InputAudioFormat.MP3)))));
              chatRequest = ChatRequest.builder()
                      .model(modelAudio)
                      .modality(Modality.TEXT)
                      .modality(Modality.AUDIO)
                      .audio(Audio.of(Voice.ALLOY, AudioFormat.MP3))
                      .messages(messages)
                      .build();
              var chatResponse = openAI.chatCompletions().create(chatRequest).join();
              var audio = chatResponse.firstMessage().getAudio();
              Base64Util.decode(audio.getData(), "src/demo/resources/answer1.mp3");
              System.out.println("Answer 1: " + audio.getTranscript());
          
              messages.add(AssistantMessage.builder().audioId(audio.getId()).build());
              messages.add(UserMessage.of(List.of(ContentPartInputAudio.of(InputAudio.of(
                      Base64Util.encode("src/demo/resources/question2.mp3", null), InputAudioFormat.MP3)))));

This file has been truncated. show original

Topic		Replies	Views
Java library Simple-OpenAI updated to the last API API api , openai , java	0	1869	November 28, 2023
Comparing some OpenAI Java libraries Community gpt-4 , api , openai , java , simple-openai	0	2875	February 13, 2024
Jvm-openai - A minimalistic Java client for the OpenAI API Community api	21	5161	September 12, 2024
JavaAI - Lightweight Java library to interact with the OpenAI API API chatgpt , api , community , java	1	549	October 22, 2024
Is there an OpenAI Java API or GPT-3 Java SDK API	14	7614	May 31, 2024

Simple-OpenAI: The OpenAI Java Client

New Major Release 2.0.0

New Release 2.2.0

New Release 2.3.0

New Release 3.0.0

New Release 3.1.0

New Release 3.2.0

New Release 3.3.0

New Release 3.4.0

New Release 3.5.0

New Release 3.6.0

Who Is Using Simple-OpenAI?

New Release 3.7.0

New Release 3.8.0

New Release 3.9.0

Related Topics