Index (simple-openai 0.5.0 API)

A B C D E F G H I J M N O P R S T U V X
All Classes All Packages

A

AbstractImageRequest - Class in io.github.sashirestela.openai.domain.image
AbstractImageRequest() - Constructor for class io.github.sashirestela.openai.domain.image.AbstractImageRequest
ASSISTANT - io.github.sashirestela.openai.domain.chat.Role
AudioRespFmt - Enum in io.github.sashirestela.openai.domain.audio
AudioResponse - Class in io.github.sashirestela.openai.domain.audio
AudioResponse() - Constructor for class io.github.sashirestela.openai.domain.audio.AudioResponse
audios() - Method in class io.github.sashirestela.openai.SimpleOpenAI: Generates an implementation of the Audios interface to handle requests.
AudioTranscribeRequest - Class in io.github.sashirestela.openai.domain.audio
AudioTranscribeRequest() - Constructor for class io.github.sashirestela.openai.domain.audio.AudioTranscribeRequest
AudioTranslateRequest - Class in io.github.sashirestela.openai.domain.audio
AudioTranslateRequest() - Constructor for class io.github.sashirestela.openai.domain.audio.AudioTranslateRequest

B

B64JSON - io.github.sashirestela.openai.domain.image.ImageRespFmt

C

cancel(String) - Method in interface io.github.sashirestela.openai.OpenAI.FineTunings: Immediately cancel a fine-tune job.
Category - Class in io.github.sashirestela.openai.domain.moderation
Category() - Constructor for class io.github.sashirestela.openai.domain.moderation.Category
CategoryScore - Class in io.github.sashirestela.openai.domain.moderation
CategoryScore() - Constructor for class io.github.sashirestela.openai.domain.moderation.CategoryScore
chatCompletions() - Method in class io.github.sashirestela.openai.SimpleOpenAI: Generates an implementation of the ChatCompletions interface to handle requests.
ChatFunction - Class in io.github.sashirestela.openai.domain.chat
ChatFunction() - Constructor for class io.github.sashirestela.openai.domain.chat.ChatFunction
ChatFunctionCall - Class in io.github.sashirestela.openai.domain.chat
ChatFunctionCall() - Constructor for class io.github.sashirestela.openai.domain.chat.ChatFunctionCall
ChatMessage - Class in io.github.sashirestela.openai.domain.chat
ChatMessage(Role, String, String, ChatFunctionCall) - Constructor for class io.github.sashirestela.openai.domain.chat.ChatMessage
ChatMessage(Role, String) - Constructor for class io.github.sashirestela.openai.domain.chat.ChatMessage
ChatRequest - Class in io.github.sashirestela.openai.domain.chat
ChatRequest() - Constructor for class io.github.sashirestela.openai.domain.chat.ChatRequest
ChatResponse - Class in io.github.sashirestela.openai.domain.chat
ChatResponse() - Constructor for class io.github.sashirestela.openai.domain.chat.ChatResponse
Choice - Class in io.github.sashirestela.openai.domain.chat
Choice - Class in io.github.sashirestela.openai.domain.completion
Choice() - Constructor for class io.github.sashirestela.openai.domain.chat.Choice
Choice() - Constructor for class io.github.sashirestela.openai.domain.completion.Choice
classToJsonSchema(Class<?>) - Static method in class io.github.sashirestela.openai.support.JsonSchemaUtil
CompletionRequest - Class in io.github.sashirestela.openai.domain.completion
CompletionRequest() - Constructor for class io.github.sashirestela.openai.domain.completion.CompletionRequest
CompletionResponse - Class in io.github.sashirestela.openai.domain.completion
CompletionResponse() - Constructor for class io.github.sashirestela.openai.domain.completion.CompletionResponse
completions() - Method in class io.github.sashirestela.openai.SimpleOpenAI: Generates an implementation of the Completions interface to handle requests.
create(ChatRequest) - Method in interface io.github.sashirestela.openai.OpenAI.ChatCompletions: Creates a model response for the given chat conversation.
create(CompletionRequest) - Method in interface io.github.sashirestela.openai.OpenAI.Completions: Creates a completion for the provided prompt and parameters.
create(EmbeddingRequest) - Method in interface io.github.sashirestela.openai.OpenAI.Embeddings: Creates an embedding vector representing the input text.
create(FileRequest) - Method in interface io.github.sashirestela.openai.OpenAI.Files: Upload a file that contains document(s) to be used across various endpoints/features.
create(FineTuningRequest) - Method in interface io.github.sashirestela.openai.OpenAI.FineTunings: Creates a job that fine-tunes a specified model from a given dataset.
create(ImageRequest) - Method in interface io.github.sashirestela.openai.OpenAI.Images: Creates an image given a prompt.
create(ModerationRequest) - Method in interface io.github.sashirestela.openai.OpenAI.Moderations: Classifies if text violates OpenAI's Content Policy.
createEdits(ImageEditsRequest) - Method in interface io.github.sashirestela.openai.OpenAI.Images: Creates an edited or extended image given an original image and a prompt.
createEditsWithOptions(ImageEditsRequest, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.Images
createStream(ChatRequest) - Method in interface io.github.sashirestela.openai.OpenAI.ChatCompletions: Creates a model response for the given chat conversation.
createStream(CompletionRequest) - Method in interface io.github.sashirestela.openai.OpenAI.Completions: Creates a completion for the provided prompt and parameters.
createStreamWithOptions(ChatRequest, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.ChatCompletions
createStreamWithOptions(CompletionRequest, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.Completions
createVariations(ImageVariationsRequest) - Method in interface io.github.sashirestela.openai.OpenAI.Images: Creates a variation of a given image.
createVariationsWithOptions(ImageVariationsRequest, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.Images
createWithOptions(ChatRequest, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.ChatCompletions
createWithOptions(CompletionRequest, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.Completions
createWithOptions(ImageRequest, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.Images

D

delete(String) - Method in interface io.github.sashirestela.openai.OpenAI.Files: Delete a file.
delete(String) - Method in interface io.github.sashirestela.openai.OpenAI.Models: Delete a fine tuned model.

E

Embedding - Class in io.github.sashirestela.openai.domain.embedding
Embedding() - Constructor for class io.github.sashirestela.openai.domain.embedding.Embedding
EmbeddingRequest - Class in io.github.sashirestela.openai.domain.embedding
EmbeddingRequest() - Constructor for class io.github.sashirestela.openai.domain.embedding.EmbeddingRequest
EmbeddingResponse - Class in io.github.sashirestela.openai.domain.embedding
EmbeddingResponse() - Constructor for class io.github.sashirestela.openai.domain.embedding.EmbeddingResponse
embeddings() - Method in class io.github.sashirestela.openai.SimpleOpenAI: Generates an implementation of the Embeddings interface to handle requests.
enrollFunction(ChatFunction) - Method in class io.github.sashirestela.openai.function.FunctionExecutor
enrollFunctions(List<ChatFunction>) - Method in class io.github.sashirestela.openai.function.FunctionExecutor
execute() - Method in interface io.github.sashirestela.openai.function.Functional
execute(ChatFunctionCall) - Method in class io.github.sashirestela.openai.function.FunctionExecutor

F

file - Variable in class io.github.sashirestela.openai.domain.audio.AudioTranslateRequest
FileRequest - Class in io.github.sashirestela.openai.domain.file
FileRequest() - Constructor for class io.github.sashirestela.openai.domain.file.FileRequest
FileResponse - Class in io.github.sashirestela.openai.domain.file
FileResponse() - Constructor for class io.github.sashirestela.openai.domain.file.FileResponse
files() - Method in class io.github.sashirestela.openai.SimpleOpenAI: Generates an implementation of the Files interface to handle requests.
FineTuningEvent - Class in io.github.sashirestela.openai.domain.finetuning
FineTuningEvent() - Constructor for class io.github.sashirestela.openai.domain.finetuning.FineTuningEvent
FineTuningRequest - Class in io.github.sashirestela.openai.domain.finetuning
FineTuningRequest() - Constructor for class io.github.sashirestela.openai.domain.finetuning.FineTuningRequest
FineTuningResponse - Class in io.github.sashirestela.openai.domain.finetuning
FineTuningResponse() - Constructor for class io.github.sashirestela.openai.domain.finetuning.FineTuningResponse
fineTunings() - Method in class io.github.sashirestela.openai.SimpleOpenAI: Generates an implementation of the FineTunings interface to handle requests.
firstContent() - Method in class io.github.sashirestela.openai.domain.chat.ChatResponse
firstMessage() - Method in class io.github.sashirestela.openai.domain.chat.ChatResponse
firstText() - Method in class io.github.sashirestela.openai.domain.completion.CompletionResponse
FUNCTION - io.github.sashirestela.openai.domain.chat.Role
Functional - Interface in io.github.sashirestela.openai.function
FunctionExecutor - Class in io.github.sashirestela.openai.function
FunctionExecutor() - Constructor for class io.github.sashirestela.openai.function.FunctionExecutor
FunctionExecutor(List<ChatFunction>) - Constructor for class io.github.sashirestela.openai.function.FunctionExecutor

G

getAudioResponseFormatOrDefault(AudioTranslateRequest, AudioRespFmt, String) - Static method in class io.github.sashirestela.openai.OpenAI.Options
getContent(String) - Method in interface io.github.sashirestela.openai.OpenAI.Files: Returns information about a specific file.
getEvents(String, Integer, String) - Method in interface io.github.sashirestela.openai.OpenAI.FineTunings: Get status updates for a fine-tuning job.
getEventsWithOptions(String, Integer, String, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.FineTunings
getFunctions() - Method in class io.github.sashirestela.openai.function.FunctionExecutor
getList() - Method in interface io.github.sashirestela.openai.OpenAI.Files: Returns a list of files that belong to the user's organization.
getList() - Method in interface io.github.sashirestela.openai.OpenAI.Models: Lists the currently available models, and provides basic information about each one such as the owner and availability.
getList(Integer, String) - Method in interface io.github.sashirestela.openai.OpenAI.FineTunings: List your organization's fine-tuning jobs.
getListWithOptions(Integer, String, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.FineTunings
getListWithOptions(Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.Files
getListWithOptions(Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.Models
getOne(String) - Method in interface io.github.sashirestela.openai.OpenAI.Files: Returns information about a specific file.
getOne(String) - Method in interface io.github.sashirestela.openai.OpenAI.FineTunings: Get info about a fine-tuning job.
getOne(String) - Method in interface io.github.sashirestela.openai.OpenAI.Models: Retrieves a model instance, providing basic information about the model such as the owner and permissioning.

H

HyperParams - Class in io.github.sashirestela.openai.domain.finetuning
HyperParams() - Constructor for class io.github.sashirestela.openai.domain.finetuning.HyperParams

I

ImageEditsRequest - Class in io.github.sashirestela.openai.domain.image
ImageEditsRequest() - Constructor for class io.github.sashirestela.openai.domain.image.ImageEditsRequest
ImageRequest - Class in io.github.sashirestela.openai.domain.image
ImageRequest() - Constructor for class io.github.sashirestela.openai.domain.image.ImageRequest
ImageRespFmt - Enum in io.github.sashirestela.openai.domain.image
ImageResponse - Class in io.github.sashirestela.openai.domain.image
ImageResponse() - Constructor for class io.github.sashirestela.openai.domain.image.ImageResponse
images() - Method in class io.github.sashirestela.openai.SimpleOpenAI: Generates an implementation of the Images interface to handle requests.
ImageVariationsRequest - Class in io.github.sashirestela.openai.domain.image
ImageVariationsRequest() - Constructor for class io.github.sashirestela.openai.domain.image.ImageVariationsRequest
io.github.sashirestela.openai - package io.github.sashirestela.openai
io.github.sashirestela.openai.domain - package io.github.sashirestela.openai.domain
io.github.sashirestela.openai.domain.audio - package io.github.sashirestela.openai.domain.audio
io.github.sashirestela.openai.domain.chat - package io.github.sashirestela.openai.domain.chat
io.github.sashirestela.openai.domain.completion - package io.github.sashirestela.openai.domain.completion
io.github.sashirestela.openai.domain.embedding - package io.github.sashirestela.openai.domain.embedding
io.github.sashirestela.openai.domain.file - package io.github.sashirestela.openai.domain.file
io.github.sashirestela.openai.domain.finetuning - package io.github.sashirestela.openai.domain.finetuning
io.github.sashirestela.openai.domain.image - package io.github.sashirestela.openai.domain.image
io.github.sashirestela.openai.domain.model - package io.github.sashirestela.openai.domain.model
io.github.sashirestela.openai.domain.moderation - package io.github.sashirestela.openai.domain.moderation
io.github.sashirestela.openai.function - package io.github.sashirestela.openai.function
io.github.sashirestela.openai.support - package io.github.sashirestela.openai.support

J

JSON - io.github.sashirestela.openai.domain.audio.AudioRespFmt
JsonSchemaUtil - Class in io.github.sashirestela.openai.support

M

model - Variable in class io.github.sashirestela.openai.domain.audio.AudioTranslateRequest
ModelResponse - Class in io.github.sashirestela.openai.domain.model
ModelResponse() - Constructor for class io.github.sashirestela.openai.domain.model.ModelResponse
models() - Method in class io.github.sashirestela.openai.SimpleOpenAI: Generates an implementation of the Models interface to handle requests.
Moderation - Class in io.github.sashirestela.openai.domain.moderation
Moderation() - Constructor for class io.github.sashirestela.openai.domain.moderation.Moderation
ModerationRequest - Class in io.github.sashirestela.openai.domain.moderation
ModerationRequest() - Constructor for class io.github.sashirestela.openai.domain.moderation.ModerationRequest
ModerationResponse - Class in io.github.sashirestela.openai.domain.moderation
ModerationResponse() - Constructor for class io.github.sashirestela.openai.domain.moderation.ModerationResponse
moderations() - Method in class io.github.sashirestela.openai.SimpleOpenAI: Generates an implementation of the Moderations interface to handle requests.

N

n - Variable in class io.github.sashirestela.openai.domain.image.AbstractImageRequest

O

OpenAI - Interface in io.github.sashirestela.openai: The OpenAI API can be applied to virtually any task that requires understanding or generating natural language and code.
OpenAI.Audios - Interface in io.github.sashirestela.openai: Turn audio into text (speech to text).
OpenAI.ChatCompletions - Interface in io.github.sashirestela.openai: Given a list of messages comprising a conversation, the model will return a response.
OpenAI.Completions - Interface in io.github.sashirestela.openai: Given a prompt, the model will return one or more predicted completions.
OpenAI.Embeddings - Interface in io.github.sashirestela.openai: Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
OpenAI.Files - Interface in io.github.sashirestela.openai: Files are used to upload documents that can be used with features like fine-tuning.
OpenAI.FineTunings - Interface in io.github.sashirestela.openai: Manage fine-tuning jobs to tailor a model to your specific training data.
OpenAI.Images - Interface in io.github.sashirestela.openai: Given a prompt and/or an input image, the model will generate a new image.
OpenAI.Models - Interface in io.github.sashirestela.openai: List and describe the various models available in the API.
OpenAI.Moderations - Interface in io.github.sashirestela.openai: Given a input text, outputs if the model classifies it as violating OpenAI's content policy.
OpenAI.Options - Class in io.github.sashirestela.openai
OpenAIDeletedResponse - Class in io.github.sashirestela.openai.domain
OpenAIDeletedResponse() - Constructor for class io.github.sashirestela.openai.domain.OpenAIDeletedResponse
OpenAIGeneric<T> - Class in io.github.sashirestela.openai.domain
OpenAIGeneric() - Constructor for class io.github.sashirestela.openai.domain.OpenAIGeneric
OpenAIUsage - Class in io.github.sashirestela.openai.domain
OpenAIUsage() - Constructor for class io.github.sashirestela.openai.domain.OpenAIUsage
Options() - Constructor for class io.github.sashirestela.openai.OpenAI.Options

P

ParametersSerializer - Class in io.github.sashirestela.openai.function
ParametersSerializer() - Constructor for class io.github.sashirestela.openai.function.ParametersSerializer
Permission - Class in io.github.sashirestela.openai.domain.model
Permission() - Constructor for class io.github.sashirestela.openai.domain.model.Permission
prompt - Variable in class io.github.sashirestela.openai.domain.audio.AudioTranslateRequest

R

responseFormat - Variable in class io.github.sashirestela.openai.domain.audio.AudioTranslateRequest
responseFormat - Variable in class io.github.sashirestela.openai.domain.image.AbstractImageRequest
Role - Enum in io.github.sashirestela.openai.domain.chat

S

Segment - Class in io.github.sashirestela.openai.domain.audio
Segment() - Constructor for class io.github.sashirestela.openai.domain.audio.Segment
serialize(Class<?>, JsonGenerator, SerializerProvider) - Method in class io.github.sashirestela.openai.function.ParametersSerializer
setCleverClient(CleverClient) - Method in class io.github.sashirestela.openai.SimpleOpenAI
SimpleOpenAI - Class in io.github.sashirestela.openai: The factory that generates implementations of the OpenAI interfaces.
SimpleOpenAI(String, String, String, HttpClient) - Constructor for class io.github.sashirestela.openai.SimpleOpenAI: Constructor used to generate a builder.
SimpleUncheckedException - Exception in io.github.sashirestela.openai
SimpleUncheckedException(String, Object...) - Constructor for exception io.github.sashirestela.openai.SimpleUncheckedException
size - Variable in class io.github.sashirestela.openai.domain.image.AbstractImageRequest
Size - Enum in io.github.sashirestela.openai.domain.image
SRT - io.github.sashirestela.openai.domain.audio.AudioRespFmt
SYSTEM - io.github.sashirestela.openai.domain.chat.Role

T

temperature - Variable in class io.github.sashirestela.openai.domain.audio.AudioTranslateRequest
TEXT - io.github.sashirestela.openai.domain.audio.AudioRespFmt
transcribe(AudioTranscribeRequest) - Method in interface io.github.sashirestela.openai.OpenAI.Audios: Transcribes audio into the input language.
transcribePlain(AudioTranscribeRequest) - Method in interface io.github.sashirestela.openai.OpenAI.Audios: Transcribes audio into the input language.
transcribePlainWithOptions(AudioTranscribeRequest, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.Audios
transcribeWithOptions(AudioTranscribeRequest, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.Audios
translate(AudioTranslateRequest) - Method in interface io.github.sashirestela.openai.OpenAI.Audios: Translates audio into English.
translatePlain(AudioTranslateRequest) - Method in interface io.github.sashirestela.openai.OpenAI.Audios: Translates audio into English.
translatePlainWithOptions(AudioTranslateRequest, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.Audios
translateWithOptions(AudioTranslateRequest, Map<String, ?>) - Method in interface io.github.sashirestela.openai.OpenAI.Audios

U

URL - io.github.sashirestela.openai.domain.image.ImageRespFmt
user - Variable in class io.github.sashirestela.openai.domain.image.AbstractImageRequest
USER - io.github.sashirestela.openai.domain.chat.Role

V

valueOf(String) - Static method in enum io.github.sashirestela.openai.domain.audio.AudioRespFmt: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.sashirestela.openai.domain.chat.Role: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.sashirestela.openai.domain.image.ImageRespFmt: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.sashirestela.openai.domain.image.Size: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.github.sashirestela.openai.domain.audio.AudioRespFmt: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.sashirestela.openai.domain.chat.Role: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.sashirestela.openai.domain.image.ImageRespFmt: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.sashirestela.openai.domain.image.Size: Returns an array containing the constants of this enum type, in the order they are declared.
VERBOSE_JSON - io.github.sashirestela.openai.domain.audio.AudioRespFmt
VTT - io.github.sashirestela.openai.domain.audio.AudioRespFmt

X

X1024 - io.github.sashirestela.openai.domain.image.Size
X256 - io.github.sashirestela.openai.domain.image.Size
X512 - io.github.sashirestela.openai.domain.image.Size

A B C D E F G H I J M N O P R S T U V X
All Classes All Packages