com.theokanning.openai.service

Class OpenAiService

java.lang.Object

com.theokanning.openai.service.OpenAiService

public class OpenAiService
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
OpenAiService(com.theokanning.openai.OpenAiApi api) Creates a new OpenAiService that wraps OpenAiApi.
OpenAiService(com.theokanning.openai.OpenAiApi api, java.util.concurrent.ExecutorService executorService) Creates a new OpenAiService that wraps OpenAiApi.
OpenAiService(java.lang.String token) Creates a new OpenAiService that wraps OpenAiApi
OpenAiService(java.lang.String token, java.time.Duration timeout) Creates a new OpenAiService that wraps OpenAiApi

Method Summary

Modifier and Type	Method and Description
static com.theokanning.openai.OpenAiApi	buildApi(java.lang.String token, java.time.Duration timeout)
com.theokanning.openai.finetune.FineTuneResult	cancelFineTune(java.lang.String fineTuneId)
com.theokanning.openai.completion.chat.ChatCompletionResult	createChatCompletion(com.theokanning.openai.completion.chat.ChatCompletionRequest request)
com.theokanning.openai.completion.CompletionResult	createCompletion(com.theokanning.openai.completion.CompletionRequest request)
com.theokanning.openai.edit.EditResult	createEdit(com.theokanning.openai.edit.EditRequest request)
com.theokanning.openai.embedding.EmbeddingResult	createEmbeddings(com.theokanning.openai.embedding.EmbeddingRequest request)
com.theokanning.openai.finetune.FineTuneResult	createFineTune(com.theokanning.openai.finetune.FineTuneRequest request)
com.theokanning.openai.completion.CompletionResult	createFineTuneCompletion(com.theokanning.openai.completion.CompletionRequest request)
com.theokanning.openai.image.ImageResult	createImage(com.theokanning.openai.image.CreateImageRequest request)
com.theokanning.openai.image.ImageResult	createImageEdit(com.theokanning.openai.image.CreateImageEditRequest request, java.io.File image, java.io.File mask)
com.theokanning.openai.image.ImageResult	createImageEdit(com.theokanning.openai.image.CreateImageEditRequest request, java.lang.String imagePath, java.lang.String maskPath)
com.theokanning.openai.image.ImageResult	createImageVariation(com.theokanning.openai.image.CreateImageVariationRequest request, java.io.File image)
com.theokanning.openai.image.ImageResult	createImageVariation(com.theokanning.openai.image.CreateImageVariationRequest request, java.lang.String imagePath)
com.theokanning.openai.moderation.ModerationResult	createModeration(com.theokanning.openai.moderation.ModerationRequest request)
static okhttp3.OkHttpClient	defaultClient(java.lang.String token, java.time.Duration timeout)
static com.fasterxml.jackson.databind.ObjectMapper	defaultObjectMapper()
static retrofit2.Retrofit	defaultRetrofit(okhttp3.OkHttpClient client, com.fasterxml.jackson.databind.ObjectMapper mapper)
com.theokanning.openai.DeleteResult	deleteFile(java.lang.String fileId)
com.theokanning.openai.DeleteResult	deleteFineTune(java.lang.String fineTuneId)
static <T> T	execute(io.reactivex.Single<T> apiCall) Calls the Open AI api, returns the response, and parses error messages if the request fails
com.theokanning.openai.model.Model	getModel(java.lang.String modelId)
java.util.List<com.theokanning.openai.file.File>	listFiles()
java.util.List<com.theokanning.openai.finetune.FineTuneEvent>	listFineTuneEvents(java.lang.String fineTuneId)
java.util.List<com.theokanning.openai.finetune.FineTuneResult>	listFineTunes()
java.util.List<com.theokanning.openai.model.Model>	listModels()
com.theokanning.openai.file.File	retrieveFile(java.lang.String fileId)
com.theokanning.openai.finetune.FineTuneResult	retrieveFineTune(java.lang.String fineTuneId)
void	shutdownExecutor() Shuts down the OkHttp ExecutorService.
static io.reactivex.Flowable<SSE>	stream(retrofit2.Call<okhttp3.ResponseBody> apiCall) Calls the Open AI api and returns a Flowable of SSE for streaming omitting the last message.
static io.reactivex.Flowable<SSE>	stream(retrofit2.Call<okhttp3.ResponseBody> apiCall, boolean emitDone) Calls the Open AI api and returns a Flowable of SSE for streaming.
static <T> io.reactivex.Flowable<T>	stream(retrofit2.Call<okhttp3.ResponseBody> apiCall, java.lang.Class<T> cl) Calls the Open AI api and returns a Flowable of type T for streaming omitting the last message.
io.reactivex.Flowable<com.theokanning.openai.completion.chat.ChatCompletionChunk>	streamChatCompletion(com.theokanning.openai.completion.chat.ChatCompletionRequest request)
io.reactivex.Flowable<com.theokanning.openai.completion.CompletionChunk>	streamCompletion(com.theokanning.openai.completion.CompletionRequest request)
com.theokanning.openai.file.File	uploadFile(java.lang.String purpose, java.lang.String filepath)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenAiService

