Class OpenAiResponsesChatProperties
java.lang.Object
org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties
org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties
@ConfigurationProperties("spring.ai.openai.responses")
public class OpenAiResponsesChatProperties
extends AbstractOpenAiProperties
Configuration properties for the OpenAI Responses API chat model, selected with
spring.ai.openai.chat.api=responses.
Connection settings are shared with the Chat Completions model under
spring.ai.openai, and can be overridden here.
- Since:
- 2.1.0
- Author:
- Dimitar Proynov
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classThe subset of server-executed tools that is configurable declaratively. -
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 Integer@Nullable Integer@Nullable Boolean@Nullable String@Nullable String@Nullable String@Nullable OpenAiChatModel.ResponseFormat@Nullable String@Nullable String@Nullable Boolean@Nullable Double@Nullable Object@Nullable DoublegetTopP()@Nullable String@Nullable StringvoidsetExtraBody(@Nullable Map<String, Object> extraBody) voidsetHostedTools(OpenAiResponsesChatProperties.HostedTools hostedTools) voidsetInclude(@Nullable List<String> include) voidsetMaxOutputTokens(@Nullable Integer maxOutputTokens) voidsetMaxToolCalls(@Nullable Integer maxToolCalls) voidsetMetadata(@Nullable Map<String, String> metadata) voidsetParallelToolCalls(@Nullable Boolean parallelToolCalls) voidsetPromptCacheKey(@Nullable String promptCacheKey) voidsetReasoningEffort(@Nullable String reasoningEffort) voidsetReasoningSummary(@Nullable String reasoningSummary) voidsetResponseFormat(@Nullable OpenAiChatModel.ResponseFormat responseFormat) voidsetSafetyIdentifier(@Nullable String safetyIdentifier) voidsetServiceTier(@Nullable String serviceTier) voidvoidsetTemperature(@Nullable Double temperature) voidsetToolChoice(@Nullable Object toolChoice) voidvoidsetTruncation(@Nullable String truncation) voidsetVerbosity(@Nullable String verbosity) Methods inherited from class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties
getApiKey, getBaseUrl, getCredential, getCustomHeaders, getDeploymentName, getMaxRetries, getMicrosoftDeploymentName, getMicrosoftFoundryServiceVersion, getModel, getOrganizationId, getProxy, getTimeout, isConnectionPoolMetricsEnabled, isGitHubModels, isMicrosoftFoundry, setApiKey, setBaseUrl, setConnectionPoolMetricsEnabled, setCredential, setCustomHeaders, setDeploymentName, setGitHubModels, setMaxRetries, setMicrosoftDeploymentName, setMicrosoftFoundry, setMicrosoftFoundryServiceVersion, setModel, setOrganizationId, setProxy, setTimeout
-
Field Details
-
CONFIG_PREFIX
- See Also:
-
-
Constructor Details
-
OpenAiResponsesChatProperties
public OpenAiResponsesChatProperties()
-
-
Method Details
-
getMaxOutputTokens
-
setMaxOutputTokens
-
getTemperature
-
setTemperature
-
getTopP
-
setTopP
-
getReasoningEffort
-
setReasoningEffort
-
getReasoningSummary
-
setReasoningSummary
-
getVerbosity
-
setVerbosity
-
getResponseFormat
-
setResponseFormat
-
getStrict
-
setStrict
-
getToolChoice
-
setToolChoice
-
getParallelToolCalls
-
setParallelToolCalls
-
getMaxToolCalls
-
setMaxToolCalls
-
getInclude
-
setInclude
-
getTruncation
-
setTruncation
-
getServiceTier
-
setServiceTier
-
getPromptCacheKey
-
setPromptCacheKey
-
getSafetyIdentifier
-
setSafetyIdentifier
-
getMetadata
-
setMetadata
-
getExtraBody
-
setExtraBody
-
getHostedTools
-
setHostedTools
-
toOptions
-