Package org.springframework.ai.model.function

Class FunctionCallingOptionsBuilder.PortableFunctionCallingOptions

java.lang.Object
org.springframework.ai.model.function.FunctionCallingOptionsBuilder.PortableFunctionCallingOptions
All Implemented Interfaces:
ChatOptions, FunctionCallingOptions, ModelOptions
Enclosing class:
FunctionCallingOptionsBuilder
@Deprecated(forRemoval=true, since="1.0.0-M5") public static class FunctionCallingOptionsBuilder.PortableFunctionCallingOptions extends Object implements FunctionCallingOptions
Deprecated, for removal: This API element is subject to removal in a future version.
use DefaultFunctionCallingOptions instead.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.springframework.ai.model.function.FunctionCallingOptions

    FunctionCallingOptions.Builder

  • Constructor Summary

    Constructors
    Constructor
    Description
    PortableFunctionCallingOptions()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static FunctionCallingOptionsBuilder
    builder()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new ChatOptions.Builder to create the default ChatOptions.
    ChatOptions
    copy()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a copy of this ChatOptions.
    Double
    getFrequencyPenalty()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the frequency penalty to use for the chat.
    List<FunctionCallback>
    getFunctionCallbacks()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Function Callbacks to be registered with the ChatModel.
    Set<String>
    getFunctions()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Integer
    getMaxTokens()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the maximum number of tokens to use for the chat.
    String
    getModel()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the model to use for the chat.
    Double
    getPresencePenalty()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the presence penalty to use for the chat.
    Boolean
    getProxyToolCalls()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<String>
    getStopSequences()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the stop sequences to use for the chat.
    Double
    getTemperature()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the temperature to use for the chat.
    Map<String,Object>
    getToolContext()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Integer
    getTopK()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the top K to use for the chat.
    Double
    getTopP()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the top P to use for the chat.
    FunctionCallingOptionsBuilder.PortableFunctionCallingOptions
    merge(ChatOptions options)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FunctionCallingOptionsBuilder.PortableFunctionCallingOptions
    merge(FunctionCallingOptions options)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setFrequencyPenalty(Double frequencyPenalty)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setFunctionCallbacks(List<FunctionCallback> functionCallbacks)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the Function Callbacks to be registered with the ChatModel.
    void
    setFunctions(Set<String> functions)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the list of function names from the ChatModel registry to be used in the next chat completion requests.
    void
    setMaxTokens(Integer maxTokens)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setModel(String model)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setPresencePenalty(Double presencePenalty)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setProxyToolCalls(Boolean proxyToolCalls)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setStopSequences(List<String> stopSequences)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setTemperature(Double temperature)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setToolContext(Map<String,Object> context)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setTopK(Integer topK)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setTopP(Double topP)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PortableFunctionCallingOptions

      public PortableFunctionCallingOptions()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • builder

      public static FunctionCallingOptionsBuilder builder()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ChatOptions
      Creates a new ChatOptions.Builder to create the default ChatOptions.
      Returns:
      Returns DefaultFunctionCallingOptionsBuilder to create a new instance of FunctionCallingOptions.

    • getFunctionCallbacks

      public List<FunctionCallback> getFunctionCallbacks()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

    • getModel

      public String getModel()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getFrequencyPenalty

      public Double getFrequencyPenalty()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getMaxTokens

      public Integer getMaxTokens()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getPresencePenalty

      public Double getPresencePenalty()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getStopSequences

      public List<String> getStopSequences()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTemperature

      public Double getTemperature()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTopK

      public Integer getTopK()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • setTopK

      public void setTopK(Integer topK)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTopP

      public Double getTopP()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getProxyToolCalls

      public Boolean getProxyToolCalls()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getProxyToolCalls in interface FunctionCallingOptions

    • setProxyToolCalls

      public void setProxyToolCalls(Boolean proxyToolCalls)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      setProxyToolCalls in interface FunctionCallingOptions

    • getToolContext

      public Map<String,Object> getToolContext()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getToolContext in interface FunctionCallingOptions

    • setToolContext

      public void setToolContext(Map<String,Object> context)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      setToolContext in interface FunctionCallingOptions

    • copy

      public ChatOptions copy()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ChatOptions
      Returns a copy of this ChatOptions.
      Specified by:
      copy in interface ChatOptions
      Returns:
      a copy of this ChatOptions

    • merge

      public FunctionCallingOptionsBuilder.PortableFunctionCallingOptions merge(FunctionCallingOptions options)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • merge

      public FunctionCallingOptionsBuilder.PortableFunctionCallingOptions merge(ChatOptions options)
      Deprecated, for removal: This API element is subject to removal in a future version.