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

Class OrchestrationChatOptions.Builder

java.lang.Object

com.sap.ai.sdk.orchestration.spring.OrchestrationChatOptions.Builder

All Implemented Interfaces:

Cloneable, org.springframework.ai.chat.prompt.ChatOptions.Builder<OrchestrationChatOptions.Builder>, org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

Enclosing class:

OrchestrationChatOptions

public static final class OrchestrationChatOptions.Builder
extends Object
implements org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

Builder that preserves OrchestrationChatOptions through the Spring AI advisor chain. Spring AI 2.x ChatClient calls mutate().build() to reconstruct the options after passing through advisors; returning OrchestrationChatOptions here ensures the type is not lost.

Since:

1.25.0

Method Summary

Modifier and Type	Method	Description
OrchestrationChatOptions	build()
OrchestrationChatOptions.Builder	clone()
OrchestrationChatOptions.Builder	combineWith(org.springframework.ai.chat.prompt.ChatOptions.Builder<?> other)
OrchestrationChatOptions.Builder	fallbackConfigs(List<OrchestrationModuleConfig> configs)	Sets fallback configs to be used if main config is non-functional.
OrchestrationChatOptions.Builder	frequencyPenalty(Double v)
OrchestrationChatOptions.Builder	maxTokens(Integer v)
OrchestrationChatOptions.Builder	model(String model)
OrchestrationChatOptions.Builder	presencePenalty(Double v)
OrchestrationChatOptions.Builder	stopSequences(List<String> v)
OrchestrationChatOptions.Builder	temperature(Double v)
OrchestrationChatOptions.Builder	toolCallbacks(List<org.springframework.ai.tool.ToolCallback> callbacks)
OrchestrationChatOptions.Builder	toolCallbacks(org.springframework.ai.tool.ToolCallback... callbacks)
OrchestrationChatOptions.Builder	toolContext(String key, Object value)
OrchestrationChatOptions.Builder	toolContext(Map<String,Object> ctx)
OrchestrationChatOptions.Builder	topK(Integer v)
OrchestrationChatOptions.Builder	topP(Double v)

Methods inherited from class java.lang.Object

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

Method Details

clone

@Nonnull
public OrchestrationChatOptions.Builder clone()

Specified by:

clone in interface org.springframework.ai.chat.prompt.ChatOptions.Builder<OrchestrationChatOptions.Builder>

Overrides:

clone in class Object

combineWith

@Nonnull
public OrchestrationChatOptions.Builder combineWith(@Nonnull
 org.springframework.ai.chat.prompt.ChatOptions.Builder<?> other)

Specified by:

combineWith in interface org.springframework.ai.chat.prompt.ChatOptions.Builder<OrchestrationChatOptions.Builder>

toolCallbacks

@Nonnull
public OrchestrationChatOptions.Builder toolCallbacks(@Nonnull
 List<org.springframework.ai.tool.ToolCallback> callbacks)

Specified by:

toolCallbacks in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

toolCallbacks

@Nonnull
public OrchestrationChatOptions.Builder toolCallbacks(@Nonnull
 org.springframework.ai.tool.ToolCallback... callbacks)

Specified by:

toolCallbacks in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

toolContext

@Nonnull
public OrchestrationChatOptions.Builder toolContext(@Nonnull
 Map<String,Object> ctx)

Specified by:

toolContext in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

toolContext

@Nonnull
public OrchestrationChatOptions.Builder toolContext(@Nonnull
 String key,
 @Nonnull
 Object value)

Specified by:

toolContext in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

model

@Nonnull
public OrchestrationChatOptions.Builder model(@Nullable
 String model)

Specified by:

model in interface org.springframework.ai.chat.prompt.ChatOptions.Builder<OrchestrationChatOptions.Builder>

Specified by:

model in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

frequencyPenalty

@Nonnull
public OrchestrationChatOptions.Builder frequencyPenalty(@Nullable
 Double v)

Specified by:

frequencyPenalty in interface org.springframework.ai.chat.prompt.ChatOptions.Builder<OrchestrationChatOptions.Builder>

Specified by:

frequencyPenalty in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

maxTokens

@Nonnull
public OrchestrationChatOptions.Builder maxTokens(@Nullable
 Integer v)

Specified by:

maxTokens in interface org.springframework.ai.chat.prompt.ChatOptions.Builder<OrchestrationChatOptions.Builder>

Specified by:

maxTokens in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

fallbackConfigs

@Nonnull
public OrchestrationChatOptions.Builder fallbackConfigs(@Nullable
 List<OrchestrationModuleConfig> configs)

Sets fallback configs to be used if main config is non-functional.

Parameters:

configs - prioritized list of fallback configs.

Returns:

this builder.

presencePenalty

@Nonnull
public OrchestrationChatOptions.Builder presencePenalty(@Nullable
 Double v)

Specified by:

presencePenalty in interface org.springframework.ai.chat.prompt.ChatOptions.Builder<OrchestrationChatOptions.Builder>

Specified by:

presencePenalty in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

stopSequences

@Nonnull
public OrchestrationChatOptions.Builder stopSequences(@Nullable
 List<String> v)

Specified by:

stopSequences in interface org.springframework.ai.chat.prompt.ChatOptions.Builder<OrchestrationChatOptions.Builder>

Specified by:

stopSequences in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

temperature

@Nonnull
public OrchestrationChatOptions.Builder temperature(@Nullable
 Double v)

Specified by:

temperature in interface org.springframework.ai.chat.prompt.ChatOptions.Builder<OrchestrationChatOptions.Builder>

Specified by:

temperature in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

topK

@Nonnull
public OrchestrationChatOptions.Builder topK(@Nullable
 Integer v)

Specified by:

topK in interface org.springframework.ai.chat.prompt.ChatOptions.Builder<OrchestrationChatOptions.Builder>

Specified by:

topK in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

topP

@Nonnull
public OrchestrationChatOptions.Builder topP(@Nullable
 Double v)

Specified by:

topP in interface org.springframework.ai.chat.prompt.ChatOptions.Builder<OrchestrationChatOptions.Builder>

Specified by:

topP in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>

build

@Nonnull
public OrchestrationChatOptions build()

Specified by:

build in interface org.springframework.ai.chat.prompt.ChatOptions.Builder<OrchestrationChatOptions.Builder>

Specified by:

build in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder<OrchestrationChatOptions.Builder>