Package org.springframework.ai.model.openai.autoconfigure

Class OpenAiChatProperties.Options

java.lang.Object
org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options
Enclosing class:
OpenAiChatProperties
public class OpenAiChatProperties.Options extends Object

  • Constructor Details

    • Options

      public Options()

  • Method Details

    • getBaseUrl

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.base-url") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable String getBaseUrl()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setBaseUrl

      public void setBaseUrl(@Nullable String baseUrl)

    • getApiKey

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.api-key") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable String getApiKey()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setApiKey

      public void setApiKey(@Nullable String apiKey)

    • getCredential

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.credential") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable com.openai.credential.Credential getCredential()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setCredential

      public void setCredential(@Nullable com.openai.credential.Credential credential)

    • getMicrosoftDeploymentName

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.microsoft-deployment-name") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable String getMicrosoftDeploymentName()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setMicrosoftDeploymentName

      public void setMicrosoftDeploymentName(@Nullable String microsoftDeploymentName)

    • getDeploymentName

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.deployment-name") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable String getDeploymentName()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setDeploymentName

      public void setDeploymentName(@Nullable String azureDeploymentName)

    • getMicrosoftFoundryServiceVersion

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.microsoft-foundry-service-version") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable com.openai.azure.AzureOpenAIServiceVersion getMicrosoftFoundryServiceVersion()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setMicrosoftFoundryServiceVersion

      public void setMicrosoftFoundryServiceVersion(@Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion)

    • getOrganizationId

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.organization-id") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable String getOrganizationId()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setOrganizationId

      public void setOrganizationId(@Nullable String organizationId)

    • getMicrosoftFoundry

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.microsoft-foundry") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Boolean getMicrosoftFoundry()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setMicrosoftFoundry

      public void setMicrosoftFoundry(@Nullable Boolean microsoftFoundry)

    • getGitHubModels

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.git-hub-models") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Boolean getGitHubModels()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setGitHubModels

      public void setGitHubModels(@Nullable Boolean gitHubModels)

    • getTimeout

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.timeout") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Duration getTimeout()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTimeout

      public void setTimeout(@Nullable Duration timeout)

    • getMaxRetries

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.max-retries") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Integer getMaxRetries()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setMaxRetries

      public void setMaxRetries(@Nullable Integer maxRetries)

    • getProxy

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.proxy") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Proxy getProxy()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setProxy

      public void setProxy(@Nullable Proxy proxy)

    • getCustomHeaders

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.custom-headers") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Map<String,String> getCustomHeaders()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setCustomHeaders

      public void setCustomHeaders(@Nullable Map<String,String> customHeaders)

    • getModel

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.model") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable String getModel()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setModel

      public void setModel(@Nullable String model)

    • getFrequencyPenalty

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.frequency-penalty") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Double getFrequencyPenalty()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setFrequencyPenalty

      public void setFrequencyPenalty(@Nullable Double frequencyPenalty)

    • getLogitBias

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.logit-bias") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Map<String,Integer> getLogitBias()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setLogitBias

      public void setLogitBias(@Nullable Map<String,Integer> logitBias)

    • getLogprobs

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.logprobs") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Boolean getLogprobs()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setLogprobs

      public void setLogprobs(@Nullable Boolean logprobs)

    • getTopLogprobs

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.top-logprobs") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Integer getTopLogprobs()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTopLogprobs

      public void setTopLogprobs(@Nullable Integer topLogprobs)

    • getMaxTokens

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.max-tokens") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Integer getMaxTokens()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setMaxTokens

      public void setMaxTokens(@Nullable Integer maxTokens)

    • getMaxCompletionTokens

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.max-completion-tokens") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Integer getMaxCompletionTokens()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setMaxCompletionTokens

      public void setMaxCompletionTokens(@Nullable Integer maxCompletionTokens)

    • getN

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.n") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Integer getN()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setN

      public void setN(@Nullable Integer n)

    • getOutputModalities

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.output-modalities") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable List<String> getOutputModalities()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setOutputModalities

      public void setOutputModalities(@Nullable List<String> outputModalities)

    • getOutputAudio

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.output-audio") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable OpenAiChatOptions.AudioParameters getOutputAudio()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setOutputAudio

      public void setOutputAudio(@Nullable OpenAiChatOptions.AudioParameters outputAudio)

    • getPresencePenalty

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.presence-penalty") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Double getPresencePenalty()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setPresencePenalty

      public void setPresencePenalty(@Nullable Double presencePenalty)

    • getResponseFormat

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.response-format") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable OpenAiChatModel.ResponseFormat getResponseFormat()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setResponseFormat

      public void setResponseFormat(@Nullable OpenAiChatModel.ResponseFormat responseFormat)

    • getStreamOptions

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.stream-options") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable OpenAiChatOptions.StreamOptions getStreamOptions()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setStreamOptions

      public void setStreamOptions(@Nullable OpenAiChatOptions.StreamOptions streamOptions)

    • getSeed

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.seed") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Integer getSeed()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setSeed

      public void setSeed(@Nullable Integer seed)

    • getStop

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.stop") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable List<String> getStop()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setStop

      public void setStop(@Nullable List<String> stop)

    • getTemperature

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.temperature") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Double getTemperature()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTemperature

      public void setTemperature(@Nullable Double temperature)

    • getTopP

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.top-p") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Double getTopP()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTopP

      public void setTopP(@Nullable Double topP)

    • getToolChoice

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.tool-choice") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Object getToolChoice()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setToolChoice

      public void setToolChoice(@Nullable Object toolChoice)

    • getUser

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.user") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable String getUser()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setUser

      public void setUser(@Nullable String user)

    • getParallelToolCalls

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.parallel-tool-calls") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Boolean getParallelToolCalls()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setParallelToolCalls

      public void setParallelToolCalls(@Nullable Boolean parallelToolCalls)

    • getStore

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.store") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Boolean getStore()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setStore

      public void setStore(@Nullable Boolean store)

    • getMetadata

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.metadata") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Map<String,String> getMetadata()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setMetadata

      public void setMetadata(@Nullable Map<String,String> metadata)

    • getReasoningEffort

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.reasoning-effort") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable String getReasoningEffort()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setReasoningEffort

      public void setReasoningEffort(@Nullable String reasoningEffort)

    • getVerbosity

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.verbosity") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable String getVerbosity()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setVerbosity

      public void setVerbosity(@Nullable String verbosity)

    • getServiceTier

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.service-tier") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable String getServiceTier()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setServiceTier

      public void setServiceTier(@Nullable String serviceTier)

    • getPromptCacheKey

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.prompt-cache-key") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable String getPromptCacheKey()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setPromptCacheKey

      public void setPromptCacheKey(@Nullable String promptCacheKey)

    • getExtraBody

      @DeprecatedConfigurationProperty(replacement="spring.ai.openai.chat.extra-body") @Deprecated(since="2.0.0", forRemoval=true) public @Nullable Map<String,Object> getExtraBody()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setExtraBody

      public void setExtraBody(@Nullable Map<String,Object> extraBody)