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, ChatOptions
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

  • Constructor Details

    • AzureOpenAiChatOptions

      public AzureOpenAiChatOptions()

  • Method Details

    • builder

      public static AzureOpenAiChatOptions.Builder builder()

    • getMaxTokens

      public Integer getMaxTokens()

    • 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)

    • getStop

      public List<String> getStop()

    • setStop

      public void setStop(List<String> stop)

    • getPresencePenalty

      public Double getPresencePenalty()

    • setPresencePenalty

      public void setPresencePenalty(Double presencePenalty)

    • getFrequencyPenalty

      public Double getFrequencyPenalty()

    • setFrequencyPenalty

      public void setFrequencyPenalty(Double frequencyPenalty)

    • getDeploymentName

      public String getDeploymentName()

    • setDeploymentName

      public void setDeploymentName(String deploymentName)

    • getTemperature

      public Float getTemperature()
      Specified by:
      getTemperature in interface ChatOptions

    • setTemperature

      public void setTemperature(Float temperature)

    • getTopP

      public Float getTopP()
      Specified by:
      getTopP in interface ChatOptions

    • setTopP

      public void setTopP(Float topP)

    • getTopK

      public Integer getTopK()
      Specified by:
      getTopK in interface ChatOptions

    • setTopK

      public void setTopK(Integer topK)

    • getFunctionCallbacks

      public List<FunctionCallback> getFunctionCallbacks()
      Description copied from interface: FunctionCallingOptions
      Function Callbacks to be registered with the ChatClient. 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 ChatClient 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 ChatClient.

    • setFunctionCallbacks

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

    • getFunctions

      public Set<String> getFunctions()
      Specified by:
      getFunctions in interface FunctionCallingOptions
      Returns:
      List of function names from the ChatClient 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 ChatClient 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 ChatClient registry to be used in the next chat completion requests.