Package org.springframework.ai.azure.openai

Class AzureOpenAiChatOptions

java.lang.Object
org.springframework.ai.azure.openai.AzureOpenAiChatOptions
All Implemented Interfaces:
ChatOptions, FunctionCallingOptions, ModelOptions
public class AzureOpenAiChatOptions extends Object implements FunctionCallingOptions
The configuration information for a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
Author:
Christian Tzolov, Thomas Vitale, Soby Chacko

  • Constructor Details

    • AzureOpenAiChatOptions

      public AzureOpenAiChatOptions()

  • Method Details

    • builder

      public static AzureOpenAiChatOptions.Builder builder()
      Returns:
      Returns FunctionCallingOptionsBuilder to create a new instance of FunctionCallingOptions.

    • fromOptions

      public static AzureOpenAiChatOptions fromOptions(AzureOpenAiChatOptions fromOptions)

    • getMaxTokens

      public Integer getMaxTokens()
      Description copied from interface: ChatOptions
      Returns the maximum number of tokens to use for the chat.
      Specified by:
      getMaxTokens in interface ChatOptions
      Returns:
      the maximum number of tokens to use for the chat

    • setMaxTokens

      public void setMaxTokens(Integer maxTokens)

    • getLogitBias

      public Map<String,Integer> getLogitBias()

    • setLogitBias

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

    • getUser

      public String getUser()

    • setUser

      public void setUser(String user)

    • getN

      public Integer getN()

    • setN

      public void setN(Integer n)

    • getStopSequences

      public List<String> getStopSequences()
      Description copied from interface: ChatOptions
      Returns the stop sequences to use for the chat.
      Specified by:
      getStopSequences in interface ChatOptions
      Returns:
      the stop sequences to use for the chat

    • setStopSequences

      public void setStopSequences(List<String> stopSequences)

    • getStop

      public List<String> getStop()

    • setStop

      public void setStop(List<String> stop)

    • getPresencePenalty

      public Double getPresencePenalty()
      Description copied from interface: ChatOptions
      Returns the presence penalty to use for the chat.
      Specified by:
      getPresencePenalty in interface ChatOptions
      Returns:
      the presence penalty to use for the chat

    • setPresencePenalty

      public void setPresencePenalty(Double presencePenalty)

    • getFrequencyPenalty

      public Double getFrequencyPenalty()
      Description copied from interface: ChatOptions
      Returns the frequency penalty to use for the chat.
      Specified by:
      getFrequencyPenalty in interface ChatOptions
      Returns:
      the frequency penalty to use for the chat

    • setFrequencyPenalty

      public void setFrequencyPenalty(Double frequencyPenalty)

    • getModel

      public String getModel()
      Description copied from interface: ChatOptions
      Returns the model to use for the chat.
      Specified by:
      getModel in interface ChatOptions
      Returns:
      the model to use for the chat

    • setModel

      public void setModel(String model)

    • getDeploymentName

      public String getDeploymentName()

    • setDeploymentName

      public void setDeploymentName(String deploymentName)

    • getTemperature

      public Double getTemperature()
      Description copied from interface: ChatOptions
      Returns the temperature to use for the chat.
      Specified by:
      getTemperature in interface ChatOptions
      Returns:
      the temperature to use for the chat

    • setTemperature

      public void setTemperature(Double temperature)

    • getTopP

      public Double getTopP()
      Description copied from interface: ChatOptions
      Returns the top P to use for the chat.
      Specified by:
      getTopP in interface ChatOptions
      Returns:
      the top P to use for the chat

    • setTopP

      public void setTopP(Double topP)

    • getFunctionCallbacks

      public List<FunctionCallback> getFunctionCallbacks()
      Description copied from interface: FunctionCallingOptions
      Function Callbacks to be registered with the ChatModel. For Prompt Options the functionCallbacks are automatically enabled for the duration of the prompt execution. For Default Options the FunctionCallbacks are registered but disabled by default. You have to use "functions" property to list the function names from the ChatModel registry to be used in the chat completion requests.
      Specified by:
      getFunctionCallbacks in interface FunctionCallingOptions
      Returns:
      Return the Function Callbacks to be registered with the ChatModel.

    • setFunctionCallbacks

      public void setFunctionCallbacks(List<FunctionCallback> functionCallbacks)
      Description copied from interface: FunctionCallingOptions
      Set the Function Callbacks to be registered with the ChatModel.
      Specified by:
      setFunctionCallbacks in interface FunctionCallingOptions
      Parameters:
      functionCallbacks - the Function Callbacks to be registered with the ChatModel.

    • getFunctions

      public Set<String> getFunctions()
      Specified by:
      getFunctions in interface FunctionCallingOptions
      Returns:
      Set of function names from the ChatModel registry to be used in the next chat completion requests.

    • setFunctions

      public void setFunctions(Set<String> functions)
      Description copied from interface: FunctionCallingOptions
      Set the list of function names from the ChatModel registry to be used in the next chat completion requests.
      Specified by:
      setFunctions in interface FunctionCallingOptions
      Parameters:
      functions - the list of function names from the ChatModel registry to be used in the next chat completion requests.

    • getResponseFormat

      public AzureOpenAiResponseFormat getResponseFormat()

    • setResponseFormat

      public void setResponseFormat(AzureOpenAiResponseFormat responseFormat)

    • getTopK

      public Integer getTopK()
      Description copied from interface: ChatOptions
      Returns the top K to use for the chat.
      Specified by:
      getTopK in interface ChatOptions
      Returns:
      the top K to use for the chat

    • getSeed

      public Long getSeed()

    • setSeed

      public void setSeed(Long seed)

    • isLogprobs

      public Boolean isLogprobs()

    • setLogprobs

      public void setLogprobs(Boolean logprobs)

    • getTopLogProbs

      public Integer getTopLogProbs()

    • setTopLogProbs

      public void setTopLogProbs(Integer topLogProbs)

    • getEnhancements

      public com.azure.ai.openai.models.AzureChatEnhancementConfiguration getEnhancements()

    • setEnhancements

      public void setEnhancements(com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)

    • getProxyToolCalls

      public Boolean getProxyToolCalls()
      Specified by:
      getProxyToolCalls in interface FunctionCallingOptions

    • setProxyToolCalls

      public void setProxyToolCalls(Boolean proxyToolCalls)
      Specified by:
      setProxyToolCalls in interface FunctionCallingOptions

    • getToolContext

      public Map<String,Object> getToolContext()
      Specified by:
      getToolContext in interface FunctionCallingOptions

    • setToolContext

      public void setToolContext(Map<String,Object> toolContext)
      Specified by:
      setToolContext in interface FunctionCallingOptions

    • copy

      public AzureOpenAiChatOptions copy()
      Description copied from interface: ChatOptions
      Returns a copy of this ChatOptions.
      Specified by:
      copy in interface ChatOptions
      Returns:
      a copy of this ChatOptions