Package com.sap.ai.sdk.orchestration.spring

Class OrchestrationChatOptions

java.lang.Object
com.sap.ai.sdk.orchestration.spring.OrchestrationChatOptions
All Implemented Interfaces:
org.springframework.ai.chat.prompt.ChatOptions, org.springframework.ai.model.ModelOptions, org.springframework.ai.model.tool.ToolCallingChatOptions
public class OrchestrationChatOptions extends Object implements org.springframework.ai.model.tool.ToolCallingChatOptions
Configuration to be used for orchestration requests.
Since:
1.2.0

  • Constructor Details

  • Method Details

    • getModel

      @Nonnull public String getModel()
      Returns the model to use for the chat.
      Specified by:
      getModel in interface org.springframework.ai.chat.prompt.ChatOptions
      Returns:
      the model to use for the chat.
      See Also:

    • getModelVersion

      @Nonnull public String getModelVersion()
      Returns the model version to use for the chat. "latest" by default.
      Returns:
      the model version to use for the chat.

    • getFrequencyPenalty

      @Nullable public Double getFrequencyPenalty()
      Returns the frequency penalty to use for the chat.
      Specified by:
      getFrequencyPenalty in interface org.springframework.ai.chat.prompt.ChatOptions
      Returns:
      the frequency penalty to use for the chat.

    • getMaxTokens

      @Nullable public Integer getMaxTokens()
      Returns the maximum number of tokens to use for the chat.
      Specified by:
      getMaxTokens in interface org.springframework.ai.chat.prompt.ChatOptions
      Returns:
      the maximum number of tokens to use for the chat.

    • getPresencePenalty

      @Nullable public Double getPresencePenalty()
      Returns the presence penalty to use for the chat.
      Specified by:
      getPresencePenalty in interface org.springframework.ai.chat.prompt.ChatOptions
      Returns:
      the presence penalty to use for the chat.

    • getStopSequences

      @Nullable public List<String> getStopSequences()
      Returns the stop sequences to use for the chat.
      Specified by:
      getStopSequences in interface org.springframework.ai.chat.prompt.ChatOptions
      Returns:
      the stop sequences to use for the chat.

    • getTemperature

      @Nullable public Double getTemperature()
      Returns the temperature to use for the chat.
      Specified by:
      getTemperature in interface org.springframework.ai.chat.prompt.ChatOptions
      Returns:
      the temperature to use for the chat.

    • getTopK

      @Nullable public Integer getTopK()
      Returns the top K to use for the chat.
      Specified by:
      getTopK in interface org.springframework.ai.chat.prompt.ChatOptions
      Returns:
      the top K to use for the chat.

    • getTopP

      @Nullable public Double getTopP()
      Returns the top P to use for the chat.
      Specified by:
      getTopP in interface org.springframework.ai.chat.prompt.ChatOptions
      Returns:
      the top P to use for the chat.

    • mutate

      @Nonnull public OrchestrationChatOptions.Builder mutate()
      Specified by:
      mutate in interface org.springframework.ai.chat.prompt.ChatOptions
      Specified by:
      mutate in interface org.springframework.ai.model.tool.ToolCallingChatOptions

    • getConfigWithCallbacks

      @Nonnull public OrchestrationModuleConfig getConfigWithCallbacks()
      Returns the config with any tool callbacks converted and injected into the template.
      Returns:
      the config enriched with tool definitions from getToolCallbacks()

    • getConfig

      @Nonnull public OrchestrationModuleConfig getConfig()

    • getFallbackConfigs

      @Nonnull public List<OrchestrationModuleConfig> getFallbackConfigs()

    • getToolCallbacks

      @Nonnull public List<org.springframework.ai.tool.ToolCallback> getToolCallbacks()
      Specified by:
      getToolCallbacks in interface org.springframework.ai.model.tool.ToolCallingChatOptions

    • getToolNames

      @Nonnull public Set<String> getToolNames()

    • getToolContext

      @Nonnull public Map<String,Object> getToolContext()
      Specified by:
      getToolContext in interface org.springframework.ai.model.tool.ToolCallingChatOptions

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object