Spring Boot Starter for OpenAI SDK by Codexio

Use artificial intelligence the intelligent way.

Preambule

The Spring Boot starter provides autoconfiguration for the OpenAI SDK by Codexio, which means you can inject meaningful beans into your Spring Boot project, by just providing property configuration such as your apiKey.

Table of Contents

• Quick Start
• Prerequisite
• Property Configuration
  • Credentials
  • Logging
  • HTTP
    • Timeouts
    • Connection Pool
• Autoconfigured Beans
  • Chat
  • Images
  • Vision
  • Voice
• JSON Auth Limitations
• Contributing
• License

Quick Start

1. First of all, make sure you have created an API Key from here.
2. Open your Spring Boot Project (or create one)
3. Add the library as a dependency in your project

<dependency>
    <groupId>bg.codexio.springframework.boot</groupId>
    <artifactId>spring-boot-starter-openai</artifactId>
    <version>0.8.1.BETA</version>
</dependency>

4. Configure API key:

   • application.properties:

    codexio.openai.api-key=YOUR_API_KEY_HERE
   

   • application.yml:

    codexio:
      openai:
        api-key: YOUR_API_KEY_HERE
   

5. Inject the ChatApi (or Gpt35ChatApi. Gpt4ChatApi, ImagesApi, VisionApi, SpeechApi, TranscriptionApi, TranslationApi ) bean to some of your services / controllers:

@RestController
@RequestMapping("/conversations")
public class ChatController {

    private final GPT4ChatApi chatApi;

    public ChatController(GPT4ChatApi chatApi) {
        this.chatApi = chatApi;
    }

    @PostMapping
    public String chat(@RequestBody String prompt) {
        return this.chatApi.deterministic()
                           .andRespond()
                           .immediate()
                           .ask(prompt);
    }
}

6. Run your application

INFO 37908 --- [main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port 8080 (http) with context path ''
INFO 37908 --- [main] b.c.test.TestOpenAIStarter               : Started TestOpenAIStarterApp in 2.786 seconds (process running for 3.142)

7. Send Request and check the response :)

$ curl -d "How much is 2+2, elaborate" http://localhost:8080/conversations
2 + 2 equals 4.

This is a basic arithmetic operation where you are adding two numbers together. 
The number 2 is added to another number 2, which results in the sum of 4. 
This operation follows the fundamental concept of addition in mathematics, 
where combining two quantities gives you a larger quantity.

Prerequisite

You have to be familiar with the underlying preconfigured library called OpenAI API SDK. Read the docs at the repository.

Property Configuration

We rely on your PropertySources to configure the OpenAI SDK. Things like API Key, Organization, Base URL, Logging Config and HTTP Config are now pulled out to application.propertyies / application.yml. If you are already used to default FromEnvironment or FromJson authentication types, just point it out as a property, e.g.: codexio.openai.auth-type=bg.codexio.ai.openai.api.sdk.auth.FromJson.

Below you can find a list of properties you can use to configure the SDK.

Credentials

All properties are prefixed with codexio.openai.

Logging

All properties are prefixed with codexio.openai.logging.

HTTP

All properties are prefixed with codexio.openai.http.

Timeouts

Timeouts are configured for each {type} (call, connect and read). All properties are prefixed by codexio.openai.http.timeouts.{type}.

Connection Pool

All properties are prefixed by codexio.openai.http.connection-pool.

Autoconfigured Beans

Once you configure everything (remember, only codexio.openai.api-key is mandatory), you can start injecting autoconfigured beans, as follows:

Chat

Classes are in package bg.codexio.ai.openai.api.sdk.chat

Images

Classes are in package bg.codexio.ai.openai.api.sdk.images

Vision

Classes are in package bg.codexio.ai.openai.api.sdk.vision

Voice

Classes are in package bg.codexio.ai.openai.api.sdk.voice

JSON Auth Limitations

If you want to retain the usage of FromJson.AUTH in conjunction with Spring Properties, you will be limited to the already configured FromJson bean:

@Bean
@ConditionalOnMissingBean(FromJson.class)
public FromJson fromJson() {
    return FromJson.AUTH;
}

Which means, that your JSON configuration will be searched in src/main/resources/openai-cerdentials.json. If you want to use another resource (or even absolute path) file, you need to redefine the bean. So, if your file is located in /etc/openai/credentials.json, do the following:

public class OpenAIConfig {

    @Bean
    public FromJson fromJson() {
        return FromJson.file("/etc/openai/credentials.json");
    }
}

Then you are safe to use codexio.openai.auth-type=bg.codexio.ai.openai.api.sdk.auth.FromJson property.

Contributing

This project is in its very early stage and contributors are very welcomed. If you feel that something has to be changed or a bug to be fixed, you can report a new issue, and we can take care of it.

If you want to submit directly a code fix, we will be more than glad to see it. Fork the repository and start a clean branch out of the version you want to patch.

Please, use the code style in the project root folder. If your IDE does not support it, we strongly encourage you just to follow the code styling in the rest of the classes and methods.

After you are finished, create a pull request. We will review the request and either leave some meaningful suggestions back or maybe merge it and release it with the next release.

The first open beta of the project is 0.8.0 and all the way up to 1.0.0 we will strive to find core contributors who will serve as project maintainers in the future. Codexio Ltd. will remain the main project maintainer.

...

License

Copyright 2024 Codexio Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.