Index
All Classes and Interfaces|All Packages|Serialized Form
A
- additionalInstructions() - Method in record class io.github.stefanbratanov.jvm.openai.CreateRunRequest
-
Returns the value of the
additionalInstructions
record component. - additionalInstructions(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateRunRequest.Builder
- after() - Method in record class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters
-
Returns the value of the
after
record component. - after(String) - Method in class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters.Builder
- annotations() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text
-
Returns the value of the
annotations
record component. - arguments() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall.Function
-
Returns the value of the
arguments
record component. - Assistant - Record Class in io.github.stefanbratanov.jvm.openai
-
Represents an assistant that can call the model and use tools.
- Assistant(String, long, String, String, String, String, List<Tool>, List<String>, Map<String, String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.Assistant
-
Creates an instance of a
Assistant
record class. - AssistantFile - Record Class in io.github.stefanbratanov.jvm.openai
-
A list of Files attached to an assistant.
- AssistantFile(String, long, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.AssistantFile
-
Creates an instance of a
AssistantFile
record class. - assistantId() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantFile
-
Returns the value of the
assistantId
record component. - assistantId() - Method in record class io.github.stefanbratanov.jvm.openai.CreateRunRequest
-
Returns the value of the
assistantId
record component. - assistantId() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest
-
Returns the value of the
assistantId
record component. - assistantId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Returns the value of the
assistantId
record component. - assistantId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
assistantId
record component. - assistantId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
assistantId
record component. - assistantId(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateRunRequest.Builder
- assistantId(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest.Builder
- assistantMessage(String) - Static method in interface io.github.stefanbratanov.jvm.openai.ChatMessage
- assistantMessage(String, List<ToolCall>) - Static method in interface io.github.stefanbratanov.jvm.openai.ChatMessage
- AssistantMessage(String, Optional<String>, Optional<List<ToolCall>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatMessage.AssistantMessage
-
Creates an instance of a
AssistantMessage
record class. - assistantsClient() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI
- AssistantsClient - Class in io.github.stefanbratanov.jvm.openai
-
Build assistants that can call models and use tools to perform tasks.
- AssistantsClient.PaginatedAssistantFiles - Record Class in io.github.stefanbratanov.jvm.openai
- AssistantsClient.PaginatedAssistants - Record Class in io.github.stefanbratanov.jvm.openai
- audioClient() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI
- AudioClient - Class in io.github.stefanbratanov.jvm.openai
-
Turn audio into text or text into audio.
B
- b64Json() - Method in record class io.github.stefanbratanov.jvm.openai.Images.Image
-
Returns the value of the
b64Json
record component. - baseUrl(String) - Method in class io.github.stefanbratanov.jvm.openai.OpenAI.Builder
- batchSize() - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters
-
Returns the value of the
batchSize
record component. - batchSize(Integer) - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters.Builder
- batchSize(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters.Builder
- before() - Method in record class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters
-
Returns the value of the
before
record component. - before(String) - Method in class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.CreateImageRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.CreateMessageRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.CreateRunRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.EditImageRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.ModerationRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.ModifyMessageRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.ModifyRunRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.ModifyThreadRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.SpeechRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest.ToolOutput.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.TranscriptionRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.TranslationRequest.Builder
- build() - Method in class io.github.stefanbratanov.jvm.openai.UploadFileRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.CreateImageRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.CreateMessageRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.CreateRunRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.EditImageRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.ModerationRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.ModifyMessageRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.ModifyRunRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.ModifyThreadRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.SpeechRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest.ToolOutput.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.TranscriptionRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.TranslationRequest.Builder
- Builder() - Constructor for class io.github.stefanbratanov.jvm.openai.UploadFileRequest.Builder
- Builder(String) - Constructor for class io.github.stefanbratanov.jvm.openai.OpenAI.Builder
- bytes() - Method in record class io.github.stefanbratanov.jvm.openai.File
-
Returns the value of the
bytes
record component. - bytes() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.Content
-
Returns the value of the
bytes
record component. - bytes() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.TopLogprob
-
Returns the value of the
bytes
record component.
C
- cancelFineTuningJob(String) - Method in class io.github.stefanbratanov.jvm.openai.FineTuningClient
-
Immediately cancel a fine-tune job.
- cancelledAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
cancelledAt
record component. - cancelledAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
cancelledAt
record component. - cancelRun(String, String) - Method in class io.github.stefanbratanov.jvm.openai.RunsClient
-
Cancels a run that is in_progress.
- categories() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result
-
Returns the value of the
categories
record component. - Categories(boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Creates an instance of a
Categories
record class. - categoryScores() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result
-
Returns the value of the
categoryScores
record component. - CategoryScores(Double, Double, Double, Double, Double, Double, Double, Double, Double, Double, Double) - Constructor for record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Creates an instance of a
CategoryScores
record class. - chatClient() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI
- ChatClient - Class in io.github.stefanbratanov.jvm.openai
-
Given a list of messages comprising a conversation, the model will return a response.
- ChatCompletion - Record Class in io.github.stefanbratanov.jvm.openai
-
Represents a chat completion response returned by model, based on the provided input.
- ChatCompletion(String, long, String, String, List<ChatCompletion.Choice>, Usage) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatCompletion
-
Creates an instance of a
ChatCompletion
record class. - ChatCompletion.Choice - Record Class in io.github.stefanbratanov.jvm.openai
- ChatCompletion.Choice.Message - Record Class in io.github.stefanbratanov.jvm.openai
-
A chat completion message generated by the model.
- ChatCompletionChunk - Record Class in io.github.stefanbratanov.jvm.openai
-
Represents a streamed chunk of a chat completion response returned by model, based on the provided input.
- ChatCompletionChunk(String, List<ChatCompletionChunk.Choice>, long, String, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk
-
Creates an instance of a
ChatCompletionChunk
record class. - ChatCompletionChunk.Choice - Record Class in io.github.stefanbratanov.jvm.openai
- ChatCompletionChunk.Choice.Delta - Record Class in io.github.stefanbratanov.jvm.openai
-
A chat completion delta generated by streamed model responses.
- ChatMessage - Interface in io.github.stefanbratanov.jvm.openai
- ChatMessage.AssistantMessage - Record Class in io.github.stefanbratanov.jvm.openai
- ChatMessage.SystemMessage - Record Class in io.github.stefanbratanov.jvm.openai
- ChatMessage.ToolMessage - Record Class in io.github.stefanbratanov.jvm.openai
- ChatMessage.UserMessage<T> - Interface in io.github.stefanbratanov.jvm.openai
- ChatMessage.UserMessage.UserMessageWithContentParts - Record Class in io.github.stefanbratanov.jvm.openai
- ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart - Interface in io.github.stefanbratanov.jvm.openai
- ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart - Record Class in io.github.stefanbratanov.jvm.openai
- ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart.ImageUrl - Record Class in io.github.stefanbratanov.jvm.openai
- ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.TextContentPart - Record Class in io.github.stefanbratanov.jvm.openai
- ChatMessage.UserMessage.UserMessageWithTextContent - Record Class in io.github.stefanbratanov.jvm.openai
- Choice(int, ChatCompletion.Choice.Message, Logprobs, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice
-
Creates an instance of a
Choice
record class. - Choice(ChatCompletionChunk.Choice.Delta, int, Logprobs, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice
-
Creates an instance of a
Choice
record class. - choices() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion
-
Returns the value of the
choices
record component. - choices() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk
-
Returns the value of the
choices
record component. - code() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob.Error
-
Returns the value of the
code
record component. - code() - Method in record class io.github.stefanbratanov.jvm.openai.OpenAIException.Error
-
Returns the value of the
code
record component. - code() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.LastError
-
Returns the value of the
code
record component. - code() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.LastError
-
Returns the value of the
code
record component. - codeInterpreter() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall
-
Returns the value of the
codeInterpreter
record component. - CodeInterpreter(String, List<ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter
-
Creates an instance of a
CodeInterpreter
record class. - codeInterpreterTool() - Static method in interface io.github.stefanbratanov.jvm.openai.Tool
- CodeInterpreterTool() - Constructor for record class io.github.stefanbratanov.jvm.openai.Tool.CodeInterpreterTool
-
Creates an instance of a
CodeInterpreterTool
record class. - codeInterpreterToolCall(String, ToolCall.CodeInterpreterToolCall.CodeInterpreter) - Static method in interface io.github.stefanbratanov.jvm.openai.ToolCall
- CodeInterpreterToolCall(String, ToolCall.CodeInterpreterToolCall.CodeInterpreter) - Constructor for record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall
-
Creates an instance of a
CodeInterpreterToolCall
record class. - completedAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
completedAt
record component. - completedAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
completedAt
record component. - completionTokens() - Method in record class io.github.stefanbratanov.jvm.openai.Usage
-
Returns the value of the
completionTokens
record component. - content() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice.Message
-
Returns the value of the
content
record component. - content() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice.Delta
-
Returns the value of the
content
record component. - content() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.AssistantMessage
-
Returns the value of the
content
record component. - content() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.SystemMessage
-
Returns the value of the
content
record component. - content() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.ToolMessage
-
Returns the value of the
content
record component. - content() - Method in interface io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage
- content() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts
-
Returns the value of the
content
record component. - content() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithTextContent
-
Returns the value of the
content
record component. - content() - Method in record class io.github.stefanbratanov.jvm.openai.CreateMessageRequest
-
Returns the value of the
content
record component. - content() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message
-
Returns the value of the
content
record component. - content() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs
-
Returns the value of the
content
record component. - content() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Returns the value of the
content
record component. - content(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateMessageRequest.Builder
- content(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message.Builder
- Content(String, double, List<Byte>, List<Logprobs.TopLogprob>) - Constructor for record class io.github.stefanbratanov.jvm.openai.Logprobs.Content
-
Creates an instance of a
Content
record class. - createAssistant(CreateAssistantRequest) - Method in class io.github.stefanbratanov.jvm.openai.AssistantsClient
-
Create an assistant with a model and instructions.
- createAssistantFile(String, String) - Method in class io.github.stefanbratanov.jvm.openai.AssistantsClient
-
Create an assistant file by attaching a File to an assistant.
- CreateAssistantRequest - Record Class in io.github.stefanbratanov.jvm.openai
- CreateAssistantRequest(String, Optional<String>, Optional<String>, Optional<String>, Optional<List<Tool>>, Optional<List<String>>, Optional<Map<String, String>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest
-
Creates an instance of a
CreateAssistantRequest
record class. - CreateAssistantRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- createChatCompletion(CreateChatCompletionRequest) - Method in class io.github.stefanbratanov.jvm.openai.ChatClient
-
Creates a model response for the given chat conversation.
- createChatCompletionAsync(CreateChatCompletionRequest) - Method in class io.github.stefanbratanov.jvm.openai.ChatClient
-
Same as
ChatClient.createChatCompletion(CreateChatCompletionRequest)
but returns a response in aCompletableFuture
- CreateChatCompletionRequest - Record Class in io.github.stefanbratanov.jvm.openai
- CreateChatCompletionRequest(String, List<ChatMessage>, Optional<Double>, Optional<String>, Optional<Map<Integer, Integer>>, Optional<Boolean>, Optional<Integer>, Optional<Integer>, Optional<Integer>, Optional<Double>, Optional<CreateChatCompletionRequest.ResponseFormat>, Optional<Integer>, Optional<List<String>>, Optional<Boolean>, Optional<Double>, Optional<Double>, Optional<List<Tool>>, Optional<Object>, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Creates an instance of a
CreateChatCompletionRequest
record class. - CreateChatCompletionRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- CreateChatCompletionRequest.ResponseFormat - Record Class in io.github.stefanbratanov.jvm.openai
- created() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion
-
Returns the value of the
created
record component. - created() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk
-
Returns the value of the
created
record component. - created() - Method in record class io.github.stefanbratanov.jvm.openai.Images
-
Returns the value of the
created
record component. - created() - Method in record class io.github.stefanbratanov.jvm.openai.Model
-
Returns the value of the
created
record component. - createdAt() - Method in record class io.github.stefanbratanov.jvm.openai.Assistant
-
Returns the value of the
createdAt
record component. - createdAt() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantFile
-
Returns the value of the
createdAt
record component. - createdAt() - Method in record class io.github.stefanbratanov.jvm.openai.File
-
Returns the value of the
createdAt
record component. - createdAt() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
createdAt
record component. - createdAt() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJobEvent
-
Returns the value of the
createdAt
record component. - createdAt() - Method in record class io.github.stefanbratanov.jvm.openai.Thread
-
Returns the value of the
createdAt
record component. - createdAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Returns the value of the
createdAt
record component. - createdAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessageFile
-
Returns the value of the
createdAt
record component. - createdAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
createdAt
record component. - createdAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
createdAt
record component. - createEmbeddings(EmbeddingsRequest) - Method in class io.github.stefanbratanov.jvm.openai.EmbeddingsClient
-
Creates an embedding vector representing the input text.
- createFineTuningJob(CreateFineTuningJobRequest) - Method in class io.github.stefanbratanov.jvm.openai.FineTuningClient
-
Creates a fine-tuning job which begins the process of creating a new model from a given dataset.
- CreateFineTuningJobRequest - Record Class in io.github.stefanbratanov.jvm.openai
- CreateFineTuningJobRequest(String, String, Optional<CreateFineTuningJobRequest.Hyperparameters>, Optional<String>, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest
-
Creates an instance of a
CreateFineTuningJobRequest
record class. - CreateFineTuningJobRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- CreateFineTuningJobRequest.Hyperparameters - Record Class in io.github.stefanbratanov.jvm.openai
- CreateFineTuningJobRequest.Hyperparameters.Builder - Class in io.github.stefanbratanov.jvm.openai
- createImage(CreateImageRequest) - Method in class io.github.stefanbratanov.jvm.openai.ImagesClient
-
Creates an image given a prompt.
- createImageAsync(CreateImageRequest) - Method in class io.github.stefanbratanov.jvm.openai.ImagesClient
-
Same as
ImagesClient.createImage(CreateImageRequest)
but returns a response in aCompletableFuture
- CreateImageRequest - Record Class in io.github.stefanbratanov.jvm.openai
- CreateImageRequest(String, Optional<String>, Optional<Integer>, Optional<String>, Optional<String>, Optional<String>, Optional<String>, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
-
Creates an instance of a
CreateImageRequest
record class. - CreateImageRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- createImageVariation(CreateImageVariationRequest) - Method in class io.github.stefanbratanov.jvm.openai.ImagesClient
-
Creates a variation of a given image.
- createImageVariationAsync(CreateImageVariationRequest) - Method in class io.github.stefanbratanov.jvm.openai.ImagesClient
-
Same as
ImagesClient.createImageVariation(CreateImageVariationRequest)
but returns a response in aCompletableFuture
- CreateImageVariationRequest - Record Class in io.github.stefanbratanov.jvm.openai
- CreateImageVariationRequest(Path, Optional<String>, Optional<Integer>, Optional<String>, Optional<String>, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest
-
Creates an instance of a
CreateImageVariationRequest
record class. - CreateImageVariationRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- createMessage(String, CreateMessageRequest) - Method in class io.github.stefanbratanov.jvm.openai.MessagesClient
-
Create a message.
- CreateMessageRequest - Record Class in io.github.stefanbratanov.jvm.openai
- CreateMessageRequest(String, String, Optional<List<String>>, Optional<Map<String, String>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.CreateMessageRequest
-
Creates an instance of a
CreateMessageRequest
record class. - CreateMessageRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- createModeration(ModerationRequest) - Method in class io.github.stefanbratanov.jvm.openai.ModerationsClient
-
Classifies if text violates OpenAI's Content Policy
- createRun(String, CreateRunRequest) - Method in class io.github.stefanbratanov.jvm.openai.RunsClient
-
Create a run.
- CreateRunRequest - Record Class in io.github.stefanbratanov.jvm.openai
- CreateRunRequest(String, Optional<String>, Optional<String>, Optional<String>, Optional<List<Tool>>, Optional<Map<String, String>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.CreateRunRequest
-
Creates an instance of a
CreateRunRequest
record class. - CreateRunRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- createSpeech(SpeechRequest, Path) - Method in class io.github.stefanbratanov.jvm.openai.AudioClient
-
Generates audio from the input text.
- createSpeechAsync(SpeechRequest, Path) - Method in class io.github.stefanbratanov.jvm.openai.AudioClient
-
Same as
AudioClient.createSpeech(SpeechRequest,Path)
but returns a response in aCompletableFuture
- createThread(CreateThreadRequest) - Method in class io.github.stefanbratanov.jvm.openai.ThreadsClient
-
Create a thread.
- createThreadAndRun(CreateThreadAndRunRequest) - Method in class io.github.stefanbratanov.jvm.openai.RunsClient
-
Create a thread and run it in one request.
- CreateThreadAndRunRequest - Record Class in io.github.stefanbratanov.jvm.openai
- CreateThreadAndRunRequest(String, Optional<CreateThreadRequest>, Optional<String>, Optional<String>, Optional<List<Tool>>, Optional<Map<String, String>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest
-
Creates an instance of a
CreateThreadAndRunRequest
record class. - CreateThreadAndRunRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- CreateThreadRequest - Record Class in io.github.stefanbratanov.jvm.openai
- CreateThreadRequest(Optional<List<CreateThreadRequest.Message>>, Optional<Map<String, String>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest
-
Creates an instance of a
CreateThreadRequest
record class. - CreateThreadRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- CreateThreadRequest.Message - Record Class in io.github.stefanbratanov.jvm.openai
- CreateThreadRequest.Message.Builder - Class in io.github.stefanbratanov.jvm.openai
- createTranscript(TranscriptionRequest) - Method in class io.github.stefanbratanov.jvm.openai.AudioClient
-
Transcribes audio into the input language.
- createTranscriptAsync(TranscriptionRequest) - Method in class io.github.stefanbratanov.jvm.openai.AudioClient
-
Same as
AudioClient.createTranscript(TranscriptionRequest)
but returns a response in aCompletableFuture
- createTranslation(TranslationRequest) - Method in class io.github.stefanbratanov.jvm.openai.AudioClient
-
Translates audio into English.
- createTranslationAsync(TranslationRequest) - Method in class io.github.stefanbratanov.jvm.openai.AudioClient
-
Same as
AudioClient.createTranslation(TranslationRequest)
but returns a response in aCompletableFuture
D
- data() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistantFiles
-
Returns the value of the
data
record component. - data() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistants
-
Returns the value of the
data
record component. - data() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings
-
Returns the value of the
data
record component. - data() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningEvents
-
Returns the value of the
data
record component. - data() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningJobs
-
Returns the value of the
data
record component. - data() - Method in record class io.github.stefanbratanov.jvm.openai.Images
-
Returns the value of the
data
record component. - data() - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessageFiles
-
Returns the value of the
data
record component. - data() - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessages
-
Returns the value of the
data
record component. - data() - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRuns
-
Returns the value of the
data
record component. - data() - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRunSteps
-
Returns the value of the
data
record component. - deleteAssistant(String) - Method in class io.github.stefanbratanov.jvm.openai.AssistantsClient
-
Delete an assistant.
- deleteAssistantFile(String, String) - Method in class io.github.stefanbratanov.jvm.openai.AssistantsClient
-
Delete an assistant file.
- deleted() - Method in record class io.github.stefanbratanov.jvm.openai.DeletionStatus
-
Returns the value of the
deleted
record component. - deleteFile(String) - Method in class io.github.stefanbratanov.jvm.openai.FilesClient
-
Delete a file
- deleteModel(String) - Method in class io.github.stefanbratanov.jvm.openai.ModelsClient
-
Delete a fine-tuned model.
- deleteThread(String) - Method in class io.github.stefanbratanov.jvm.openai.ThreadsClient
-
Delete a thread.
- DeletionStatus - Record Class in io.github.stefanbratanov.jvm.openai
- DeletionStatus(String, boolean) - Constructor for record class io.github.stefanbratanov.jvm.openai.DeletionStatus
-
Creates an instance of a
DeletionStatus
record class. - delta() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice
-
Returns the value of the
delta
record component. - Delta(String, String, List<ToolCall>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice.Delta
-
Creates an instance of a
Delta
record class. - description() - Method in record class io.github.stefanbratanov.jvm.openai.Assistant
-
Returns the value of the
description
record component. - description() - Method in record class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest
-
Returns the value of the
description
record component. - description() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest
-
Returns the value of the
description
record component. - description() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function
-
Returns the value of the
description
record component. - description(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest.Builder
- description(String) - Method in class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest.Builder
- description(String) - Method in class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function.Builder
- detail() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart.ImageUrl
-
Returns the value of the
detail
record component. - dimensions() - Method in record class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest
-
Returns the value of the
dimensions
record component. - dimensions(int) - Method in class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest.Builder
E
- editImage(EditImageRequest) - Method in class io.github.stefanbratanov.jvm.openai.ImagesClient
-
Creates an edited or extended image given an original image and a prompt.
- editImageAsync(EditImageRequest) - Method in class io.github.stefanbratanov.jvm.openai.ImagesClient
-
Same as
ImagesClient.editImage(EditImageRequest)
but returns a response in aCompletableFuture
- EditImageRequest - Record Class in io.github.stefanbratanov.jvm.openai
- EditImageRequest(Path, String, Optional<Path>, Optional<String>, Optional<Integer>, Optional<String>, Optional<String>, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.EditImageRequest
-
Creates an instance of a
EditImageRequest
record class. - EditImageRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- embedding() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings.Embedding
-
Returns the value of the
embedding
record component. - Embedding(int, List<Double>) - Constructor for record class io.github.stefanbratanov.jvm.openai.Embeddings.Embedding
-
Creates an instance of a
Embedding
record class. - Embeddings - Record Class in io.github.stefanbratanov.jvm.openai
- Embeddings(List<Embeddings.Embedding>, String, Embeddings.Usage) - Constructor for record class io.github.stefanbratanov.jvm.openai.Embeddings
-
Creates an instance of a
Embeddings
record class. - Embeddings.Embedding - Record Class in io.github.stefanbratanov.jvm.openai
-
Represents an embedding vector returned by embedding endpoint.
- Embeddings.Usage - Record Class in io.github.stefanbratanov.jvm.openai
- embeddingsClient() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI
- EmbeddingsClient - Class in io.github.stefanbratanov.jvm.openai
-
Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
- EmbeddingsRequest - Record Class in io.github.stefanbratanov.jvm.openai
- EmbeddingsRequest(List<Object>, String, Optional<String>, Optional<Integer>, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest
-
Creates an instance of a
EmbeddingsRequest
record class. - EmbeddingsRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- encodingFormat() - Method in record class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest
-
Returns the value of the
encodingFormat
record component. - encodingFormat(String) - Method in class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest.Builder
- endIndex() - Method in interface io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation
- endIndex() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation
-
Returns the value of the
endIndex
record component. - endIndex() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation
-
Returns the value of the
endIndex
record component. - equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Assistant
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.AssistantFile
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistantFiles
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistants
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice.Message
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice.Delta
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.AssistantMessage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.SystemMessage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.ToolMessage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart.ImageUrl
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.TextContentPart
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithTextContent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.ResponseFormat
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.CreateMessageRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.CreateRunRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.DeletionStatus
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.EditImageRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings.Embedding
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings.Usage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.File
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningEvents
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningJobs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob.Error
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob.Hyperparameters
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJobEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Images
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Images.Image
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.Content
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.TopLogprob
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessageFiles
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessages
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Model
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Moderation
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ModerationRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ModifyMessageRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ModifyRunRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ModifyThreadRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.OpenAIException.Error
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRuns
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRunSteps
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.SpeechRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest.ToolOutput
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Thread
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.ImageFileContent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.ImageFileContent.ImageFile
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation.FilePath
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessageFile
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.LastError
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.RequiredAction
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.RequiredAction.SubmitToolOutputs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.LastError
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.MessageCreationStepDetails
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.MessageCreationStepDetails.MessageCreation
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.ToolCallsStepDetails
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Tool.CodeInterpreterTool
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Tool.RetrievalTool
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput.Image
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.LogOutput
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall.Function
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.RetrievalToolCall
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ToolChoice
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.ToolChoice.Function
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.TranscriptionRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.TranslationRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.UploadFileRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.stefanbratanov.jvm.openai.Usage
-
Indicates whether some other object is "equal to" this one.
- error() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
error
record component. - error() - Method in exception io.github.stefanbratanov.jvm.openai.OpenAIException
- Error(String, String, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.FineTuningJob.Error
-
Creates an instance of a
Error
record class. - Error(String, String, String, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.OpenAIException.Error
-
Creates an instance of a
Error
record class. - errorMessage() - Method in exception io.github.stefanbratanov.jvm.openai.OpenAIException
- expiredAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
expiredAt
record component. - expiresAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
expiresAt
record component.
F
- failedAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
failedAt
record component. - failedAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
failedAt
record component. - file() - Method in record class io.github.stefanbratanov.jvm.openai.TranscriptionRequest
-
Returns the value of the
file
record component. - file() - Method in record class io.github.stefanbratanov.jvm.openai.TranslationRequest
-
Returns the value of the
file
record component. - file() - Method in record class io.github.stefanbratanov.jvm.openai.UploadFileRequest
-
Returns the value of the
file
record component. - file(Path) - Method in class io.github.stefanbratanov.jvm.openai.TranscriptionRequest.Builder
- file(Path) - Method in class io.github.stefanbratanov.jvm.openai.TranslationRequest.Builder
- file(Path) - Method in class io.github.stefanbratanov.jvm.openai.UploadFileRequest.Builder
- File - Record Class in io.github.stefanbratanov.jvm.openai
- File(String, int, long, String, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.File
-
Creates an instance of a
File
record class. - fileCitation() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation
-
Returns the value of the
fileCitation
record component. - FileCitation(String, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation
-
Creates an instance of a
FileCitation
record class. - FileCitationAnnotation(String, ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation, int, int) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation
-
Creates an instance of a
FileCitationAnnotation
record class. - fileId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.ImageFileContent.ImageFile
-
Returns the value of the
fileId
record component. - fileId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation
-
Returns the value of the
fileId
record component. - fileId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation.FilePath
-
Returns the value of the
fileId
record component. - fileId() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput.Image
-
Returns the value of the
fileId
record component. - fileIds() - Method in record class io.github.stefanbratanov.jvm.openai.Assistant
-
Returns the value of the
fileIds
record component. - fileIds() - Method in record class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest
-
Returns the value of the
fileIds
record component. - fileIds() - Method in record class io.github.stefanbratanov.jvm.openai.CreateMessageRequest
-
Returns the value of the
fileIds
record component. - fileIds() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message
-
Returns the value of the
fileIds
record component. - fileIds() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest
-
Returns the value of the
fileIds
record component. - fileIds() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Returns the value of the
fileIds
record component. - fileIds() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
fileIds
record component. - fileIds(List<String>) - Method in class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest.Builder
- fileIds(List<String>) - Method in class io.github.stefanbratanov.jvm.openai.CreateMessageRequest.Builder
- fileIds(List<String>) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message.Builder
- fileIds(List<String>) - Method in class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest.Builder
- filename() - Method in record class io.github.stefanbratanov.jvm.openai.File
-
Returns the value of the
filename
record component. - filePath() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation
-
Returns the value of the
filePath
record component. - FilePath(String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation.FilePath
-
Creates an instance of a
FilePath
record class. - FilePathAnnotation(String, ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation.FilePath, int, int) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation
-
Creates an instance of a
FilePathAnnotation
record class. - filesClient() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI
- FilesClient - Class in io.github.stefanbratanov.jvm.openai
-
Files are used to upload documents that can be used with features like Assistants and Fine-tuning.
- fineTunedModel() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
fineTunedModel
record component. - fineTuningClient() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI
- FineTuningClient - Class in io.github.stefanbratanov.jvm.openai
-
Manage fine-tuning jobs to tailor a model to your specific training data.
- FineTuningClient.PaginatedFineTuningEvents - Record Class in io.github.stefanbratanov.jvm.openai
- FineTuningClient.PaginatedFineTuningJobs - Record Class in io.github.stefanbratanov.jvm.openai
- FineTuningJob - Record Class in io.github.stefanbratanov.jvm.openai
-
The fine_tuning.job object represents a fine-tuning job that has been created through the API.
- FineTuningJob(String, long, FineTuningJob.Error, String, Long, FineTuningJob.Hyperparameters, String, String, List<String>, String, Integer, String, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Creates an instance of a
FineTuningJob
record class. - FineTuningJob.Error - Record Class in io.github.stefanbratanov.jvm.openai
- FineTuningJob.Hyperparameters - Record Class in io.github.stefanbratanov.jvm.openai
-
The hyperparameters used for the fine-tuning job
- FineTuningJobEvent - Record Class in io.github.stefanbratanov.jvm.openai
- FineTuningJobEvent(String, long, String, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.FineTuningJobEvent
-
Creates an instance of a
FineTuningJobEvent
record class. - finishedAt() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
finishedAt
record component. - finishReason() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice
-
Returns the value of the
finishReason
record component. - finishReason() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice
-
Returns the value of the
finishReason
record component. - firstId() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistantFiles
-
Returns the value of the
firstId
record component. - firstId() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistants
-
Returns the value of the
firstId
record component. - firstId() - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessageFiles
-
Returns the value of the
firstId
record component. - firstId() - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessages
-
Returns the value of the
firstId
record component. - firstId() - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRuns
-
Returns the value of the
firstId
record component. - firstId() - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRunSteps
-
Returns the value of the
firstId
record component. - flagged() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result
-
Returns the value of the
flagged
record component. - frequencyPenalty() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
frequencyPenalty
record component. - frequencyPenalty(double) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- function() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool
-
Returns the value of the
function
record component. - function() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall
-
Returns the value of the
function
record component. - function() - Method in record class io.github.stefanbratanov.jvm.openai.ToolChoice
-
Returns the value of the
function
record component. - Function(String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ToolChoice.Function
-
Creates an instance of a
Function
record class. - Function(String, String, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall.Function
-
Creates an instance of a
Function
record class. - Function(String, Optional<String>, Optional<Map<String, Object>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function
-
Creates an instance of a
Function
record class. - functionTool(Tool.FunctionTool.Function) - Static method in interface io.github.stefanbratanov.jvm.openai.Tool
- FunctionTool(Tool.FunctionTool.Function) - Constructor for record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool
-
Creates an instance of a
FunctionTool
record class. - functionToolCall(String, ToolCall.FunctionToolCall.Function) - Static method in interface io.github.stefanbratanov.jvm.openai.ToolCall
- FunctionToolCall(String, ToolCall.FunctionToolCall.Function) - Constructor for record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall
-
Creates an instance of a
FunctionToolCall
record class. - functionToolChoice(ToolChoice.Function) - Static method in record class io.github.stefanbratanov.jvm.openai.ToolChoice
G
- getLastEventId() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningEvents
- getLastJobId() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningJobs
H
- harassment() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns the value of the
harassment
record component. - harassment() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns the value of the
harassment
record component. - harassmentThreatening() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns the value of the
harassmentThreatening
record component. - harassmentThreatening() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns the value of the
harassmentThreatening
record component. - hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Assistant
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantFile
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistantFiles
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistants
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice.Message
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice.Delta
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.AssistantMessage
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.SystemMessage
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.ToolMessage
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart.ImageUrl
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.TextContentPart
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithTextContent
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.ResponseFormat
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.CreateMessageRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.CreateRunRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.DeletionStatus
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.EditImageRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings.Embedding
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings.Usage
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.File
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningEvents
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningJobs
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob.Error
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob.Hyperparameters
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJobEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Images
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Images.Image
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.Content
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.TopLogprob
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessageFiles
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessages
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Model
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ModerationRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyMessageRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyRunRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyThreadRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.OpenAIException.Error
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRuns
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRunSteps
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.SpeechRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest.ToolOutput
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Thread
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.ImageFileContent
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.ImageFileContent.ImageFile
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation.FilePath
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessageFile
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.LastError
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.RequiredAction
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.RequiredAction.SubmitToolOutputs
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.LastError
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.MessageCreationStepDetails
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.MessageCreationStepDetails.MessageCreation
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.ToolCallsStepDetails
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.CodeInterpreterTool
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.RetrievalTool
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput.Image
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.LogOutput
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall.Function
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.RetrievalToolCall
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ToolChoice.Function
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.ToolChoice
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.TranscriptionRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.TranslationRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.UploadFileRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.stefanbratanov.jvm.openai.Usage
-
Returns a hash code value for this object.
- hasMore() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistantFiles
-
Returns the value of the
hasMore
record component. - hasMore() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistants
-
Returns the value of the
hasMore
record component. - hasMore() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningEvents
-
Returns the value of the
hasMore
record component. - hasMore() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningJobs
-
Returns the value of the
hasMore
record component. - hasMore() - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessageFiles
-
Returns the value of the
hasMore
record component. - hasMore() - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessages
-
Returns the value of the
hasMore
record component. - hasMore() - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRuns
-
Returns the value of the
hasMore
record component. - hasMore() - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRunSteps
-
Returns the value of the
hasMore
record component. - hate() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns the value of the
hate
record component. - hate() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns the value of the
hate
record component. - hateThreatening() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns the value of the
hateThreatening
record component. - hateThreatening() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns the value of the
hateThreatening
record component. - httpClient - Variable in class io.github.stefanbratanov.jvm.openai.AudioClient
- httpClient(HttpClient) - Method in class io.github.stefanbratanov.jvm.openai.OpenAI.Builder
- hyperparameters() - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest
-
Returns the value of the
hyperparameters
record component. - hyperparameters() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
hyperparameters
record component. - hyperparameters(CreateFineTuningJobRequest.Hyperparameters) - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Builder
- Hyperparameters(Object) - Constructor for record class io.github.stefanbratanov.jvm.openai.FineTuningJob.Hyperparameters
-
Creates an instance of a
Hyperparameters
record class. - Hyperparameters(Optional<Object>, Optional<Object>, Optional<Object>) - Constructor for record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters
-
Creates an instance of a
Hyperparameters
record class.
I
- id() - Method in record class io.github.stefanbratanov.jvm.openai.Assistant
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantFile
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.DeletionStatus
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.File
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJobEvent
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.Model
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.Thread
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessageFile
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall
-
Returns the value of the
id
record component. - id() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall
-
Returns the value of the
id
record component. - id() - Method in interface io.github.stefanbratanov.jvm.openai.ToolCall
- id() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.RetrievalToolCall
-
Returns the value of the
id
record component. - image() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest
-
Returns the value of the
image
record component. - image() - Method in record class io.github.stefanbratanov.jvm.openai.EditImageRequest
-
Returns the value of the
image
record component. - image() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput
-
Returns the value of the
image
record component. - image(Path) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest.Builder
- image(Path) - Method in class io.github.stefanbratanov.jvm.openai.EditImageRequest.Builder
- Image(String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput.Image
-
Creates an instance of a
Image
record class. - Image(String, String, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.Images.Image
-
Creates an instance of a
Image
record class. - imageContentPart(String) - Static method in interface io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart
- imageContentPart(String, String) - Static method in interface io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart
- ImageContentPart(ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart.ImageUrl) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart
-
Creates an instance of a
ImageContentPart
record class. - imageFile() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.ImageFileContent
-
Returns the value of the
imageFile
record component. - ImageFile(String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.ImageFileContent.ImageFile
-
Creates an instance of a
ImageFile
record class. - ImageFileContent(ThreadMessage.Content.ImageFileContent.ImageFile) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.ImageFileContent
-
Creates an instance of a
ImageFileContent
record class. - imageOutput(ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput.Image) - Static method in interface io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output
- ImageOutput(ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput.Image) - Constructor for record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput
-
Creates an instance of a
ImageOutput
record class. - Images - Record Class in io.github.stefanbratanov.jvm.openai
- Images(long, List<Images.Image>) - Constructor for record class io.github.stefanbratanov.jvm.openai.Images
-
Creates an instance of a
Images
record class. - Images.Image - Record Class in io.github.stefanbratanov.jvm.openai
- imagesClient() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI
- ImagesClient - Class in io.github.stefanbratanov.jvm.openai
-
Given a prompt and/or an input image, the model will generate a new image.
- imageUrl() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart
-
Returns the value of the
imageUrl
record component. - ImageUrl(String, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart.ImageUrl
-
Creates an instance of a
ImageUrl
record class. - index() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice
-
Returns the value of the
index
record component. - index() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice
-
Returns the value of the
index
record component. - index() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings.Embedding
-
Returns the value of the
index
record component. - input() - Method in record class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest
-
Returns the value of the
input
record component. - input() - Method in record class io.github.stefanbratanov.jvm.openai.ModerationRequest
-
Returns the value of the
input
record component. - input() - Method in record class io.github.stefanbratanov.jvm.openai.SpeechRequest
-
Returns the value of the
input
record component. - input() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter
-
Returns the value of the
input
record component. - input(int[]) - Method in class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest.Builder
- input(String) - Method in class io.github.stefanbratanov.jvm.openai.ModerationRequest.Builder
- input(String) - Method in class io.github.stefanbratanov.jvm.openai.SpeechRequest.Builder
- input(String...) - Method in class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest.Builder
- input(List<int[]>) - Method in class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest.Builder
- inputs(List<String>) - Method in class io.github.stefanbratanov.jvm.openai.ModerationRequest.Builder
- instanceId() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
instanceId
record component. - instanceId(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- instructions() - Method in record class io.github.stefanbratanov.jvm.openai.Assistant
-
Returns the value of the
instructions
record component. - instructions() - Method in record class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest
-
Returns the value of the
instructions
record component. - instructions() - Method in record class io.github.stefanbratanov.jvm.openai.CreateRunRequest
-
Returns the value of the
instructions
record component. - instructions() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest
-
Returns the value of the
instructions
record component. - instructions() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest
-
Returns the value of the
instructions
record component. - instructions() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
instructions
record component. - instructions(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest.Builder
- instructions(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateRunRequest.Builder
- instructions(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest.Builder
- instructions(String) - Method in class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest.Builder
- io.github.stefanbratanov.jvm.openai - package io.github.stefanbratanov.jvm.openai
J
- json() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.ResponseFormat
L
- language() - Method in record class io.github.stefanbratanov.jvm.openai.TranscriptionRequest
-
Returns the value of the
language
record component. - language(String) - Method in class io.github.stefanbratanov.jvm.openai.TranscriptionRequest.Builder
- lastError() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
lastError
record component. - lastError() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
lastError
record component. - LastError(String, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadRun.LastError
-
Creates an instance of a
LastError
record class. - LastError(String, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.LastError
-
Creates an instance of a
LastError
record class. - lastId() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistantFiles
-
Returns the value of the
lastId
record component. - lastId() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistants
-
Returns the value of the
lastId
record component. - lastId() - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessageFiles
-
Returns the value of the
lastId
record component. - lastId() - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessages
-
Returns the value of the
lastId
record component. - lastId() - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRuns
-
Returns the value of the
lastId
record component. - lastId() - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRunSteps
-
Returns the value of the
lastId
record component. - learningRateMultiplier() - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters
-
Returns the value of the
learningRateMultiplier
record component. - learningRateMultiplier(Integer) - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters.Builder
- learningRateMultiplier(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters.Builder
- level() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJobEvent
-
Returns the value of the
level
record component. - limit() - Method in record class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters
-
Returns the value of the
limit
record component. - limit(int) - Method in class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters.Builder
- listAssistantFiles(String, PaginationQueryParameters) - Method in class io.github.stefanbratanov.jvm.openai.AssistantsClient
-
Returns a list of assistant files.
- listAssistants(PaginationQueryParameters) - Method in class io.github.stefanbratanov.jvm.openai.AssistantsClient
-
Returns a list of assistants.
- listFiles() - Method in class io.github.stefanbratanov.jvm.openai.FilesClient
-
Returns a list of files that belong to the user's organization
- listFineTuningJobEvents(String, Optional<Integer>, Optional<String>) - Method in class io.github.stefanbratanov.jvm.openai.FineTuningClient
-
Get status updates for a fine-tuning job.
- listFineTuningJobs(Optional<Integer>, Optional<String>) - Method in class io.github.stefanbratanov.jvm.openai.FineTuningClient
-
List your organization's fine-tuning jobs
- listMessageFiles(String, String, PaginationQueryParameters) - Method in class io.github.stefanbratanov.jvm.openai.MessagesClient
-
Returns a list of message files.
- listMessages(String, PaginationQueryParameters) - Method in class io.github.stefanbratanov.jvm.openai.MessagesClient
-
Returns a list of messages for a given thread.
- listModels() - Method in class io.github.stefanbratanov.jvm.openai.ModelsClient
-
Lists the currently available models, and provides basic information about each one such as the owner and availability.
- listRuns(String, PaginationQueryParameters) - Method in class io.github.stefanbratanov.jvm.openai.RunsClient
-
Returns a list of runs belonging to a thread.
- listRunSteps(String, String, PaginationQueryParameters) - Method in class io.github.stefanbratanov.jvm.openai.RunsClient
-
Returns a list of run steps belonging to a run.
- logitBias() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
logitBias
record component. - logitBias(Map<Integer, Integer>) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- logOutput(String) - Static method in interface io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output
- LogOutput(String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.LogOutput
-
Creates an instance of a
LogOutput
record class. - logprob() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.Content
-
Returns the value of the
logprob
record component. - logprob() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.TopLogprob
-
Returns the value of the
logprob
record component. - logprobs() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice
-
Returns the value of the
logprobs
record component. - logprobs() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice
-
Returns the value of the
logprobs
record component. - logprobs() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
logprobs
record component. - logprobs(boolean) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- Logprobs - Record Class in io.github.stefanbratanov.jvm.openai
-
Log probability information
- Logprobs(List<Logprobs.Content>) - Constructor for record class io.github.stefanbratanov.jvm.openai.Logprobs
-
Creates an instance of a
Logprobs
record class. - Logprobs.Content - Record Class in io.github.stefanbratanov.jvm.openai
- Logprobs.TopLogprob - Record Class in io.github.stefanbratanov.jvm.openai
- logs() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.LogOutput
-
Returns the value of the
logs
record component.
M
- mask() - Method in record class io.github.stefanbratanov.jvm.openai.EditImageRequest
-
Returns the value of the
mask
record component. - mask(Path) - Method in class io.github.stefanbratanov.jvm.openai.EditImageRequest.Builder
- maxTokens() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
maxTokens
record component. - maxTokens(int) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- message() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice
-
Returns the value of the
message
record component. - message() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob.Error
-
Returns the value of the
message
record component. - message() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJobEvent
-
Returns the value of the
message
record component. - message() - Method in record class io.github.stefanbratanov.jvm.openai.OpenAIException.Error
-
Returns the value of the
message
record component. - message() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.LastError
-
Returns the value of the
message
record component. - message() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.LastError
-
Returns the value of the
message
record component. - message(ChatMessage) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- message(CreateThreadRequest.Message) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Builder
- Message(String, String, Optional<List<String>>, Optional<Map<String, String>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message
-
Creates an instance of a
Message
record class. - Message(String, List<ToolCall>, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice.Message
-
Creates an instance of a
Message
record class. - messageCreation() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.MessageCreationStepDetails
-
Returns the value of the
messageCreation
record component. - MessageCreation(String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.MessageCreationStepDetails.MessageCreation
-
Creates an instance of a
MessageCreation
record class. - MessageCreationStepDetails(ThreadRunStep.StepDetails.MessageCreationStepDetails.MessageCreation) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.MessageCreationStepDetails
-
Creates an instance of a
MessageCreationStepDetails
record class. - messageId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessageFile
-
Returns the value of the
messageId
record component. - messageId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.MessageCreationStepDetails.MessageCreation
-
Returns the value of the
messageId
record component. - messages() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
messages
record component. - messages() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest
-
Returns the value of the
messages
record component. - messages(List<ChatMessage>) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- messages(List<CreateThreadRequest.Message>) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Builder
- messagesClient() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI
- MessagesClient - Class in io.github.stefanbratanov.jvm.openai
-
Create messages within threads
- MessagesClient.PaginatedThreadMessageFiles - Record Class in io.github.stefanbratanov.jvm.openai
- MessagesClient.PaginatedThreadMessages - Record Class in io.github.stefanbratanov.jvm.openai
- metadata() - Method in record class io.github.stefanbratanov.jvm.openai.Assistant
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.CreateMessageRequest
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.CreateRunRequest
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyMessageRequest
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyRunRequest
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyThreadRequest
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.Thread
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
metadata
record component. - metadata() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
metadata
record component. - metadata(Map<String, String>) - Method in class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest.Builder
- metadata(Map<String, String>) - Method in class io.github.stefanbratanov.jvm.openai.CreateMessageRequest.Builder
- metadata(Map<String, String>) - Method in class io.github.stefanbratanov.jvm.openai.CreateRunRequest.Builder
- metadata(Map<String, String>) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest.Builder
- metadata(Map<String, String>) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Builder
- metadata(Map<String, String>) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message.Builder
- metadata(Map<String, String>) - Method in class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest.Builder
- metadata(Map<String, String>) - Method in class io.github.stefanbratanov.jvm.openai.ModifyMessageRequest.Builder
- metadata(Map<String, String>) - Method in class io.github.stefanbratanov.jvm.openai.ModifyRunRequest.Builder
- metadata(Map<String, String>) - Method in class io.github.stefanbratanov.jvm.openai.ModifyThreadRequest.Builder
- model() - Method in record class io.github.stefanbratanov.jvm.openai.Assistant
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.CreateRunRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.EditImageRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.ModerationRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.SpeechRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.TranscriptionRequest
-
Returns the value of the
model
record component. - model() - Method in record class io.github.stefanbratanov.jvm.openai.TranslationRequest
-
Returns the value of the
model
record component. - model(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateRunRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.EditImageRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.ModerationRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.SpeechRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.TranscriptionRequest.Builder
- model(String) - Method in class io.github.stefanbratanov.jvm.openai.TranslationRequest.Builder
- Model - Record Class in io.github.stefanbratanov.jvm.openai
- Model(String, long, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.Model
-
Creates an instance of a
Model
record class. - modelsClient() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI
- ModelsClient - Class in io.github.stefanbratanov.jvm.openai
-
List and describe the various models available in the API.
- Moderation - Record Class in io.github.stefanbratanov.jvm.openai
-
Represents policy compliance report by OpenAI's content moderation model against a given input.
- Moderation(String, String, List<Moderation.Result>) - Constructor for record class io.github.stefanbratanov.jvm.openai.Moderation
-
Creates an instance of a
Moderation
record class. - Moderation.Result - Record Class in io.github.stefanbratanov.jvm.openai
- Moderation.Result.Categories - Record Class in io.github.stefanbratanov.jvm.openai
- Moderation.Result.CategoryScores - Record Class in io.github.stefanbratanov.jvm.openai
- ModerationRequest - Record Class in io.github.stefanbratanov.jvm.openai
- ModerationRequest(List<String>, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ModerationRequest
-
Creates an instance of a
ModerationRequest
record class. - ModerationRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- moderationsClient() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI
- ModerationsClient - Class in io.github.stefanbratanov.jvm.openai
-
Given a input text, outputs if the model classifies it as violating OpenAI's content policy.
- modifyAssistant(String, ModifyAssistantRequest) - Method in class io.github.stefanbratanov.jvm.openai.AssistantsClient
-
Modifies an assistant.
- ModifyAssistantRequest - Record Class in io.github.stefanbratanov.jvm.openai
- ModifyAssistantRequest(Optional<String>, Optional<String>, Optional<String>, Optional<String>, Optional<List<Tool>>, Optional<List<String>>, Optional<Map<String, String>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest
-
Creates an instance of a
ModifyAssistantRequest
record class. - ModifyAssistantRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- modifyMessage(String, String, ModifyMessageRequest) - Method in class io.github.stefanbratanov.jvm.openai.MessagesClient
-
Modifies a message.
- ModifyMessageRequest - Record Class in io.github.stefanbratanov.jvm.openai
- ModifyMessageRequest(Optional<Map<String, String>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ModifyMessageRequest
-
Creates an instance of a
ModifyMessageRequest
record class. - ModifyMessageRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- modifyRun(String, String, ModifyRunRequest) - Method in class io.github.stefanbratanov.jvm.openai.RunsClient
-
Modifies a run.
- ModifyRunRequest - Record Class in io.github.stefanbratanov.jvm.openai
- ModifyRunRequest(Optional<Map<String, String>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ModifyRunRequest
-
Creates an instance of a
ModifyRunRequest
record class. - ModifyRunRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- modifyThread(String, ModifyThreadRequest) - Method in class io.github.stefanbratanov.jvm.openai.ThreadsClient
-
Modifies a thread.
- ModifyThreadRequest - Record Class in io.github.stefanbratanov.jvm.openai
- ModifyThreadRequest(Optional<Map<String, String>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ModifyThreadRequest
-
Creates an instance of a
ModifyThreadRequest
record class. - ModifyThreadRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
N
- n() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
n
record component. - n() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
-
Returns the value of the
n
record component. - n() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest
-
Returns the value of the
n
record component. - n() - Method in record class io.github.stefanbratanov.jvm.openai.EditImageRequest
-
Returns the value of the
n
record component. - n(int) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- n(int) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageRequest.Builder
- n(int) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest.Builder
- n(int) - Method in class io.github.stefanbratanov.jvm.openai.EditImageRequest.Builder
- name() - Method in record class io.github.stefanbratanov.jvm.openai.Assistant
-
Returns the value of the
name
record component. - name() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.AssistantMessage
-
Returns the value of the
name
record component. - name() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.SystemMessage
-
Returns the value of the
name
record component. - name() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts
-
Returns the value of the
name
record component. - name() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithTextContent
-
Returns the value of the
name
record component. - name() - Method in record class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest
-
Returns the value of the
name
record component. - name() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest
-
Returns the value of the
name
record component. - name() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function
-
Returns the value of the
name
record component. - name() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall.Function
-
Returns the value of the
name
record component. - name() - Method in record class io.github.stefanbratanov.jvm.openai.ToolChoice.Function
-
Returns the value of the
name
record component. - name(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest.Builder
- name(String) - Method in class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest.Builder
- name(String) - Method in class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function.Builder
- nEpochs() - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters
-
Returns the value of the
nEpochs
record component. - nEpochs() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob.Hyperparameters
-
Returns the value of the
nEpochs
record component. - nEpochs(Integer) - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters.Builder
- nEpochs(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters.Builder
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateMessageRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateRunRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.EditImageRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.ModerationRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.ModifyMessageRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.ModifyRunRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.ModifyThreadRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.SpeechRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest.ToolOutput
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.TranscriptionRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.TranslationRequest
- newBuilder() - Static method in record class io.github.stefanbratanov.jvm.openai.UploadFileRequest
- newBuilder(String) - Static method in class io.github.stefanbratanov.jvm.openai.OpenAI
- none() - Static method in record class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters
O
- objectMapper - Variable in class io.github.stefanbratanov.jvm.openai.AudioClient
- onChunk(ChatCompletionChunk) - Method in interface io.github.stefanbratanov.jvm.openai.StreamChatCompletionSubscriber
-
Will be called when a partial response is received
- onComplete() - Method in interface io.github.stefanbratanov.jvm.openai.StreamChatCompletionSubscriber
-
Will be called when the stream is complete
- OpenAI - Class in io.github.stefanbratanov.jvm.openai
-
A class which when created using the
OpenAI.newBuilder(String)
can be used to create clients based on the endpoints defined at API Reference - OpenAI API - OpenAI.Builder - Class in io.github.stefanbratanov.jvm.openai
- OpenAIException - Exception in io.github.stefanbratanov.jvm.openai
-
Exceptions will be based on Error Codes - OpenAI API
- OpenAIException.Error - Record Class in io.github.stefanbratanov.jvm.openai
- order() - Method in record class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters
-
Returns the value of the
order
record component. - order(String) - Method in class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters.Builder
- organization(String) - Method in class io.github.stefanbratanov.jvm.openai.OpenAI.Builder
- organizationId() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
organizationId
record component. - output() - Method in record class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest.ToolOutput
-
Returns the value of the
output
record component. - output() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall.Function
-
Returns the value of the
output
record component. - output(String) - Method in class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest.ToolOutput.Builder
- outputs() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter
-
Returns the value of the
outputs
record component. - ownedBy() - Method in record class io.github.stefanbratanov.jvm.openai.Model
-
Returns the value of the
ownedBy
record component.
P
- PaginatedAssistantFiles(List<AssistantFile>, String, String, boolean) - Constructor for record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistantFiles
-
Creates an instance of a
PaginatedAssistantFiles
record class. - PaginatedAssistants(List<Assistant>, String, String, boolean) - Constructor for record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistants
-
Creates an instance of a
PaginatedAssistants
record class. - PaginatedFineTuningEvents(List<FineTuningJobEvent>, boolean) - Constructor for record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningEvents
-
Creates an instance of a
PaginatedFineTuningEvents
record class. - PaginatedFineTuningJobs(List<FineTuningJob>, boolean) - Constructor for record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningJobs
-
Creates an instance of a
PaginatedFineTuningJobs
record class. - PaginatedThreadMessageFiles(List<ThreadMessageFile>, String, String, boolean) - Constructor for record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessageFiles
-
Creates an instance of a
PaginatedThreadMessageFiles
record class. - PaginatedThreadMessages(List<ThreadMessage>, String, String, boolean) - Constructor for record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessages
-
Creates an instance of a
PaginatedThreadMessages
record class. - PaginatedThreadRuns(List<ThreadRun>, String, String, boolean) - Constructor for record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRuns
-
Creates an instance of a
PaginatedThreadRuns
record class. - PaginatedThreadRunSteps(List<ThreadRunStep>, String, String, boolean) - Constructor for record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRunSteps
-
Creates an instance of a
PaginatedThreadRunSteps
record class. - PaginationQueryParameters - Record Class in io.github.stefanbratanov.jvm.openai
- PaginationQueryParameters(Optional<Integer>, Optional<String>, Optional<String>, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters
-
Creates an instance of a
PaginationQueryParameters
record class. - PaginationQueryParameters.Builder - Class in io.github.stefanbratanov.jvm.openai
- param() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob.Error
-
Returns the value of the
param
record component. - param() - Method in record class io.github.stefanbratanov.jvm.openai.OpenAIException.Error
-
Returns the value of the
param
record component. - parameters() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function
-
Returns the value of the
parameters
record component. - parameters(Map<String, Object>) - Method in class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function.Builder
- presencePenalty() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
presencePenalty
record component. - presencePenalty(double) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- prompt() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
-
Returns the value of the
prompt
record component. - prompt() - Method in record class io.github.stefanbratanov.jvm.openai.EditImageRequest
-
Returns the value of the
prompt
record component. - prompt() - Method in record class io.github.stefanbratanov.jvm.openai.TranscriptionRequest
-
Returns the value of the
prompt
record component. - prompt() - Method in record class io.github.stefanbratanov.jvm.openai.TranslationRequest
-
Returns the value of the
prompt
record component. - prompt(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageRequest.Builder
- prompt(String) - Method in class io.github.stefanbratanov.jvm.openai.EditImageRequest.Builder
- prompt(String) - Method in class io.github.stefanbratanov.jvm.openai.TranscriptionRequest.Builder
- prompt(String) - Method in class io.github.stefanbratanov.jvm.openai.TranslationRequest.Builder
- promptTokens() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings.Usage
-
Returns the value of the
promptTokens
record component. - promptTokens() - Method in record class io.github.stefanbratanov.jvm.openai.Usage
-
Returns the value of the
promptTokens
record component. - purpose() - Method in record class io.github.stefanbratanov.jvm.openai.File
-
Returns the value of the
purpose
record component. - purpose() - Method in record class io.github.stefanbratanov.jvm.openai.UploadFileRequest
-
Returns the value of the
purpose
record component. - purpose(String) - Method in class io.github.stefanbratanov.jvm.openai.UploadFileRequest.Builder
Q
- quality() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
-
Returns the value of the
quality
record component. - quality(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageRequest.Builder
- quote() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation
-
Returns the value of the
quote
record component.
R
- requiredAction() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
requiredAction
record component. - RequiredAction(String, ThreadRun.RequiredAction.SubmitToolOutputs) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadRun.RequiredAction
-
Creates an instance of a
RequiredAction
record class. - responseFormat() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
responseFormat
record component. - responseFormat() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
-
Returns the value of the
responseFormat
record component. - responseFormat() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest
-
Returns the value of the
responseFormat
record component. - responseFormat() - Method in record class io.github.stefanbratanov.jvm.openai.EditImageRequest
-
Returns the value of the
responseFormat
record component. - responseFormat() - Method in record class io.github.stefanbratanov.jvm.openai.SpeechRequest
-
Returns the value of the
responseFormat
record component. - responseFormat() - Method in record class io.github.stefanbratanov.jvm.openai.TranscriptionRequest
-
Returns the value of the
responseFormat
record component. - responseFormat() - Method in record class io.github.stefanbratanov.jvm.openai.TranslationRequest
-
Returns the value of the
responseFormat
record component. - responseFormat(CreateChatCompletionRequest.ResponseFormat) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
-
Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message.
- responseFormat(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageRequest.Builder
- responseFormat(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest.Builder
- responseFormat(String) - Method in class io.github.stefanbratanov.jvm.openai.EditImageRequest.Builder
- responseFormat(String) - Method in class io.github.stefanbratanov.jvm.openai.SpeechRequest.Builder
- responseFormat(String) - Method in class io.github.stefanbratanov.jvm.openai.TranscriptionRequest.Builder
- responseFormat(String) - Method in class io.github.stefanbratanov.jvm.openai.TranslationRequest.Builder
- ResponseFormat(String) - Constructor for record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.ResponseFormat
-
Creates an instance of a
ResponseFormat
record class. - Result(boolean, Moderation.Result.Categories, Moderation.Result.CategoryScores) - Constructor for record class io.github.stefanbratanov.jvm.openai.Moderation.Result
-
Creates an instance of a
Result
record class. - resultFiles() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
resultFiles
record component. - results() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation
-
Returns the value of the
results
record component. - retrieval() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.RetrievalToolCall
-
Returns the value of the
retrieval
record component. - retrievalTool() - Static method in interface io.github.stefanbratanov.jvm.openai.Tool
- RetrievalTool() - Constructor for record class io.github.stefanbratanov.jvm.openai.Tool.RetrievalTool
-
Creates an instance of a
RetrievalTool
record class. - retrievalToolCall(String) - Static method in interface io.github.stefanbratanov.jvm.openai.ToolCall
- RetrievalToolCall(String, Map<String, Object>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ToolCall.RetrievalToolCall
-
Creates an instance of a
RetrievalToolCall
record class. - retrieveAssistant(String) - Method in class io.github.stefanbratanov.jvm.openai.AssistantsClient
-
Retrieves an assistant.
- retrieveAssistantFile(String, String) - Method in class io.github.stefanbratanov.jvm.openai.AssistantsClient
-
Retrieves an AssistantFile.
- retrieveFile(String) - Method in class io.github.stefanbratanov.jvm.openai.FilesClient
-
Returns information about a specific file
- retrieveFileContent(String) - Method in class io.github.stefanbratanov.jvm.openai.FilesClient
-
Returns the contents of the specified file
- retrieveFineTuningJob(String) - Method in class io.github.stefanbratanov.jvm.openai.FineTuningClient
-
Get info about a fine-tuning job.
- retrieveMessage(String, String) - Method in class io.github.stefanbratanov.jvm.openai.MessagesClient
-
Retrieve a message.
- retrieveMessageFile(String, String, String) - Method in class io.github.stefanbratanov.jvm.openai.MessagesClient
-
Retrieves a message file.
- retrieveModel(String) - Method in class io.github.stefanbratanov.jvm.openai.ModelsClient
-
Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
- retrieveRun(String, String) - Method in class io.github.stefanbratanov.jvm.openai.RunsClient
-
Retrieves a run.
- retrieveRunStep(String, String, String) - Method in class io.github.stefanbratanov.jvm.openai.RunsClient
-
Retrieves a run step.
- retrieveThread(String) - Method in class io.github.stefanbratanov.jvm.openai.ThreadsClient
-
Retrieves a thread.
- revisedPrompt() - Method in record class io.github.stefanbratanov.jvm.openai.Images.Image
-
Returns the value of the
revisedPrompt
record component. - role() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice.Message
-
Returns the value of the
role
record component. - role() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice.Delta
-
Returns the value of the
role
record component. - role() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.AssistantMessage
- role() - Method in interface io.github.stefanbratanov.jvm.openai.ChatMessage
- role() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.SystemMessage
- role() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.ToolMessage
- role() - Method in interface io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage
- role() - Method in record class io.github.stefanbratanov.jvm.openai.CreateMessageRequest
-
Returns the value of the
role
record component. - role() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message
-
Returns the value of the
role
record component. - role() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Returns the value of the
role
record component. - role(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateMessageRequest.Builder
- role(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message.Builder
- runId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Returns the value of the
runId
record component. - runId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
runId
record component. - runsClient() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI
- RunsClient - Class in io.github.stefanbratanov.jvm.openai
-
Represents an execution run on a thread.
- RunsClient.PaginatedThreadRuns - Record Class in io.github.stefanbratanov.jvm.openai
- RunsClient.PaginatedThreadRunSteps - Record Class in io.github.stefanbratanov.jvm.openai
S
- seed() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
seed
record component. - seed(int) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- selfHarm() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns the value of the
selfHarm
record component. - selfHarm() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns the value of the
selfHarm
record component. - selfHarmInstructions() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns the value of the
selfHarmInstructions
record component. - selfHarmInstructions() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns the value of the
selfHarmInstructions
record component. - selfHarmIntent() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns the value of the
selfHarmIntent
record component. - selfHarmIntent() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns the value of the
selfHarmIntent
record component. - sexual() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns the value of the
sexual
record component. - sexual() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns the value of the
sexual
record component. - sexualMinors() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns the value of the
sexualMinors
record component. - sexualMinors() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns the value of the
sexualMinors
record component. - size() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
-
Returns the value of the
size
record component. - size() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest
-
Returns the value of the
size
record component. - size() - Method in record class io.github.stefanbratanov.jvm.openai.EditImageRequest
-
Returns the value of the
size
record component. - size(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageRequest.Builder
- size(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest.Builder
- size(String) - Method in class io.github.stefanbratanov.jvm.openai.EditImageRequest.Builder
- SpeechRequest - Record Class in io.github.stefanbratanov.jvm.openai
- SpeechRequest(String, String, String, Optional<String>, Optional<Double>) - Constructor for record class io.github.stefanbratanov.jvm.openai.SpeechRequest
-
Creates an instance of a
SpeechRequest
record class. - SpeechRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- speed() - Method in record class io.github.stefanbratanov.jvm.openai.SpeechRequest
-
Returns the value of the
speed
record component. - speed(double) - Method in class io.github.stefanbratanov.jvm.openai.SpeechRequest.Builder
- startedAt() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
startedAt
record component. - startIndex() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation
-
Returns the value of the
startIndex
record component. - startIndex() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation
-
Returns the value of the
startIndex
record component. - startIndex() - Method in interface io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation
- status() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
status
record component. - status() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
status
record component. - status() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
status
record component. - statusCode() - Method in exception io.github.stefanbratanov.jvm.openai.OpenAIException
- stepDetails() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
stepDetails
record component. - stop() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
stop
record component. - stop(String...) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- stream() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
stream
record component. - stream(boolean) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- streamChatCompletion(CreateChatCompletionRequest) - Method in class io.github.stefanbratanov.jvm.openai.ChatClient
-
Stream model responses back in order to allow partial results for the given request.
- streamChatCompletion(CreateChatCompletionRequest, StreamChatCompletionSubscriber) - Method in class io.github.stefanbratanov.jvm.openai.ChatClient
-
Same as
ChatClient.streamChatCompletion(CreateChatCompletionRequest)
but can pass aStreamChatCompletionSubscriber
implementation instead of using aStream<ChatCompletionChunk>
- StreamChatCompletionSubscriber - Interface in io.github.stefanbratanov.jvm.openai
-
An interface which is used to subscribe to streamed partial responses
- style() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
-
Returns the value of the
style
record component. - style(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageRequest.Builder
- submitToolOutputs() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.RequiredAction
-
Returns the value of the
submitToolOutputs
record component. - submitToolOutputs(String, String, SubmitToolOutputsRequest) - Method in class io.github.stefanbratanov.jvm.openai.RunsClient
-
When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed.
- SubmitToolOutputs(List<ToolCall>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadRun.RequiredAction.SubmitToolOutputs
-
Creates an instance of a
SubmitToolOutputs
record class. - SubmitToolOutputsRequest - Record Class in io.github.stefanbratanov.jvm.openai
- SubmitToolOutputsRequest(List<SubmitToolOutputsRequest.ToolOutput>) - Constructor for record class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest
-
Creates an instance of a
SubmitToolOutputsRequest
record class. - SubmitToolOutputsRequest.ToolOutput - Record Class in io.github.stefanbratanov.jvm.openai
- SubmitToolOutputsRequest.ToolOutput.Builder - Class in io.github.stefanbratanov.jvm.openai
- submitToolOutputsRequiredAction(ThreadRun.RequiredAction.SubmitToolOutputs) - Static method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.RequiredAction
- suffix() - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest
-
Returns the value of the
suffix
record component. - suffix(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Builder
- systemFingerprint() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion
-
Returns the value of the
systemFingerprint
record component. - systemFingerprint() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk
-
Returns the value of the
systemFingerprint
record component. - systemMessage(String) - Static method in interface io.github.stefanbratanov.jvm.openai.ChatMessage
- SystemMessage(String, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatMessage.SystemMessage
-
Creates an instance of a
SystemMessage
record class.
T
- temperature() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
temperature
record component. - temperature() - Method in record class io.github.stefanbratanov.jvm.openai.TranscriptionRequest
-
Returns the value of the
temperature
record component. - temperature() - Method in record class io.github.stefanbratanov.jvm.openai.TranslationRequest
-
Returns the value of the
temperature
record component. - temperature(double) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- temperature(double) - Method in class io.github.stefanbratanov.jvm.openai.TranscriptionRequest.Builder
- temperature(double) - Method in class io.github.stefanbratanov.jvm.openai.TranslationRequest.Builder
- text() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.TextContentPart
-
Returns the value of the
text
record component. - text() - Static method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.ResponseFormat
- text() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent
-
Returns the value of the
text
record component. - text() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation
-
Returns the value of the
text
record component. - text() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation
-
Returns the value of the
text
record component. - text() - Method in interface io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation
- Text(String, List<ThreadMessage.Content.TextContent.Text.Annotation>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text
-
Creates an instance of a
Text
record class. - TextContent(ThreadMessage.Content.TextContent.Text) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent
-
Creates an instance of a
TextContent
record class. - textContentPart(String) - Static method in interface io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart
- TextContentPart(String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.TextContentPart
-
Creates an instance of a
TextContentPart
record class. - thread() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest
-
Returns the value of the
thread
record component. - thread(CreateThreadRequest) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest.Builder
- Thread - Record Class in io.github.stefanbratanov.jvm.openai
-
A Thread represents a conversation.
- Thread(String, long, Map<String, String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.Thread
-
Creates an instance of a
Thread
record class. - threadId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Returns the value of the
threadId
record component. - threadId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
threadId
record component. - threadId() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
threadId
record component. - ThreadMessage - Record Class in io.github.stefanbratanov.jvm.openai
-
Represents a message within a thread.
- ThreadMessage(String, long, String, String, List<ThreadMessage.Content>, String, String, List<String>, Map<String, String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Creates an instance of a
ThreadMessage
record class. - ThreadMessage.Content - Interface in io.github.stefanbratanov.jvm.openai
- ThreadMessage.Content.ImageFileContent - Record Class in io.github.stefanbratanov.jvm.openai
- ThreadMessage.Content.ImageFileContent.ImageFile - Record Class in io.github.stefanbratanov.jvm.openai
- ThreadMessage.Content.TextContent - Record Class in io.github.stefanbratanov.jvm.openai
- ThreadMessage.Content.TextContent.Text - Record Class in io.github.stefanbratanov.jvm.openai
- ThreadMessage.Content.TextContent.Text.Annotation - Interface in io.github.stefanbratanov.jvm.openai
- ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation - Record Class in io.github.stefanbratanov.jvm.openai
- ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation - Record Class in io.github.stefanbratanov.jvm.openai
- ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation - Record Class in io.github.stefanbratanov.jvm.openai
- ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation.FilePath - Record Class in io.github.stefanbratanov.jvm.openai
- ThreadMessageFile - Record Class in io.github.stefanbratanov.jvm.openai
-
A list of files attached to a message.
- ThreadMessageFile(String, long, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadMessageFile
-
Creates an instance of a
ThreadMessageFile
record class. - ThreadRun - Record Class in io.github.stefanbratanov.jvm.openai
-
Represents an execution run on a thread.
- ThreadRun(String, long, String, String, String, ThreadRun.RequiredAction, ThreadRun.LastError, long, Long, Long, Long, Long, String, String, List<Tool>, List<String>, Map<String, String>, Usage) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Creates an instance of a
ThreadRun
record class. - ThreadRun.LastError - Record Class in io.github.stefanbratanov.jvm.openai
-
The last error associated with this run.
- ThreadRun.RequiredAction - Record Class in io.github.stefanbratanov.jvm.openai
-
Details on the action required to continue the run.
- ThreadRun.RequiredAction.SubmitToolOutputs - Record Class in io.github.stefanbratanov.jvm.openai
- ThreadRunStep - Record Class in io.github.stefanbratanov.jvm.openai
-
Represents a step in execution of a run.
- ThreadRunStep(String, long, String, String, String, String, String, ThreadRunStep.StepDetails, ThreadRunStep.LastError, Long, Long, Long, Long, Map<String, String>, Usage) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Creates an instance of a
ThreadRunStep
record class. - ThreadRunStep.LastError - Record Class in io.github.stefanbratanov.jvm.openai
-
The last error associated with this run step.
- ThreadRunStep.StepDetails - Interface in io.github.stefanbratanov.jvm.openai
-
The details of the run step.
- ThreadRunStep.StepDetails.MessageCreationStepDetails - Record Class in io.github.stefanbratanov.jvm.openai
- ThreadRunStep.StepDetails.MessageCreationStepDetails.MessageCreation - Record Class in io.github.stefanbratanov.jvm.openai
- ThreadRunStep.StepDetails.ToolCallsStepDetails - Record Class in io.github.stefanbratanov.jvm.openai
- threadsClient() - Method in class io.github.stefanbratanov.jvm.openai.OpenAI
- ThreadsClient - Class in io.github.stefanbratanov.jvm.openai
-
Create threads that assistants can interact with.
- timestampGranularities() - Method in record class io.github.stefanbratanov.jvm.openai.TranscriptionRequest
-
Returns the value of the
timestampGranularities
record component. - timestampGranularities(List<String>) - Method in class io.github.stefanbratanov.jvm.openai.TranscriptionRequest.Builder
- token() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.Content
-
Returns the value of the
token
record component. - token() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.TopLogprob
-
Returns the value of the
token
record component. - tool(Tool) - Method in class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest.Builder
- tool(Tool) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- tool(Tool) - Method in class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest.Builder
- Tool - Interface in io.github.stefanbratanov.jvm.openai
- Tool.CodeInterpreterTool - Record Class in io.github.stefanbratanov.jvm.openai
- Tool.FunctionTool - Record Class in io.github.stefanbratanov.jvm.openai
- Tool.FunctionTool.Function - Record Class in io.github.stefanbratanov.jvm.openai
- Tool.FunctionTool.Function.Builder - Class in io.github.stefanbratanov.jvm.openai
- Tool.RetrievalTool - Record Class in io.github.stefanbratanov.jvm.openai
- ToolCall - Interface in io.github.stefanbratanov.jvm.openai
- ToolCall.CodeInterpreterToolCall - Record Class in io.github.stefanbratanov.jvm.openai
- ToolCall.CodeInterpreterToolCall.CodeInterpreter - Record Class in io.github.stefanbratanov.jvm.openai
- ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output - Interface in io.github.stefanbratanov.jvm.openai
- ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput - Record Class in io.github.stefanbratanov.jvm.openai
- ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput.Image - Record Class in io.github.stefanbratanov.jvm.openai
- ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.LogOutput - Record Class in io.github.stefanbratanov.jvm.openai
- ToolCall.FunctionToolCall - Record Class in io.github.stefanbratanov.jvm.openai
- ToolCall.FunctionToolCall.Function - Record Class in io.github.stefanbratanov.jvm.openai
- ToolCall.RetrievalToolCall - Record Class in io.github.stefanbratanov.jvm.openai
- toolCallId() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.ToolMessage
-
Returns the value of the
toolCallId
record component. - toolCallId() - Method in record class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest.ToolOutput
-
Returns the value of the
toolCallId
record component. - toolCallId(String) - Method in class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest.ToolOutput.Builder
- toolCalls() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice.Message
-
Returns the value of the
toolCalls
record component. - toolCalls() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice.Delta
-
Returns the value of the
toolCalls
record component. - toolCalls() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.AssistantMessage
-
Returns the value of the
toolCalls
record component. - toolCalls() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.RequiredAction.SubmitToolOutputs
-
Returns the value of the
toolCalls
record component. - toolCalls() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.ToolCallsStepDetails
-
Returns the value of the
toolCalls
record component. - ToolCallsStepDetails(List<ToolCall>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.ToolCallsStepDetails
-
Creates an instance of a
ToolCallsStepDetails
record class. - toolChoice() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
toolChoice
record component. - toolChoice(ToolChoice) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- toolChoice(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- ToolChoice - Record Class in io.github.stefanbratanov.jvm.openai
-
Specifies a tool the model should use.
- ToolChoice(String, ToolChoice.Function) - Constructor for record class io.github.stefanbratanov.jvm.openai.ToolChoice
-
Creates an instance of a
ToolChoice
record class. - ToolChoice.Function - Record Class in io.github.stefanbratanov.jvm.openai
- toolMessage(String, String) - Static method in interface io.github.stefanbratanov.jvm.openai.ChatMessage
- ToolMessage(String, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatMessage.ToolMessage
-
Creates an instance of a
ToolMessage
record class. - ToolOutput(Optional<String>, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest.ToolOutput
-
Creates an instance of a
ToolOutput
record class. - toolOutputs() - Method in record class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest
-
Returns the value of the
toolOutputs
record component. - tools() - Method in record class io.github.stefanbratanov.jvm.openai.Assistant
-
Returns the value of the
tools
record component. - tools() - Method in record class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest
-
Returns the value of the
tools
record component. - tools() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
tools
record component. - tools() - Method in record class io.github.stefanbratanov.jvm.openai.CreateRunRequest
-
Returns the value of the
tools
record component. - tools() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest
-
Returns the value of the
tools
record component. - tools() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest
-
Returns the value of the
tools
record component. - tools() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
tools
record component. - tools(List<Tool>) - Method in class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest.Builder
- tools(List<Tool>) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- tools(List<Tool>) - Method in class io.github.stefanbratanov.jvm.openai.CreateRunRequest.Builder
- tools(List<Tool>) - Method in class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest.Builder
- tools(List<Tool>) - Method in class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest.Builder
- TopLogprob(String, double, List<Byte>) - Constructor for record class io.github.stefanbratanov.jvm.openai.Logprobs.TopLogprob
-
Creates an instance of a
TopLogprob
record class. - topLogprobs() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
topLogprobs
record component. - topLogprobs() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.Content
-
Returns the value of the
topLogprobs
record component. - topLogprobs(int) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- topP() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
topP
record component. - topP(double) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Assistant
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantFile
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistantFiles
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.AssistantsClient.PaginatedAssistants
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice.Message
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion.Choice
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice.Delta
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk.Choice
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletionChunk
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.AssistantMessage
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.SystemMessage
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.ToolMessage
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart.ImageUrl
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.TextContentPart
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithTextContent
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.CreateAssistantRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.ResponseFormat
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Hyperparameters
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.CreateMessageRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.CreateRunRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadAndRunRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest.Message
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.CreateThreadRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.DeletionStatus
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.EditImageRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings.Embedding
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings.Usage
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.File
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningEvents
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningClient.PaginatedFineTuningJobs
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob.Error
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob.Hyperparameters
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJobEvent
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Images.Image
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Images
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.Content
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs.TopLogprob
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Logprobs
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessageFiles
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.MessagesClient.PaginatedThreadMessages
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Model
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ModerationRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyAssistantRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyMessageRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyRunRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ModifyThreadRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.OpenAIException.Error
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.PaginationQueryParameters
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRuns
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.RunsClient.PaginatedThreadRunSteps
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.SpeechRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest.ToolOutput
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.SubmitToolOutputsRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Thread
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.ImageFileContent.ImageFile
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.ImageFileContent
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation.FilePath
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessageFile
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.LastError
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.RequiredAction.SubmitToolOutputs
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.RequiredAction
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.LastError
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.MessageCreationStepDetails.MessageCreation
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.MessageCreationStepDetails
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.ToolCallsStepDetails
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.CodeInterpreterTool
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool.Function
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.RetrievalTool
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput.Image
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.LogOutput
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall.Function
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.RetrievalToolCall
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ToolChoice.Function
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.ToolChoice
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.TranscriptionRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.TranslationRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.UploadFileRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.stefanbratanov.jvm.openai.Usage
-
Returns a string representation of this record class.
- totalTokens() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings.Usage
-
Returns the value of the
totalTokens
record component. - totalTokens() - Method in record class io.github.stefanbratanov.jvm.openai.Usage
-
Returns the value of the
totalTokens
record component. - trainedTokens() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
trainedTokens
record component. - trainingFile() - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest
-
Returns the value of the
trainingFile
record component. - trainingFile() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
trainingFile
record component. - trainingFile(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Builder
- TranscriptionRequest - Record Class in io.github.stefanbratanov.jvm.openai
- TranscriptionRequest(Path, String, Optional<String>, Optional<String>, Optional<String>, Optional<Double>, Optional<List<String>>) - Constructor for record class io.github.stefanbratanov.jvm.openai.TranscriptionRequest
-
Creates an instance of a
TranscriptionRequest
record class. - TranscriptionRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- TranslationRequest - Record Class in io.github.stefanbratanov.jvm.openai
- TranslationRequest(Path, String, Optional<String>, Optional<String>, Optional<Double>) - Constructor for record class io.github.stefanbratanov.jvm.openai.TranslationRequest
-
Creates an instance of a
TranslationRequest
record class. - TranslationRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.TextContentPart
- type() - Method in interface io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart
- type() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.ResponseFormat
-
Returns the value of the
type
record component. - type() - Method in record class io.github.stefanbratanov.jvm.openai.OpenAIException.Error
-
Returns the value of the
type
record component. - type() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.ImageFileContent
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation
- type() - Method in interface io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent
- type() - Method in interface io.github.stefanbratanov.jvm.openai.ThreadMessage.Content
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun.RequiredAction
-
Returns the value of the
type
record component. - type() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.MessageCreationStepDetails
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails.ToolCallsStepDetails
- type() - Method in interface io.github.stefanbratanov.jvm.openai.ThreadRunStep.StepDetails
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
type
record component. - type() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.CodeInterpreterTool
- type() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.FunctionTool
- type() - Method in record class io.github.stefanbratanov.jvm.openai.Tool.RetrievalTool
- type() - Method in interface io.github.stefanbratanov.jvm.openai.Tool
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output.LogOutput
- type() - Method in interface io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall.CodeInterpreter.Output
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.CodeInterpreterToolCall
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ToolCall.RetrievalToolCall
- type() - Method in interface io.github.stefanbratanov.jvm.openai.ToolCall
- type() - Method in record class io.github.stefanbratanov.jvm.openai.ToolChoice
-
Returns the value of the
type
record component.
U
- uploadFile(UploadFileRequest) - Method in class io.github.stefanbratanov.jvm.openai.FilesClient
-
Upload a file that can be used across various endpoints.
- UploadFileRequest - Record Class in io.github.stefanbratanov.jvm.openai
- UploadFileRequest(Path, String) - Constructor for record class io.github.stefanbratanov.jvm.openai.UploadFileRequest
-
Creates an instance of a
UploadFileRequest
record class. - UploadFileRequest.Builder - Class in io.github.stefanbratanov.jvm.openai
- url() - Method in record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart.ImageContentPart.ImageUrl
-
Returns the value of the
url
record component. - url() - Method in record class io.github.stefanbratanov.jvm.openai.Images.Image
-
Returns the value of the
url
record component. - usage() - Method in record class io.github.stefanbratanov.jvm.openai.ChatCompletion
-
Returns the value of the
usage
record component. - usage() - Method in record class io.github.stefanbratanov.jvm.openai.Embeddings
-
Returns the value of the
usage
record component. - usage() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRun
-
Returns the value of the
usage
record component. - usage() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadRunStep
-
Returns the value of the
usage
record component. - Usage - Record Class in io.github.stefanbratanov.jvm.openai
-
Usage statistics
- Usage(int, int) - Constructor for record class io.github.stefanbratanov.jvm.openai.Embeddings.Usage
-
Creates an instance of a
Usage
record class. - Usage(int, int, int) - Constructor for record class io.github.stefanbratanov.jvm.openai.Usage
-
Creates an instance of a
Usage
record class. - user() - Method in record class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest
-
Returns the value of the
user
record component. - user() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageRequest
-
Returns the value of the
user
record component. - user() - Method in record class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest
-
Returns the value of the
user
record component. - user() - Method in record class io.github.stefanbratanov.jvm.openai.EditImageRequest
-
Returns the value of the
user
record component. - user() - Method in record class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest
-
Returns the value of the
user
record component. - user(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateChatCompletionRequest.Builder
- user(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageRequest.Builder
- user(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest.Builder
- user(String) - Method in class io.github.stefanbratanov.jvm.openai.EditImageRequest.Builder
- user(String) - Method in class io.github.stefanbratanov.jvm.openai.EmbeddingsRequest.Builder
- userMessage(ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart...) - Static method in interface io.github.stefanbratanov.jvm.openai.ChatMessage
- userMessage(String) - Static method in interface io.github.stefanbratanov.jvm.openai.ChatMessage
- UserMessageWithContentParts(List<ChatMessage.UserMessage.UserMessageWithContentParts.ContentPart>, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithContentParts
-
Creates an instance of a
UserMessageWithContentParts
record class. - UserMessageWithTextContent(String, Optional<String>) - Constructor for record class io.github.stefanbratanov.jvm.openai.ChatMessage.UserMessage.UserMessageWithTextContent
-
Creates an instance of a
UserMessageWithTextContent
record class.
V
- validationFile() - Method in record class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest
-
Returns the value of the
validationFile
record component. - validationFile() - Method in record class io.github.stefanbratanov.jvm.openai.FineTuningJob
-
Returns the value of the
validationFile
record component. - validationFile(String) - Method in class io.github.stefanbratanov.jvm.openai.CreateFineTuningJobRequest.Builder
- value() - Method in record class io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text
-
Returns the value of the
value
record component. - violence() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns the value of the
violence
record component. - violence() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns the value of the
violence
record component. - violenceGraphic() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.Categories
-
Returns the value of the
violenceGraphic
record component. - violenceGraphic() - Method in record class io.github.stefanbratanov.jvm.openai.Moderation.Result.CategoryScores
-
Returns the value of the
violenceGraphic
record component. - voice() - Method in record class io.github.stefanbratanov.jvm.openai.SpeechRequest
-
Returns the value of the
voice
record component. - voice(String) - Method in class io.github.stefanbratanov.jvm.openai.SpeechRequest.Builder
All Classes and Interfaces|All Packages|Serialized Form