Index
All Classes and Interfaces|All Packages
A
- ai.optfor.springopenaiapi - package ai.optfor.springopenaiapi
- ai.optfor.springopenaiapi.cache - package ai.optfor.springopenaiapi.cache
- ai.optfor.springopenaiapi.enums - package ai.optfor.springopenaiapi.enums
- ai.optfor.springopenaiapi.model - package ai.optfor.springopenaiapi.model
- ai.optfor.springopenaiapi.utils - package ai.optfor.springopenaiapi.utils
- ALLOY - Enum constant in enum class ai.optfor.springopenaiapi.enums.TTSVoice
- apiValueOf(String) - Static method in enum class ai.optfor.springopenaiapi.enums.EmbedModel
- apiValueOf(String) - Static method in enum class ai.optfor.springopenaiapi.enums.LLMModel
- apiValueOf(String) - Static method in enum class ai.optfor.springopenaiapi.enums.TTSModel
- assistantMessage(String) - Static method in record class ai.optfor.springopenaiapi.model.ChatMessage
- AudioResponse - Record Class in ai.optfor.springopenaiapi.model
- AudioResponse(String) - Constructor for record class ai.optfor.springopenaiapi.model.AudioResponse
-
Creates an instance of a
AudioResponserecord class.
C
- chat(LLMModel, String, String, Integer, double, String) - Method in class ai.optfor.springopenaiapi.OpenAIApi
- chat(LLMModel, String, String, String, Integer, double, String) - Method in class ai.optfor.springopenaiapi.OpenAIApi
- chat(LLMModel, List<ChatMessage>, int, double, String) - Method in class ai.optfor.springopenaiapi.OpenAIApi
- ChatChoice - Record Class in ai.optfor.springopenaiapi.model
- ChatChoice(int, ChatMessage, ChatMessage, String) - Constructor for record class ai.optfor.springopenaiapi.model.ChatChoice
-
Creates an instance of a
ChatChoicerecord class. - ChatCompletionRequest - Record Class in ai.optfor.springopenaiapi.model
- ChatCompletionRequest(String, List<ChatMessage>, double, int, boolean) - Constructor for record class ai.optfor.springopenaiapi.model.ChatCompletionRequest
-
Creates an instance of a
ChatCompletionRequestrecord class. - ChatCompletionResponse - Record Class in ai.optfor.springopenaiapi.model
- ChatCompletionResponse(String, List<ChatChoice>, Usage) - Constructor for record class ai.optfor.springopenaiapi.model.ChatCompletionResponse
-
Creates an instance of a
ChatCompletionResponserecord class. - ChatMessage - Record Class in ai.optfor.springopenaiapi.model
- ChatMessage(String, String) - Constructor for record class ai.optfor.springopenaiapi.model.ChatMessage
-
Creates an instance of a
ChatMessagerecord class. - choices() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionResponse
-
Returns the value of the
choicesrecord component. - completion_tokens() - Method in record class ai.optfor.springopenaiapi.model.Usage
-
Returns the value of the
completion_tokensrecord component. - content() - Method in record class ai.optfor.springopenaiapi.model.ChatMessage
-
Returns the value of the
contentrecord component. - content() - Method in record class ai.optfor.springopenaiapi.model.VisionMessage
-
Returns the value of the
contentrecord component. - createSpeech(TTSModel, String, TTSVoice, String) - Method in class ai.optfor.springopenaiapi.OpenAIApi
D
- data() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingResponse
-
Returns the value of the
datarecord component. - DefaultPromptCache - Class in ai.optfor.springopenaiapi.cache
- DefaultPromptCache() - Constructor for class ai.optfor.springopenaiapi.cache.DefaultPromptCache
- delta() - Method in record class ai.optfor.springopenaiapi.model.ChatChoice
-
Returns the value of the
deltarecord component.
E
- ECHO - Enum constant in enum class ai.optfor.springopenaiapi.enums.TTSVoice
- embedding() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingData
-
Returns the value of the
embeddingrecord component. - embedding(EmbedModel, String, String) - Method in class ai.optfor.springopenaiapi.OpenAIApi
- embedding(EmbedModel, List<String>, String) - Method in class ai.optfor.springopenaiapi.OpenAIApi
- EmbeddingData - Record Class in ai.optfor.springopenaiapi.model
- EmbeddingData(List<Double>) - Constructor for record class ai.optfor.springopenaiapi.model.EmbeddingData
-
Creates an instance of a
EmbeddingDatarecord class. - EmbeddingRequest - Record Class in ai.optfor.springopenaiapi.model
- EmbeddingRequest(String, List<String>) - Constructor for record class ai.optfor.springopenaiapi.model.EmbeddingRequest
-
Creates an instance of a
EmbeddingRequestrecord class. - EmbeddingResponse - Record Class in ai.optfor.springopenaiapi.model
- EmbeddingResponse(String, List<EmbeddingData>, Usage) - Constructor for record class ai.optfor.springopenaiapi.model.EmbeddingResponse
-
Creates an instance of a
EmbeddingResponserecord class. - EmbedModel - Enum Class in ai.optfor.springopenaiapi.enums
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.AudioResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.ChatChoice
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.ChatMessage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.EmbeddingData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.EmbeddingRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.EmbeddingResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.STTRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.Usage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.VisionCompletionRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.VisionImageUrl
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.VisionMessage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.optfor.springopenaiapi.model.VisionMessageContent
-
Indicates whether some other object is "equal to" this one.
- estimateCost(LLMModel, Integer, Integer) - Static method in class ai.optfor.springopenaiapi.utils.StreamCostEstimate
F
- FABLE - Enum constant in enum class ai.optfor.springopenaiapi.enums.TTSVoice
- finish_reason() - Method in record class ai.optfor.springopenaiapi.model.ChatChoice
-
Returns the value of the
finish_reasonrecord component.
G
- get(String) - Method in class ai.optfor.springopenaiapi.cache.DefaultPromptCache
- get(String) - Method in interface ai.optfor.springopenaiapi.cache.PromptCache
- getCost() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionResponse
- getCost() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingResponse
- getDelta() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionResponse
- getFirstCompletion() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionResponse
- getFirstCompletion() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingResponse
- GPT_3_5_TURBO - Enum constant in enum class ai.optfor.springopenaiapi.enums.LLMModel
- GPT_3_5_TURBO_16K - Enum constant in enum class ai.optfor.springopenaiapi.enums.LLMModel
- GPT_4 - Enum constant in enum class ai.optfor.springopenaiapi.enums.LLMModel
- GPT_4_TURBO_PREVIEW - Enum constant in enum class ai.optfor.springopenaiapi.enums.LLMModel
- GPT_4_VISION_PREVIEW - Enum constant in enum class ai.optfor.springopenaiapi.enums.LLMModel
H
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.AudioResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.ChatChoice
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.ChatMessage
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingData
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.STTRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.Usage
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.VisionCompletionRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.VisionImageUrl
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.VisionMessage
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.optfor.springopenaiapi.model.VisionMessageContent
-
Returns a hash code value for this object.
I
- image_url() - Method in record class ai.optfor.springopenaiapi.model.VisionMessageContent
-
Returns the value of the
image_urlrecord component. - index() - Method in record class ai.optfor.springopenaiapi.model.ChatChoice
-
Returns the value of the
indexrecord component. - input() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingRequest
-
Returns the value of the
inputrecord component. - input() - Method in record class ai.optfor.springopenaiapi.model.STTRequest
-
Returns the value of the
inputrecord component.
L
- LLMModel - Enum Class in ai.optfor.springopenaiapi.enums
M
- max_tokens() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionRequest
-
Returns the value of the
max_tokensrecord component. - max_tokens() - Method in record class ai.optfor.springopenaiapi.model.VisionCompletionRequest
-
Returns the value of the
max_tokensrecord component. - message() - Method in record class ai.optfor.springopenaiapi.model.ChatChoice
-
Returns the value of the
messagerecord component. - messages() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionRequest
-
Returns the value of the
messagesrecord component. - messages() - Method in record class ai.optfor.springopenaiapi.model.VisionCompletionRequest
-
Returns the value of the
messagesrecord component. - model() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionRequest
-
Returns the value of the
modelrecord component. - model() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionResponse
-
Returns the value of the
modelrecord component. - model() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingRequest
-
Returns the value of the
modelrecord component. - model() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingResponse
-
Returns the value of the
modelrecord component. - model() - Method in record class ai.optfor.springopenaiapi.model.STTRequest
-
Returns the value of the
modelrecord component. - model() - Method in record class ai.optfor.springopenaiapi.model.VisionCompletionRequest
-
Returns the value of the
modelrecord component.
N
O
- ONYX - Enum constant in enum class ai.optfor.springopenaiapi.enums.TTSVoice
- OpenAIApi - Class in ai.optfor.springopenaiapi
- OpenAIApi(PromptCache) - Constructor for class ai.optfor.springopenaiapi.OpenAIApi
P
- prompt_tokens() - Method in record class ai.optfor.springopenaiapi.model.Usage
-
Returns the value of the
prompt_tokensrecord component. - PromptCache - Interface in ai.optfor.springopenaiapi.cache
- put(String, String) - Method in class ai.optfor.springopenaiapi.cache.DefaultPromptCache
- put(String, String) - Method in interface ai.optfor.springopenaiapi.cache.PromptCache
R
- role() - Method in record class ai.optfor.springopenaiapi.model.ChatMessage
-
Returns the value of the
rolerecord component. - role() - Method in record class ai.optfor.springopenaiapi.model.VisionMessage
-
Returns the value of the
rolerecord component.
S
- SHIMMER - Enum constant in enum class ai.optfor.springopenaiapi.enums.TTSVoice
- stream() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionRequest
-
Returns the value of the
streamrecord component. - stream() - Method in record class ai.optfor.springopenaiapi.model.VisionCompletionRequest
-
Returns the value of the
streamrecord component. - StreamCostEstimate - Class in ai.optfor.springopenaiapi.utils
- StreamCostEstimate() - Constructor for class ai.optfor.springopenaiapi.utils.StreamCostEstimate
- streamingChat(LLMModel, String, String, String, Integer, double, String) - Method in class ai.optfor.springopenaiapi.OpenAIApi
- streamingChat(LLMModel, List<ChatMessage>, Integer, double, String) - Method in class ai.optfor.springopenaiapi.OpenAIApi
- STTRequest - Record Class in ai.optfor.springopenaiapi.model
- STTRequest(String, String, String) - Constructor for record class ai.optfor.springopenaiapi.model.STTRequest
-
Creates an instance of a
STTRequestrecord class. - systemMessage(String) - Static method in record class ai.optfor.springopenaiapi.model.ChatMessage
T
- temperature() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionRequest
-
Returns the value of the
temperaturerecord component. - temperature() - Method in record class ai.optfor.springopenaiapi.model.VisionCompletionRequest
-
Returns the value of the
temperaturerecord component. - text() - Method in record class ai.optfor.springopenaiapi.model.AudioResponse
-
Returns the value of the
textrecord component. - text() - Method in record class ai.optfor.springopenaiapi.model.VisionMessageContent
-
Returns the value of the
textrecord component. - TEXT_EMBEDDING_3_LARGE - Enum constant in enum class ai.optfor.springopenaiapi.enums.EmbedModel
- TEXT_EMBEDDING_3_SMALL - Enum constant in enum class ai.optfor.springopenaiapi.enums.EmbedModel
- TEXT_EMBEDDING_ADA_002 - Enum constant in enum class ai.optfor.springopenaiapi.enums.EmbedModel
- toApiName() - Method in enum class ai.optfor.springopenaiapi.enums.TTSVoice
- toString() - Method in record class ai.optfor.springopenaiapi.model.AudioResponse
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.ChatChoice
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionRequest
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionResponse
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.ChatMessage
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingData
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingRequest
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingResponse
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.STTRequest
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.Usage
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.VisionCompletionRequest
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.VisionImageUrl
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.VisionMessage
-
Returns a string representation of this record class.
- toString() - Method in record class ai.optfor.springopenaiapi.model.VisionMessageContent
-
Returns a string representation of this record class.
- total_tokens() - Method in record class ai.optfor.springopenaiapi.model.Usage
-
Returns the value of the
total_tokensrecord component. - transcribeAudio(byte[], String, String) - Method in class ai.optfor.springopenaiapi.OpenAIApi
- TTS_1 - Enum constant in enum class ai.optfor.springopenaiapi.enums.TTSModel
- TTS_1_HD - Enum constant in enum class ai.optfor.springopenaiapi.enums.TTSModel
- TTSModel - Enum Class in ai.optfor.springopenaiapi.enums
- TTSVoice - Enum Class in ai.optfor.springopenaiapi.enums
- type() - Method in record class ai.optfor.springopenaiapi.model.VisionMessageContent
-
Returns the value of the
typerecord component.
U
- url() - Method in record class ai.optfor.springopenaiapi.model.VisionImageUrl
-
Returns the value of the
urlrecord component. - usage() - Method in record class ai.optfor.springopenaiapi.model.ChatCompletionResponse
-
Returns the value of the
usagerecord component. - usage() - Method in record class ai.optfor.springopenaiapi.model.EmbeddingResponse
-
Returns the value of the
usagerecord component. - Usage - Record Class in ai.optfor.springopenaiapi.model
- Usage(int, int, int) - Constructor for record class ai.optfor.springopenaiapi.model.Usage
-
Creates an instance of a
Usagerecord class. - userMessage(String) - Static method in record class ai.optfor.springopenaiapi.model.ChatMessage
V
- valueOf(String) - Static method in enum class ai.optfor.springopenaiapi.enums.EmbedModel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class ai.optfor.springopenaiapi.enums.LLMModel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class ai.optfor.springopenaiapi.enums.TTSModel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class ai.optfor.springopenaiapi.enums.TTSVoice
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class ai.optfor.springopenaiapi.enums.EmbedModel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class ai.optfor.springopenaiapi.enums.LLMModel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class ai.optfor.springopenaiapi.enums.TTSModel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class ai.optfor.springopenaiapi.enums.TTSVoice
-
Returns an array containing the constants of this enum class, in the order they are declared.
- vision(List<VisionMessage>, Integer, double, String) - Method in class ai.optfor.springopenaiapi.OpenAIApi
- visionAssistantMessage(String) - Static method in record class ai.optfor.springopenaiapi.model.VisionMessage
- VisionCompletionRequest - Record Class in ai.optfor.springopenaiapi.model
- VisionCompletionRequest(String, List<VisionMessage>, double, int, boolean) - Constructor for record class ai.optfor.springopenaiapi.model.VisionCompletionRequest
-
Creates an instance of a
VisionCompletionRequestrecord class. - visionImageMessageContent(String) - Static method in record class ai.optfor.springopenaiapi.model.VisionMessageContent
- visionImageUrl(String) - Static method in record class ai.optfor.springopenaiapi.model.VisionImageUrl
- VisionImageUrl - Record Class in ai.optfor.springopenaiapi.model
- VisionImageUrl(String) - Constructor for record class ai.optfor.springopenaiapi.model.VisionImageUrl
-
Creates an instance of a
VisionImageUrlrecord class. - VisionMessage - Record Class in ai.optfor.springopenaiapi.model
- VisionMessage(String, List<VisionMessageContent>) - Constructor for record class ai.optfor.springopenaiapi.model.VisionMessage
-
Creates an instance of a
VisionMessagerecord class. - VisionMessageContent - Record Class in ai.optfor.springopenaiapi.model
- VisionMessageContent(String, String, VisionImageUrl) - Constructor for record class ai.optfor.springopenaiapi.model.VisionMessageContent
-
Creates an instance of a
VisionMessageContentrecord class. - visionStreaming(LLMModel, List<VisionMessage>, Integer, double, String) - Method in class ai.optfor.springopenaiapi.OpenAIApi
- visionSystemMessage(String) - Static method in record class ai.optfor.springopenaiapi.model.VisionMessage
- visionTextMessageContent(String) - Static method in record class ai.optfor.springopenaiapi.model.VisionMessageContent
- visionUserMessage(String, String) - Static method in record class ai.optfor.springopenaiapi.model.VisionMessage
- visionUserTextMessage(String) - Static method in record class ai.optfor.springopenaiapi.model.VisionMessage
- voice() - Method in record class ai.optfor.springopenaiapi.model.STTRequest
-
Returns the value of the
voicerecord component.
All Classes and Interfaces|All Packages