com.theokanning.openai

Interface OpenAiApi

public interface OpenAiApi

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<com.theokanning.openai.finetune.FineTuneResult>	cancelFineTune(java.lang.String fineTuneId)
io.reactivex.Single<com.theokanning.openai.completion.chat.ChatCompletionResult>	createChatCompletion(com.theokanning.openai.completion.chat.ChatCompletionRequest request)
retrofit2.Call<okhttp3.ResponseBody>	createChatCompletionStream(com.theokanning.openai.completion.chat.ChatCompletionRequest request)
io.reactivex.Single<com.theokanning.openai.completion.CompletionResult>	createCompletion(com.theokanning.openai.completion.CompletionRequest request)
io.reactivex.Single<com.theokanning.openai.completion.CompletionResult>	createCompletion(java.lang.String engineId, com.theokanning.openai.completion.CompletionRequest request) Deprecated.
retrofit2.Call<okhttp3.ResponseBody>	createCompletionStream(com.theokanning.openai.completion.CompletionRequest request)
io.reactivex.Single<com.theokanning.openai.edit.EditResult>	createEdit(com.theokanning.openai.edit.EditRequest request)
io.reactivex.Single<com.theokanning.openai.edit.EditResult>	createEdit(java.lang.String engineId, com.theokanning.openai.edit.EditRequest request) Deprecated.
io.reactivex.Single<com.theokanning.openai.embedding.EmbeddingResult>	createEmbeddings(com.theokanning.openai.embedding.EmbeddingRequest request)
io.reactivex.Single<com.theokanning.openai.embedding.EmbeddingResult>	createEmbeddings(java.lang.String engineId, com.theokanning.openai.embedding.EmbeddingRequest request) Deprecated.
io.reactivex.Single<com.theokanning.openai.finetune.FineTuneResult>	createFineTune(com.theokanning.openai.finetune.FineTuneRequest request)
io.reactivex.Single<com.theokanning.openai.completion.CompletionResult>	createFineTuneCompletion(com.theokanning.openai.completion.CompletionRequest request)
io.reactivex.Single<com.theokanning.openai.image.ImageResult>	createImage(com.theokanning.openai.image.CreateImageRequest request)
io.reactivex.Single<com.theokanning.openai.image.ImageResult>	createImageEdit(okhttp3.RequestBody requestBody)
io.reactivex.Single<com.theokanning.openai.image.ImageResult>	createImageVariation(okhttp3.RequestBody requestBody)
io.reactivex.Single<com.theokanning.openai.moderation.ModerationResult>	createModeration(com.theokanning.openai.moderation.ModerationRequest request)
io.reactivex.Single<com.theokanning.openai.DeleteResult>	deleteFile(java.lang.String fileId)
io.reactivex.Single<com.theokanning.openai.DeleteResult>	deleteFineTune(java.lang.String fineTuneId)
io.reactivex.Single<com.theokanning.openai.engine.Engine>	getEngine(java.lang.String engineId) Deprecated.
io.reactivex.Single<com.theokanning.openai.OpenAiResponse<com.theokanning.openai.engine.Engine>>	getEngines() Deprecated.
io.reactivex.Single<com.theokanning.openai.model.Model>	getModel(java.lang.String modelId)
io.reactivex.Single<com.theokanning.openai.OpenAiResponse<com.theokanning.openai.file.File>>	listFiles()
io.reactivex.Single<com.theokanning.openai.OpenAiResponse<com.theokanning.openai.finetune.FineTuneEvent>>	listFineTuneEvents(java.lang.String fineTuneId)
io.reactivex.Single<com.theokanning.openai.OpenAiResponse<com.theokanning.openai.finetune.FineTuneResult>>	listFineTunes()
io.reactivex.Single<com.theokanning.openai.OpenAiResponse<com.theokanning.openai.model.Model>>	listModels()
io.reactivex.Single<com.theokanning.openai.file.File>	retrieveFile(java.lang.String fileId)
io.reactivex.Single<com.theokanning.openai.finetune.FineTuneResult>	retrieveFineTune(java.lang.String fineTuneId)
io.reactivex.Single<com.theokanning.openai.file.File>	uploadFile(okhttp3.RequestBody purpose, okhttp3.MultipartBody.Part file)

Method Detail

listModels

@GET(value="v1/models")
io.reactivex.Single<com.theokanning.openai.OpenAiResponse<com.theokanning.openai.model.Model>> listModels()

getModel

@GET(value="/v1/models/{model_id}")
io.reactivex.Single<com.theokanning.openai.model.Model> getModel(@Path(value="model_id")
                                                                                                     java.lang.String modelId)

createCompletion

@POST(value="/v1/completions")
io.reactivex.Single<com.theokanning.openai.completion.CompletionResult> createCompletion(@Body
                                                                                                                        com.theokanning.openai.completion.CompletionRequest request)

createCompletionStream

@Streaming
 @POST(value="/v1/completions")
retrofit2.Call<okhttp3.ResponseBody> createCompletionStream(@Body
                                                                                                       com.theokanning.openai.completion.CompletionRequest request)

createChatCompletion

@POST(value="/v1/chat/completions")
io.reactivex.Single<com.theokanning.openai.completion.chat.ChatCompletionResult> createChatCompletion(@Body
                                                                                                                                          com.theokanning.openai.completion.chat.ChatCompletionRequest request)

createChatCompletionStream

@Streaming
 @POST(value="/v1/chat/completions")
retrofit2.Call<okhttp3.ResponseBody> createChatCompletionStream(@Body
                                                                                                                com.theokanning.openai.completion.chat.ChatCompletionRequest request)

createCompletion

@Deprecated
 @POST(value="/v1/engines/{engine_id}/completions")