public OpenAiService(java.lang.String token)

Creates a new OpenAiService that wraps OpenAiApi

Parameters:

token - OpenAi token string "sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

OpenAiService

public OpenAiService(java.lang.String token,
                     java.time.Duration timeout)

Creates a new OpenAiService that wraps OpenAiApi

Parameters:

token - OpenAi token string "sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

timeout - http read timeout, Duration.ZERO means no timeout

OpenAiService

public OpenAiService(com.theokanning.openai.OpenAiApi api)

Creates a new OpenAiService that wraps OpenAiApi. Use this if you need more customization, but use OpenAiService(api, executorService) if you use streaming and want to shut down instantly

Parameters:

api - OpenAiApi instance to use for all methods

OpenAiService

public OpenAiService(com.theokanning.openai.OpenAiApi api,
                     java.util.concurrent.ExecutorService executorService)

Creates a new OpenAiService that wraps OpenAiApi. The ExecutorService must be the one you get from the client you created the api with otherwise shutdownExecutor() won't work.

Use this if you need more customization.

Parameters:

api - OpenAiApi instance to use for all methods

executorService - the ExecutorService from client.dispatcher().executorService()

Method Detail

listModels

public java.util.List<com.theokanning.openai.model.Model> listModels()

getModel

public com.theokanning.openai.model.Model getModel(java.lang.String modelId)

createCompletion

public com.theokanning.openai.completion.CompletionResult createCompletion(com.theokanning.openai.completion.CompletionRequest request)

streamCompletion

public io.reactivex.Flowable<com.theokanning.openai.completion.CompletionChunk> streamCompletion(com.theokanning.openai.completion.CompletionRequest request)

createChatCompletion

public com.theokanning.openai.completion.chat.ChatCompletionResult createChatCompletion(com.theokanning.openai.completion.chat.ChatCompletionRequest request)

streamChatCompletion

public io.reactivex.Flowable<com.theokanning.openai.completion.chat.ChatCompletionChunk> streamChatCompletion(com.theokanning.openai.completion.chat.ChatCompletionRequest request)

createEdit

public com.theokanning.openai.edit.EditResult createEdit(com.theokanning.openai.edit.EditRequest request)

createEmbeddings

public com.theokanning.openai.embedding.EmbeddingResult createEmbeddings(com.theokanning.openai.embedding.EmbeddingRequest request)

listFiles

public java.util.List<com.theokanning.openai.file.File> listFiles()

uploadFile

public com.theokanning.openai.file.File uploadFile(java.lang.String purpose,
                                                   java.lang.String filepath)

deleteFile

public com.theokanning.openai.DeleteResult deleteFile(java.lang.String fileId)

retrieveFile

