Class OpenAiChatProperties
java.lang.Object
org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties
org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties
@ConfigurationProperties("spring.ai.openai.chat")
public class OpenAiChatProperties
extends AbstractOpenAiProperties
OpenAI SDK Chat autoconfiguration properties.
- Author:
- Christian Tzolov, Sebastien Deleuze, guan xu
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsFields inherited from class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties
DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription@Nullable Double@Nullable Boolean@Nullable Integer@Nullable Integer@Nullable StringgetModel()@Nullable IntegergetN()Deprecated, for removal: This API element is subject to removal in a future version.@Nullable OpenAiChatOptions.AudioParameters@Nullable Boolean@Nullable Double@Nullable String@Nullable String@Nullable OpenAiChatModel.ResponseFormat@Nullable IntegergetSeed()@Nullable StringgetStop()@Nullable BooleangetStore()@Nullable OpenAiChatOptions.StreamOptions@Nullable Double@Nullable Object@Nullable Integer@Nullable DoublegetTopP()@Nullable StringgetUser()@Nullable StringvoidsetExtraBody(@Nullable Map<String, Object> extraBody) voidsetFrequencyPenalty(@Nullable Double frequencyPenalty) voidsetLogitBias(@Nullable Map<String, Integer> logitBias) voidsetLogprobs(@Nullable Boolean logprobs) voidsetMaxCompletionTokens(@Nullable Integer maxCompletionTokens) voidsetMaxTokens(@Nullable Integer maxTokens) voidsetMetadata(@Nullable Map<String, String> metadata) voidvoidvoidsetOptions(OpenAiChatProperties.Options options) voidsetOutputAudio(@Nullable OpenAiChatOptions.AudioParameters outputAudio) voidsetOutputModalities(@Nullable List<String> outputModalities) voidsetParallelToolCalls(@Nullable Boolean parallelToolCalls) voidsetPresencePenalty(@Nullable Double presencePenalty) voidsetPromptCacheKey(@Nullable String promptCacheKey) voidsetReasoningEffort(@Nullable String reasoningEffort) voidsetResponseFormat(@Nullable OpenAiChatModel.ResponseFormat responseFormat) voidvoidsetServiceTier(@Nullable String serviceTier) voidvoidvoidsetStreamOptions(@Nullable OpenAiChatOptions.StreamOptions streamOptions) voidsetTemperature(@Nullable Double temperature) voidsetToolChoice(@Nullable Object toolChoice) voidsetTopLogprobs(@Nullable Integer topLogprobs) voidvoidvoidsetVerbosity(@Nullable String verbosity) Methods inherited from class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties
getApiKey, getBaseUrl, getCredential, getCustomHeaders, getDeploymentName, getMaxRetries, getMicrosoftDeploymentName, getMicrosoftFoundryServiceVersion, getOrganizationId, getProxy, getTimeout, isConnectionPoolMetricsEnabled, isGitHubModels, isMicrosoftFoundry, setApiKey, setBaseUrl, setConnectionPoolMetricsEnabled, setCredential, setCustomHeaders, setDeploymentName, setGitHubModels, setMaxRetries, setMicrosoftDeploymentName, setMicrosoftFoundry, setMicrosoftFoundryServiceVersion, setOrganizationId, setProxy, setTimeout
-
Field Details
-
CONFIG_PREFIX
- See Also:
-
-
Constructor Details
-
OpenAiChatProperties
public OpenAiChatProperties()
-
-
Method Details
-
getModel
- Overrides:
getModelin classAbstractOpenAiProperties
-
setModel
- Overrides:
setModelin classAbstractOpenAiProperties
-
getFrequencyPenalty
-
setFrequencyPenalty
-
getLogitBias
-
setLogitBias
-
getLogprobs
-
setLogprobs
-
getTopLogprobs
-
setTopLogprobs
-
getMaxTokens
-
setMaxTokens
-
getMaxCompletionTokens
-
setMaxCompletionTokens
-
getN
-
setN
-
getOutputModalities
-
setOutputModalities
-
getOutputAudio
-
setOutputAudio
-
getPresencePenalty
-
setPresencePenalty
-
getResponseFormat
-
setResponseFormat
-
getStreamOptions
-
setStreamOptions
-
getSeed
-
setSeed
-
getStop
-
setStop
-
getTemperature
-
setTemperature
-
getTopP
-
setTopP
-
getToolChoice
-
setToolChoice
-
getUser
-
setUser
-
getParallelToolCalls
-
setParallelToolCalls
-
getStore
-
setStore
-
getMetadata
-
setMetadata
-
getReasoningEffort
-
setReasoningEffort
-
getVerbosity
-
setVerbosity
-
getServiceTier
-
setServiceTier
-
getPromptCacheKey
-
setPromptCacheKey
-
getExtraBody
-
setExtraBody
-
toOptions
-
getOptions
@DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat") @Deprecated(since="2.0.0", forRemoval=true) public OpenAiChatProperties.Options getOptions()Deprecated, for removal: This API element is subject to removal in a future version. -
setOptions
-