io.reactivex.Single<com.theokanning.openai.completion.CompletionResult> createCompletion(@Path(value="engine_id")
                                                                                                                                                         java.lang.String engineId,
                                                                                                                                                         @Body
                                                                                                                                                         com.theokanning.openai.completion.CompletionRequest request)

Deprecated.

createEdit

@POST(value="/v1/edits")
io.reactivex.Single<com.theokanning.openai.edit.EditResult> createEdit(@Body
                                                                                                com.theokanning.openai.edit.EditRequest request)

createEdit

@Deprecated
 @POST(value="/v1/engines/{engine_id}/edits")
io.reactivex.Single<com.theokanning.openai.edit.EditResult> createEdit(@Path(value="engine_id")
                                                                                                                                 java.lang.String engineId,
                                                                                                                                 @Body
                                                                                                                                 com.theokanning.openai.edit.EditRequest request)

Deprecated.

createEmbeddings

@POST(value="/v1/embeddings")
io.reactivex.Single<com.theokanning.openai.embedding.EmbeddingResult> createEmbeddings(@Body
                                                                                                                     com.theokanning.openai.embedding.EmbeddingRequest request)

createEmbeddings

@Deprecated
 @POST(value="/v1/engines/{engine_id}/embeddings")
io.reactivex.Single<com.theokanning.openai.embedding.EmbeddingResult> createEmbeddings(@Path(value="engine_id")
                                                                                                                                                      java.lang.String engineId,
                                                                                                                                                      @Body
                                                                                                                                                      com.theokanning.openai.embedding.EmbeddingRequest request)

Deprecated.

listFiles

@GET(value="/v1/files")
io.reactivex.Single<com.theokanning.openai.OpenAiResponse<com.theokanning.openai.file.File>> listFiles()

uploadFile

@Multipart
 @POST(value="/v1/files")
io.reactivex.Single<com.theokanning.openai.file.File> uploadFile(@Part(value="purpose")
                                                                                                      okhttp3.RequestBody purpose,
                                                                                                      @Part
                                                                                                      okhttp3.MultipartBody.Part file)

deleteFile

@DELETE(value="/v1/files/{file_id}")
io.reactivex.Single<com.theokanning.openai.DeleteResult> deleteFile(@Path(value="file_id")
                                                                                                         java.lang.String fileId)

retrieveFile

@GET(value="/v1/files/{file_id}")
io.reactivex.Single<com.theokanning.openai.file.File> retrieveFile(@Path(value="file_id")
                                                                                                     java.lang.String fileId)

createFineTune

@POST(value="/v1/fine-tunes")
io.reactivex.Single<com.theokanning.openai.finetune.FineTuneResult> createFineTune(@Body
                                                                                                                 com.theokanning.openai.finetune.FineTuneRequest request)

createFineTuneCompletion

@POST(value="/v1/completions")
io.reactivex.Single<com.theokanning.openai.completion.CompletionResult> createFineTuneCompletion(@Body
                                                                                                                                com.theokanning.openai.completion.CompletionRequest request)

listFineTunes

@GET(value="/v1/fine-tunes")
io.reactivex.Single<com.theokanning.openai.OpenAiResponse<com.theokanning.openai.finetune.FineTuneResult>> listFineTunes()

retrieveFineTune

@GET(value="/v1/fine-tunes/{fine_tune_id}")
io.reactivex.Single<com.theokanning.openai.finetune.FineTuneResult> retrieveFineTune(@Path(value="fine_tune_id")
                                                                                                                                 java.lang.String fineTuneId)

cancelFineTune

@POST(value="/v1/fine-tunes/{fine_tune_id}/cancel")
io.reactivex.Single<com.theokanning.openai.finetune.FineTuneResult> cancelFineTune(@Path(value="fine_tune_id")
                                                                                                                                       java.lang.String fineTuneId)

listFineTuneEvents

@GET(value="/v1/fine-tunes/{fine_tune_id}/events")
io.reactivex.Single<com.theokanning.openai.OpenAiResponse<com.theokanning.openai.finetune.FineTuneEvent>> listFineTuneEvents(@Path(value="fine_tune_id")
                                                                                                                                                                                java.lang.String fineTuneId)

deleteFineTune

@DELETE(value="/v1/models/{fine_tune_id}")
io.reactivex.Single<com.theokanning.openai.DeleteResult> deleteFineTune(@Path(value="fine_tune_id")
                                                                                                                   java.lang.String fineTuneId)

createImage

@POST(value="/v1/images/generations")
io.reactivex.Single<com.theokanning.openai.image.ImageResult> createImage(@Body
                                                                                                                com.theokanning.openai.image.CreateImageRequest request)

createImageEdit

@POST(value="/v1/images/edits")
io.reactivex.Single<com.theokanning.openai.image.ImageResult> createImageEdit(@Body
                                                                                                              okhttp3.RequestBody requestBody)

createImageVariation

@POST(value="/v1/images/variations")
io.reactivex.Single<com.theokanning.openai.image.ImageResult> createImageVariation(@Body
                                                                                                                        okhttp3.RequestBody requestBody)

createModeration

@POST(value="/v1/moderations")
io.reactivex.Single<com.theokanning.openai.moderation.ModerationResult> createModeration(@Body
                                                                                                                        com.theokanning.openai.moderation.ModerationRequest request)

getEngines

@Deprecated
 @GET(value="v1/engines")
io.reactivex.Single<com.theokanning.openai.OpenAiResponse<com.theokanning.openai.engine.Engine>> getEngines()

Deprecated.

getEngine

@Deprecated
 @GET(value="/v1/engines/{engine_id}")
io.reactivex.Single<com.theokanning.openai.engine.Engine> getEngine(@Path(value="engine_id")
                                                                                                                       java.lang.String engineId)

Deprecated.