public com.theokanning.openai.file.File retrieveFile(java.lang.String fileId)

createFineTune

public com.theokanning.openai.finetune.FineTuneResult createFineTune(com.theokanning.openai.finetune.FineTuneRequest request)

createFineTuneCompletion

public com.theokanning.openai.completion.CompletionResult createFineTuneCompletion(com.theokanning.openai.completion.CompletionRequest request)

listFineTunes

public java.util.List<com.theokanning.openai.finetune.FineTuneResult> listFineTunes()

retrieveFineTune

public com.theokanning.openai.finetune.FineTuneResult retrieveFineTune(java.lang.String fineTuneId)

cancelFineTune

public com.theokanning.openai.finetune.FineTuneResult cancelFineTune(java.lang.String fineTuneId)

listFineTuneEvents

public java.util.List<com.theokanning.openai.finetune.FineTuneEvent> listFineTuneEvents(java.lang.String fineTuneId)

deleteFineTune

public com.theokanning.openai.DeleteResult deleteFineTune(java.lang.String fineTuneId)

createImage

public com.theokanning.openai.image.ImageResult createImage(com.theokanning.openai.image.CreateImageRequest request)

createImageEdit

public com.theokanning.openai.image.ImageResult createImageEdit(com.theokanning.openai.image.CreateImageEditRequest request,
                                                                java.lang.String imagePath,
                                                                java.lang.String maskPath)

createImageEdit

public com.theokanning.openai.image.ImageResult createImageEdit(com.theokanning.openai.image.CreateImageEditRequest request,
                                                                java.io.File image,
                                                                java.io.File mask)

createImageVariation

public com.theokanning.openai.image.ImageResult createImageVariation(com.theokanning.openai.image.CreateImageVariationRequest request,
                                                                     java.lang.String imagePath)

createImageVariation

public com.theokanning.openai.image.ImageResult createImageVariation(com.theokanning.openai.image.CreateImageVariationRequest request,
                                                                     java.io.File image)

createModeration

public com.theokanning.openai.moderation.ModerationResult createModeration(com.theokanning.openai.moderation.ModerationRequest request)

execute

public static <T> T execute(io.reactivex.Single<T> apiCall)

Calls the Open AI api, returns the response, and parses error messages if the request fails

stream

public static io.reactivex.Flowable<SSE> stream(retrofit2.Call<okhttp3.ResponseBody> apiCall)

Calls the Open AI api and returns a Flowable of SSE for streaming omitting the last message.

Parameters:

apiCall - The api call

stream

public static io.reactivex.Flowable<SSE> stream(retrofit2.Call<okhttp3.ResponseBody> apiCall,
                                                boolean emitDone)

Calls the Open AI api and returns a Flowable of SSE for streaming.

Parameters:

apiCall - The api call

emitDone - If true the last message ([DONE]) is emitted

stream

public static <T> io.reactivex.Flowable<T> stream(retrofit2.Call<okhttp3.ResponseBody> apiCall,
                                                  java.lang.Class<T> cl)

Calls the Open AI api and returns a Flowable of type T for streaming omitting the last message.

Parameters:

apiCall - The api call

cl - Class of type T to return

shutdownExecutor

public void shutdownExecutor()

Shuts down the OkHttp ExecutorService. The default behaviour of OkHttp's ExecutorService (ConnectionPool) is to shut down after an idle timeout of 60s. Call this method to shut down the ExecutorService immediately.

buildApi

public static com.theokanning.openai.OpenAiApi buildApi(java.lang.String token,
                                                        java.time.Duration timeout)

defaultObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper defaultObjectMapper()

defaultClient

public static okhttp3.OkHttpClient defaultClient(java.lang.String token,
                                                 java.time.Duration timeout)

defaultRetrofit

public static retrofit2.Retrofit defaultRetrofit(okhttp3.OkHttpClient client,
                                                 com.fasterxml.jackson.databind.ObjectMapper mapper)