Package com.sap.ai.sdk.orchestration

Class OrchestrationModuleConfig

java.lang.Object

com.sap.ai.sdk.orchestration.OrchestrationModuleConfig

public final class OrchestrationModuleConfig
extends Object

Represents the configuration for the orchestration service. Allows for configuring the different modules of the orchestration service via a fluent API.

The orchestration pipeline combines different modules into a single execution flow where the output of one module serves as input for the next. The pipeline consists of the following modules:

• LLM Config (Mandatory)
• Templating (Optional)
• Data Masking (Optional)
• Input Content Filtering (Optional)
• Output Content Filtering (Optional)

SAP AI Core: Orchestration - Orchestration Workflow

Constructor Summary

Constructors

Constructor	Description
OrchestrationModuleConfig(OrchestrationAiModel aiModel)	Creates a new OrchestrationModuleConfig with only the AI Model as parameter.

Method Summary

Modifier and Type	Method	Description
OrchestrationModuleConfig	copy()	Creates a copy of this OrchestrationModuleConfig.
boolean	equals(Object o)
FilteringModuleConfig	getFilteringConfig()	A content filter to filter the prompt.
GroundingModuleConfig	getGroundingConfig()	A grounding configuration to provide additional context to the AI model.
SAPDocumentTranslationInput	getInputTranslationConfig()	Configuration for translating input content before processing.
LLMModelDetails	getLlmConfig()	The configured language model settings.
MaskingModuleConfig	getMaskingConfig()	A masking configuration to pseudonymous or anonymize sensitive data in the input.
SAPDocumentTranslationOutput	getOutputTranslationConfig()	Configuration for translating output content after processing.
int	hashCode()
String	toString()
OrchestrationModuleConfig	withFilteringConfig(FilteringModuleConfig filteringConfig)	A content filter to filter the prompt.
OrchestrationModuleConfig	withGrounding(GroundingProvider groundingProvider)	Creates a new configuration with the given grounding configuration.
OrchestrationModuleConfig	withGroundingConfig(GroundingModuleConfig groundingConfig)	A grounding configuration to provide additional context to the AI model.
OrchestrationModuleConfig	withInputFiltering(ContentFilter contentFilter, ContentFilter... contentFilters)	Adds input content filters to the orchestration configuration.
OrchestrationModuleConfig	withInputTranslationConfig(SAPDocumentTranslationInput inputTranslationConfig)	Configuration for translating input content before processing.
OrchestrationModuleConfig	withInputTranslationConfig(TranslationConfig.Input translationConfig)	Configure input translation using a high-level TranslationConfig.
OrchestrationModuleConfig	withLlmConfig(LLMModelDetails llmConfig)	The configured language model settings.
OrchestrationModuleConfig	withLlmConfig(OrchestrationAiModel aiModel)	Creates a new configuration with the given LLM configuration.
OrchestrationModuleConfig	withMaskingConfig(MaskingProvider maskingProvider, MaskingProvider... maskingProviders)	Creates a new configuration with the given Data Masking configuration.
OrchestrationModuleConfig	withMaskingConfig(MaskingModuleConfig maskingConfig)	A masking configuration to pseudonymous or anonymize sensitive data in the input.
OrchestrationModuleConfig	withOutputFiltering(ContentFilter contentFilter, ContentFilter... contentFilters)	Adds output content filters to the orchestration configuration.
OrchestrationModuleConfig	withOutputTranslationConfig(SAPDocumentTranslationOutput outputTranslationConfig)	Configuration for translating output content after processing.
OrchestrationModuleConfig	withOutputTranslationConfig(TranslationConfig.Output translationConfig)	Configure output translation using a high-level TranslationConfig.
OrchestrationModuleConfig	withStreamConfig(OrchestrationStreamConfig config)	Creates a new configuration with the given stream configuration.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OrchestrationModuleConfig

public OrchestrationModuleConfig(@Nonnull
 OrchestrationAiModel aiModel)

Creates a new OrchestrationModuleConfig with only the AI Model as parameter.

Parameters:

aiModel - name of the AI Model

Method Details

withLlmConfig

@Nonnull
public OrchestrationModuleConfig withLlmConfig(@Nonnull
 OrchestrationAiModel aiModel)

Creates a new configuration with the given LLM configuration.

SAP AI Core: Orchestration - Model Configuration

Parameters:

aiModel - the LLM configuration to use.

Returns:

a new configuration with the given LLM configuration.

withStreamConfig

@Nonnull
public OrchestrationModuleConfig withStreamConfig(@Nonnull
 OrchestrationStreamConfig config)

Creates a new configuration with the given stream configuration.

Parameters:

config - the stream configuration to use.

Returns:

a new configuration with the given stream configuration.

Since:

1.12.0

withMaskingConfig

@Nonnull
public OrchestrationModuleConfig withMaskingConfig(@Nonnull
 MaskingProvider maskingProvider,
 @Nonnull
 MaskingProvider... maskingProviders)

Creates a new configuration with the given Data Masking configuration.

SAP AI Core: Orchestration - Data Masking

Parameters:

maskingProvider - the Data Masking configuration to use.

maskingProviders - additional Data Masking configurations to use.

Returns:

a new configuration with the given Data Masking configuration.

withInputFiltering

