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
  • Field Details

  • Constructor Details

    • OpenAiChatProperties

      public OpenAiChatProperties()
  • Method Details

    • getModel

      public @Nullable String getModel()
      Overrides:
      getModel in class AbstractOpenAiProperties
    • setModel

      public void setModel(@Nullable String model)
      Overrides:
      setModel in class AbstractOpenAiProperties
    • getFrequencyPenalty

      public @Nullable Double getFrequencyPenalty()
    • setFrequencyPenalty

      public void setFrequencyPenalty(@Nullable Double frequencyPenalty)
    • getLogitBias

      public @Nullable Map<String,Integer> getLogitBias()
    • setLogitBias

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

      public @Nullable Boolean getLogprobs()
    • setLogprobs

      public void setLogprobs(@Nullable Boolean logprobs)
    • getTopLogprobs

      public @Nullable Integer getTopLogprobs()
    • setTopLogprobs

      public void setTopLogprobs(@Nullable Integer topLogprobs)
    • getMaxTokens

      public @Nullable Integer getMaxTokens()
    • setMaxTokens

      public void setMaxTokens(@Nullable Integer maxTokens)
    • getMaxCompletionTokens

      public @Nullable Integer getMaxCompletionTokens()
    • setMaxCompletionTokens

      public void setMaxCompletionTokens(@Nullable Integer maxCompletionTokens)
    • getN

      public @Nullable Integer getN()
    • setN

      public void setN(@Nullable Integer n)
    • getOutputModalities

      public @Nullable List<String> getOutputModalities()
    • setOutputModalities

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

      public @Nullable OpenAiChatOptions.AudioParameters getOutputAudio()
    • setOutputAudio

      public void setOutputAudio(@Nullable OpenAiChatOptions.AudioParameters outputAudio)
    • getPresencePenalty

      public @Nullable Double getPresencePenalty()
    • setPresencePenalty

      public void setPresencePenalty(@Nullable Double presencePenalty)
    • getResponseFormat

      public @Nullable OpenAiChatModel.ResponseFormat getResponseFormat()
    • setResponseFormat

      public void setResponseFormat(@Nullable OpenAiChatModel.ResponseFormat responseFormat)
    • getStreamOptions

      public @Nullable OpenAiChatOptions.StreamOptions getStreamOptions()
    • setStreamOptions

      public void setStreamOptions(@Nullable OpenAiChatOptions.StreamOptions streamOptions)
    • getSeed

      public @Nullable Integer getSeed()
    • setSeed

      public void setSeed(@Nullable Integer seed)
    • getStop

      public @Nullable List<String> getStop()
    • setStop

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

      public @Nullable Double getTemperature()
    • setTemperature

      public void setTemperature(@Nullable Double temperature)
    • getTopP

      public @Nullable Double getTopP()
    • setTopP

      public void setTopP(@Nullable Double topP)
    • getToolChoice

      public @Nullable Object getToolChoice()
    • setToolChoice

      public void setToolChoice(@Nullable Object toolChoice)
    • getUser

      public @Nullable String getUser()
    • setUser

      public void setUser(@Nullable String user)
    • getParallelToolCalls

      public @Nullable Boolean getParallelToolCalls()
    • setParallelToolCalls

      public void setParallelToolCalls(@Nullable Boolean parallelToolCalls)
    • getStore

      public @Nullable Boolean getStore()
    • setStore

      public void setStore(@Nullable Boolean store)
    • getMetadata

      public @Nullable Map<String,String> getMetadata()
    • setMetadata

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

      public @Nullable String getReasoningEffort()
    • setReasoningEffort

      public void setReasoningEffort(@Nullable String reasoningEffort)
    • getVerbosity

      public @Nullable String getVerbosity()
    • setVerbosity

      public void setVerbosity(@Nullable String verbosity)
    • getServiceTier

      public @Nullable String getServiceTier()
    • setServiceTier

      public void setServiceTier(@Nullable String serviceTier)
    • getPromptCacheKey

      public @Nullable String getPromptCacheKey()
    • setPromptCacheKey

      public void setPromptCacheKey(@Nullable String promptCacheKey)
    • getExtraBody

      public @Nullable Map<String,Object> getExtraBody()
    • setExtraBody

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

      public OpenAiChatOptions 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

      public void setOptions(OpenAiChatProperties.Options options)