xyz.felh.openai

Class OpenAiService

java.lang.Object

xyz.felh.openai.OpenAiService

public class OpenAiService
extends java.lang.Object

OpenAi Service Class

Constructor Summary

Constructors

Constructor and Description
OpenAiService(OpenAiApi api, okhttp3.OkHttpClient client) 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 OpenAiApi	buildApi(java.lang.String token, java.time.Duration timeout)
FineTune	cancelFineTune(java.lang.String fineTuneId)
AudioResponse	createAudioTranscription(CreateAudioTranscriptionRequest request) whisper-1
AudioResponse	createAudioTranslation(CreateAudioTranslationRequest request) whisper-1
ChatCompletion	createChatCompletion(CreateChatCompletionRequest request) gpt-4, gpt-4-0314, gpt-4-32k, gpt-4-32k-0314, gpt-3.5-turbo, gpt-3.5-turbo-0301
Completion	createCompletion(CreateCompletionRequest request) text-davinci-003, text-davinci-002, text-curie-001, text-babbage-001, text-ada-001, davinci, curie, babbage, ada
Edit	createEdit(CreateEditRequest request) text-davinci-edit-001, code-davinci-edit-001
CreateEmbeddingResponse	createEmbeddings(CreateEmbeddingRequest request) text-embedding-ada-002, text-search-ada-doc-001
FineTune	createFineTune(CreateFineTuneRequest request)
ImageResponse	createImage(CreateImageRequest request)
ImageResponse	createImageEdit(CreateImageEditRequest request)
ImageResponse	createImageVariation(CreateImageVariationRequest request)
CreateModerationResponse	createModeration(CreateModerationRequest request) text-moderation-stable, text-moderation-latest
void	createSteamChatCompletion(java.lang.String requestId, CreateChatCompletionRequest request, @NonNull StreamChatCompletionListener listener) create chat completion by stream
static okhttp3.OkHttpClient	defaultClient(java.lang.String token, java.time.Duration timeout)
static okhttp3.OkHttpClient	defaultClient(java.lang.String token, java.lang.String orgId, java.time.Duration timeout)
static com.fasterxml.jackson.databind.ObjectMapper	defaultObjectMapper()
static retrofit2.Retrofit	defaultRetrofit(okhttp3.OkHttpClient client, com.fasterxml.jackson.databind.ObjectMapper mapper)
DeleteResponse	deleteFile(java.lang.String fileId)
DeleteResponse	deleteFineTune(java.lang.String model, java.lang.String fineTuneId)
static <T> T	execute(io.reactivex.rxjava3.core.Single<T> apiCall) Calls the Open AI api, returns the response, and parses error messages if the request fails
Model	getModel(java.lang.String modelId)
java.util.List<File>	listFiles()
java.util.List<FineTuneEvent>	listFineTuneEvents(java.lang.String fineTuneId)
java.util.List<FineTune>	listFineTunes()
java.util.List<Model>	listModels()
File	retrieveFile(java.lang.String fileId)
RetrieveFileContentResponse	retrieveFileContent(java.lang.String fileId)
FineTune	retrieveFineTune(java.lang.String fineTuneId)
File	uploadFile(java.lang.String filepath, java.lang.String purpose)

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(OpenAiApi api,
                     okhttp3.OkHttpClient client)

Creates a new OpenAiService that wraps OpenAiApi. Use this if you need more customization.

Parameters:

api - OpenAiApi instance to use for all methods

Method Detail

execute

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

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

buildApi

public static 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)

defaultClient

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

defaultRetrofit

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

listModels

public java.util.List<Model> listModels()

getModel

public Model getModel(java.lang.String modelId)

createCompletion

public Completion createCompletion(CreateCompletionRequest request)

text-davinci-003, text-davinci-002, text-curie-001, text-babbage-001, text-ada-001, davinci, curie, babbage, ada

Parameters:

request - create completion request

Returns:

completion

createChatCompletion

public ChatCompletion createChatCompletion(CreateChatCompletionRequest request)

gpt-4, gpt-4-0314, gpt-4-32k, gpt-4-32k-0314, gpt-3.5-turbo, gpt-3.5-turbo-0301

Parameters:

request - create chat completion request

Returns:

chat completion

createSteamChatCompletion

public void createSteamChatCompletion(java.lang.String requestId,
                                      CreateChatCompletionRequest request,
                                      @NonNull
                                      @NonNull StreamChatCompletionListener listener)

create chat completion by stream

Parameters:

requestId - request ID, every observer is unique

request - detail of request

listener - StreamChatCompletionListener

createEdit

public Edit createEdit(CreateEditRequest request)

text-davinci-edit-001, code-davinci-edit-001

Parameters:

request - create edit request

Returns:

edit

createImage

public ImageResponse createImage(CreateImageRequest request)

createImageEdit

public ImageResponse createImageEdit(CreateImageEditRequest request)

createImageVariation

public ImageResponse createImageVariation(CreateImageVariationRequest request)

createEmbeddings

public CreateEmbeddingResponse createEmbeddings(CreateEmbeddingRequest request)

text-embedding-ada-002, text-search-ada-doc-001

Parameters:

request - create Embedding request

Returns:

create embedding response

createAudioTranscription

public AudioResponse createAudioTranscription(CreateAudioTranscriptionRequest request)

whisper-1

TODO only support mp3 so far

Parameters:

request - create audio transcription request

Returns:

audio response

createAudioTranslation

public AudioResponse createAudioTranslation(CreateAudioTranslationRequest request)

whisper-1

TODO only support mp3 so far

Parameters:

request - create audio traslation request

Returns:

audio

listFiles

public java.util.List<File> listFiles()

uploadFile

public File uploadFile(java.lang.String filepath,
                       java.lang.String purpose)

deleteFile

public DeleteResponse deleteFile(java.lang.String fileId)

retrieveFile

public File retrieveFile(java.lang.String fileId)

retrieveFileContent

public RetrieveFileContentResponse retrieveFileContent(java.lang.String fileId)

Parameters:

fileId - file id

Returns:

file content

createFineTune

public FineTune createFineTune(CreateFineTuneRequest request)

listFineTunes

public java.util.List<FineTune> listFineTunes()

retrieveFineTune

public FineTune retrieveFineTune(java.lang.String fineTuneId)

cancelFineTune

public FineTune cancelFineTune(java.lang.String fineTuneId)

listFineTuneEvents

public java.util.List<FineTuneEvent> listFineTuneEvents(java.lang.String fineTuneId)

deleteFineTune

public DeleteResponse deleteFineTune(java.lang.String model,
                                     java.lang.String fineTuneId)

createModeration

public CreateModerationResponse createModeration(CreateModerationRequest request)

text-moderation-stable, text-moderation-latest

Parameters:

request - create moderation request

Returns:

moderation response