openai-client

com.aallam.openai.client

Assistants

Audio

Batch

Chat

Completions

Edits

Embeddings

Files

FineTunes

FineTuning

Images

LoggingConfig

Messages

Models

Moderations

OpenAI

OpenAI()

OpenAIConfig

OpenAIHost

Companion

ProxyConfig

Http

Socks

Responses

RetryStrategy

Runs

Threads

VectorStores

com.aallam.openai.client.extension

distance()

getData()

mergeToChatMessage()

similarity()

openai-core

com.aallam.openai.api

BetaOpenAI

ExperimentalOpenAI

InternalOpenAI

OpenAIDsl

com.aallam.openai.api.assistant

Assistant

AssistantId

AssistantRequest

assistantRequest()

AssistantRequestBuilder

AssistantResponseFormat

Companion

JsonSchema

ResponseFormatSerializer

AssistantTool

CodeInterpreter

FileSearch

FunctionTool

buildJsonObject()

CodeInterpreterResources

FileSearchResources

Function

function()

FunctionBuilder

ToolResources

com.aallam.openai.api.audio

AudioResponseFormat

Companion

Segment

SpeechRequest

speechRequest()

SpeechRequestBuilder

SpeechResponseFormat

Companion

TimestampGranularity

Companion

Transcription

TranscriptionRequest

transcriptionRequest()

TranscriptionRequestBuilder

Translation

TranslationRequest

translationRequest()

TranslationRequestBuilder

Voice

Companion

Word

com.aallam.openai.api.batch

Batch

BatchId

BatchRequest

batchRequest()

BatchRequestBuilder

CompletionWindow

Companion

CustomId

Method

Companion

RequestCounts

RequestInput

RequestOutput

ResponseOutput

com.aallam.openai.api.chat

ApproximateLocation

assistantMessage()

AssistantMessageBuilder

ChatAnnotation

ChatChoice

ChatChunk

ChatCompletion

ChatCompletionChunk

ChatCompletionFunction

chatCompletionFunction()

ChatCompletionFunctionBuilder

ChatCompletionRequest

chatCompletionRequest()

ChatCompletionRequestBuilder

ChatDelta

ChatMessage

Companion

chatMessage()

ChatMessageBuilder

ChatMessagesBuilder

ChatResponseFormat

Companion

ChatRole

Content

ContentFilterOffsets

ContentFilterResult

ContentFilterResults

ContentPart

ContentPartBuilder

Effort

function()

FunctionCall

FunctionMode

Companion

Default

Named

FunctionsBuilder

FunctionTool

FunctionToolCallBuilder

FunctionToolChoice

ImagePart

ImageURL

JsonSchema

ListContent

Logprobs

LogprobsContent

~~Parameters~~

SearchContextSize

Companion

StreamOptions

streamOptions()

StreamOptionsBuilder

systemMessage()

SystemMessageBuilder

TextContent

TextPart

Tool

Companion

ToolBuilder

ToolCall

Function

ToolCallChunk

ToolCallsBuilder

ToolChoice

Companion

Mode

Named

ToolId

toolMessage()

ToolMessageBuilder

ToolType

Companion

TopLogprob

UserLocation

userMessage()

UserMessageBuilder

WebSearchOptions

com.aallam.openai.api.completion

Choice

CompletionRequest

completionRequest()

CompletionRequestBuilder

Logprobs

TextCompletion

com.aallam.openai.api.edits

Edit

EditsRequest

editsRequest()

EditsRequestBuilder

com.aallam.openai.api.embedding

Embedding

EmbeddingRequest

embeddingRequest()

EmbeddingRequestBuilder

EmbeddingResponse

com.aallam.openai.api.exception

AuthenticationException

GenericIOException

InvalidRequestException

OpenAIAPIException

OpenAIError

OpenAIErrorDetails

OpenAIException

OpenAIHttpException

OpenAIIOException

OpenAIServerException

OpenAITimeoutException

PermissionException

RateLimitException

UnknownAPIException

com.aallam.openai.api.file

File

FileId

FileSource

fileSource()

FileSourceBuilder

FileStatus

FileUpload

fileUpload()

FileUploadBuilder

Purpose

com.aallam.openai.api.finetune

FineTune

FineTuneEvent

FineTuneId

FineTuneRequest

fineTuneRequest()

FineTuneRequestBuilder

HyperParams