@Nonnull
public OrchestrationModuleConfig withInputFiltering(@Nonnull
 ContentFilter contentFilter,
 @Nonnull
 ContentFilter... contentFilters)

Adds input content filters to the orchestration configuration.

Preferred over withFilteringConfig(FilteringModuleConfig) for adding input filters.

SAP AI Core: Orchestration - Input Filtering

Parameters:

contentFilter - a filter to apply to the input.

contentFilters - zero or more additional content filters to apply to the input.

Returns:

a new OrchestrationModuleConfig instance with the specified input filters added.

withOutputFiltering

@Nonnull
public OrchestrationModuleConfig withOutputFiltering(@Nonnull
 ContentFilter contentFilter,
 @Nonnull
 ContentFilter... contentFilters)

Adds output content filters to the orchestration configuration.

Preferred over withFilteringConfig(FilteringModuleConfig) for adding output filters.

SAP AI Core: Orchestration - Output Filtering

Parameters:

contentFilter - a filter to apply to the input.

contentFilters - zero or more additional content filters to apply to the input.

Returns:

a new OrchestrationModuleConfig instance with the specified output filters added.

withGrounding

@Nonnull
public OrchestrationModuleConfig withGrounding(@Nonnull
 GroundingProvider groundingProvider)

Creates a new configuration with the given grounding configuration.

SAP AI Core: Orchestration - Grounding

Parameters:

groundingProvider - the grounding configuration to use.

Returns:

a new configuration with the given grounding configuration.

withInputTranslationConfig

@Nonnull
public OrchestrationModuleConfig withInputTranslationConfig(@Nonnull
 TranslationConfig.Input translationConfig)

Configure input translation using a high-level TranslationConfig.

Parameters:

translationConfig - the translation configuration.

Returns:

a new OrchestrationModuleConfig with input translation configured.

withOutputTranslationConfig

@Nonnull
public OrchestrationModuleConfig withOutputTranslationConfig(@Nonnull
 TranslationConfig.Output translationConfig)

Configure output translation using a high-level TranslationConfig.

Parameters:

translationConfig - the translation configuration.

Returns:

a new OrchestrationModuleConfig with output translation configured.

copy

@Nonnull
public OrchestrationModuleConfig copy()

Creates a copy of this OrchestrationModuleConfig.

Returns:

a copy of this OrchestrationModuleConfig.

getLlmConfig

@Nonnull
public LLMModelDetails getLlmConfig()

The configured language model settings. This configuration is required when executing requests.

SAP AI Core: Orchestration - Model Configuration

getMaskingConfig

@Nullable
public MaskingModuleConfig getMaskingConfig()

A masking configuration to pseudonymous or anonymize sensitive data in the input.

SAP AI Core: Orchestration - Data Masking

getFilteringConfig

@Nullable
public FilteringModuleConfig getFilteringConfig()

A content filter to filter the prompt.

SAP AI Core: Orchestration - Input Filtering

SAP AI Core: Orchestration - Output Filtering

getGroundingConfig

@Nullable
public GroundingModuleConfig getGroundingConfig()

A grounding configuration to provide additional context to the AI model.

SAP AI Core: Orchestration -

Since:

1.1.0

getInputTranslationConfig

@Nullable
public SAPDocumentTranslationInput getInputTranslationConfig()

Configuration for translating input content before processing.

SAP AI Core: Orchestration - Input Translation

Since:

1.8.0

getOutputTranslationConfig

@Nullable
public SAPDocumentTranslationOutput getOutputTranslationConfig()

Configuration for translating output content after processing.

SAP AI Core: Orchestration - Output Translation

Since:

1.8.0

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

withLlmConfig

public OrchestrationModuleConfig withLlmConfig(@Nonnull
 LLMModelDetails llmConfig)

The configured language model settings. This configuration is required when executing requests.

SAP AI Core: Orchestration - Model Configuration

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withMaskingConfig

public OrchestrationModuleConfig withMaskingConfig(@Nullable
 MaskingModuleConfig maskingConfig)

A masking configuration to pseudonymous or anonymize sensitive data in the input.

SAP AI Core: Orchestration - Data Masking

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withFilteringConfig

public OrchestrationModuleConfig withFilteringConfig(@Nullable
 FilteringModuleConfig filteringConfig)

A content filter to filter the prompt.

SAP AI Core: Orchestration - Input Filtering

SAP AI Core: Orchestration - Output Filtering

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withGroundingConfig

public OrchestrationModuleConfig withGroundingConfig(@Nullable
 GroundingModuleConfig groundingConfig)

A grounding configuration to provide additional context to the AI model.

SAP AI Core: Orchestration -

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

Since:

1.1.0

withInputTranslationConfig

public OrchestrationModuleConfig withInputTranslationConfig(@Nullable
 SAPDocumentTranslationInput inputTranslationConfig)

Configuration for translating input content before processing.

SAP AI Core: Orchestration - Input Translation

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

Since:

1.8.0

withOutputTranslationConfig

public OrchestrationModuleConfig withOutputTranslationConfig(@Nullable
 SAPDocumentTranslationOutput outputTranslationConfig)

Configuration for translating output content after processing.

SAP AI Core: Orchestration - Output Translation

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

Since:

1.8.0