com.aallam.openai.api.finetuning

ErrorInfo

FineTuningId

FineTuningJob

FineTuningJobEvent

FineTuningRequest

fineTuningRequest()

FineTuningRequestBuilder

Hyperparameters

NEpochs

Companion

Level

Companion

com.aallam.openai.api.http

Timeout

com.aallam.openai.api.image

ImageCreation

imageCreation()

ImageCreationBuilder

ImageEdit

imageEdit()

ImageEditBuilder

ImageJSON

ImageSize

Companion

ImageURL

ImageVariation

imageVariation()

ImageVariationBuilder

Quality

Companion

Style

Companion

com.aallam.openai.api.image.internal

ImageCreationRequest

ImageResponseFormat

Companion

com.aallam.openai.api.logging

Logger

Default

Simple

Empty

LogLevel

All

Headers

Body

Info

None

com.aallam.openai.api.message

Attachment

attachment()

AttachmentBuilder

FileCitation

FileCitationAnnotation

FilePath

FilePathAnnotation

ImageFile

Message

MessageContent

Image

Text

MessageId

MessageRequest

messageRequest()

MessageRequestBuilder

TextAnnotation

TextContent

com.aallam.openai.api.model

Model

ModelId

ModelPermission

com.aallam.openai.api.moderation

Categories

CategoryScores

ModerationModel

Companion

ModerationRequest

moderationRequest()

ModerationRequestBuilder

ModerationResult

TextModeration

com.aallam.openai.api.response

Response

ResponseId

ResponseInput

Serializer

ResponseInputItem

ResponseInputTokensDetails

ResponseOutputContent

ResponseOutputItem

ResponseOutputTokensDetails

ResponseReasoning

ResponseRequest

ResponseText

ResponseTool

ResponseUsage

com.aallam.openai.api.run

AssistantStreamEvent

AssistantStreamEventType

Companion

THREAD_CREATED

THREAD_RUN_CREATED

THREAD_RUN_QUEUED

THREAD_RUN_IN_PROGRESS

THREAD_RUN_REQUIRES_ACTION

THREAD_RUN_COMPLETED

THREAD_RUN_INCOMPLETE

THREAD_RUN_FAILED

THREAD_RUN_CANCELLING

THREAD_RUN_CANCELLED

THREAD_RUN_EXPIRED

THREAD_RUN_STEP_CREATED

THREAD_RUN_STEP_IN_PROGRESS

THREAD_RUN_STEP_DELTA

THREAD_RUN_STEP_COMPLETED

THREAD_RUN_STEP_FAILED

THREAD_RUN_STEP_CANCELLED

THREAD_RUN_STEP_EXPIRED

THREAD_MESSAGE_CREATED

THREAD_MESSAGE_IN_PROGRESS

THREAD_MESSAGE_DELTA

THREAD_MESSAGE_COMPLETED

THREAD_MESSAGE_INCOMPLETE

ERROR

DONE

UNKNOWN

AssistantStreamEventTypeSerializer

CodeInterpreterImage

CodeInterpreterToolCall

CodeInterpreterToolCallOutput

Image

Logs

FileSearchToolCallRankingOptions

FileSearchToolCallResult

FileSearchToolCallStep

FunctionToolCallStep

MessageCreation

MessageCreationStep

MessageCreationStepDetails

MessageDelta

MessageDeltaData

RequiredAction

SubmitToolOutputs

Run

RunId

RunRequest

runRequest()

RunRequestBuilder

RunStep

RunStepDelta

RunStepDeltaData

RunStepDetails

RunStepId

ThreadRunRequest

threadRunRequest()

ThreadRunRequestBuilder

ToolCallsStep

ToolCallStep

CodeInterpreter

FileSearchTool

FunctionTool

RetrievalTool

ToolCallStepDetails

ToolCallStepId

ToolOutput

toolOutput()

ToolOutputBuilder

ToolOutputs

com.aallam.openai.api.thread

Thread

ThreadId

ThreadMessage

threadMessage()

ThreadMessageBuilder

ThreadMessagesBuilder

ThreadRequest

threadRequest()

ThreadRequestBuilder

com.aallam.openai.api.vectorstore

ExpirationPolicy

FileBatchRequest

FileCounts

FilesBatch

VectorStore

VectorStoreFile

VectorStoreFileRequest

VectorStoreId

VectorStoreRequest