Skip to content

Commit 82f0aee

Browse files
committed
Add links to orchestration doc in javadocs.
1 parent 59bc45e commit 82f0aee

File tree

5 files changed

+69
-3
lines changed

5 files changed

+69
-3
lines changed

orchestration/src/main/java/com/sap/ai/sdk/orchestration/AzureContentFilter.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@
2121
* .hate(AzureFilterThreshold.ALLOW_SAFE)
2222
* .selfHarm(AzureFilterThreshold.ALLOW_SAFE_LOW);
2323
* }</pre>
24+
*
25+
* @link <a
26+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP
27+
* AI Core: Orchestration - Input Filtering</a>
28+
* @link <a
29+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
30+
* AI Core: Orchestration - Output Filtering</a>
2431
*/
2532
@Setter
2633
@NoArgsConstructor

orchestration/src/main/java/com/sap/ai/sdk/orchestration/ContentFilter.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@
66
/**
77
* Interface representing convenience wrappers of serializable content filter that defines
88
* thresholds for different content categories.
9+
*
10+
* @link <a
11+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP
12+
* AI Core: Orchestration - Input Filtering</a>
13+
* @link <a
14+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
15+
* AI Core: Orchestration - Output Filtering</a>
916
*/
1017
public interface ContentFilter {
1118

orchestration/src/main/java/com/sap/ai/sdk/orchestration/DpiMasking.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
/**
2222
* SAP Data Privacy Integration (DPI) can mask personally identifiable information using either
2323
* anonymization or pseudonymization.
24+
*
25+
* @link <a
26+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP
27+
* AI Core: Orchestration - Data Masking</a>
2428
*/
2529
@Value
2630
@Getter(AccessLevel.PACKAGE)

orchestration/src/main/java/com/sap/ai/sdk/orchestration/MaskingProvider.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,12 @@
33
import com.sap.ai.sdk.orchestration.model.MaskingProviderConfig;
44
import javax.annotation.Nonnull;
55

6-
/** Interface for masking configurations. */
6+
/** Interface for masking configurations.
7+
*
8+
* @link <a
9+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP
10+
* AI Core: Orchestration - Data Masking</a>
11+
*/
712
public interface MaskingProvider {
813

914
/**

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationModuleConfig.java

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@
3434
* <li>Input Content Filtering (Optional)
3535
* <li>Output Content Filtering (Optional)
3636
* </ul>
37+
*
38+
* @link <a
39+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/orchestration-workflow">
40+
* SAP AI Core: Orchestration - Orchestration Workflow</a>
3741
*/
3842
@Value
3943
@With
@@ -42,24 +46,51 @@
4246
public class OrchestrationModuleConfig {
4347
/**
4448
* The configured language model settings. This configuration is required when executing requests.
49+
*
50+
* @link <a
51+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/model-configuration">
52+
* SAP AI Core: Orchestration - Model Configuration</a>
4553
*/
4654
@Nullable LLMModuleConfig llmConfig;
4755

4856
/**
4957
* A template to be populated with input parameters. Upon request execution, this template will be
5058
* enhanced with any messages and parameter values from {@link OrchestrationPrompt}.
59+
*
60+
* @link <a
61+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/templating">SAP
62+
* AI Core: Orchestration - Templating</a>
5163
*/
5264
@Nullable TemplatingModuleConfig templateConfig;
5365

54-
/** A masking configuration to pseudonymous or anonymize sensitive data in the input. */
66+
/**
67+
* A masking configuration to pseudonymous or anonymize sensitive data in the input.
68+
*
69+
* @link <a
70+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP
71+
* AI Core: Orchestration - Data Masking</a>
72+
* */
5573
@Nullable MaskingModuleConfig maskingConfig;
5674

57-
/** A content filter to filter the prompt. */
75+
/**
76+
* A content filter to filter the prompt.
77+
*
78+
* @link <a
79+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP
80+
* AI Core: Orchestration - Input Filtering</a>
81+
* @link <a
82+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
83+
* AI Core: Orchestration - Output Filtering</a>
84+
* */
5885
@Nullable FilteringModuleConfig filteringConfig;
5986

6087
/**
6188
* Creates a new configuration with the given LLM configuration.
6289
*
90+
* @link <a
91+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/model-configuration">
92+
* SAP AI Core: Orchestration - Model Configuration</a>
93+
*
6394
* @param aiModel The LLM configuration to use.
6495
* @return A new configuration with the given LLM configuration.
6596
*/
@@ -72,6 +103,10 @@ public OrchestrationModuleConfig withLlmConfig(@Nonnull final OrchestrationAiMod
72103
/**
73104
* Creates a new configuration with the given Data Masking configuration.
74105
*
106+
* @link <a
107+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP
108+
* AI Core: Orchestration - Data Masking</a>
109+
*
75110
* @param maskingProvider The Data Masking configuration to use.
76111
* @param maskingProviders Additional Data Masking configurations to use.
77112
* @return A new configuration with the given Data Masking configuration.
@@ -94,6 +129,10 @@ public OrchestrationModuleConfig withMaskingConfig(
94129
*
95130
* <p>Preferred over {@link #withFilteringConfig(FilteringModuleConfig)} for adding input filters.
96131
*
132+
* @link <a
133+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP
134+
* AI Core: Orchestration - Input Filtering</a>
135+
*
97136
* @param contentFilters one or more content filters to apply to the input.
98137
* @return a new {@code OrchestrationModuleConfig} instance with the specified input filters
99138
* added.
@@ -125,6 +164,10 @@ public OrchestrationModuleConfig withInputFiltering(
125164
* <p>Preferred over {@link #withFilteringConfig(FilteringModuleConfig)} for adding output
126165
* filters.
127166
*
167+
* @link <a
168+
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
169+
* AI Core: Orchestration - Output Filtering</a>
170+
*
128171
* @param contentFilters one or more content filters to apply to the output.
129172
* @return a new {@code OrchestrationModuleConfig} instance with the specified output filters
130173
* added.

0 commit comments

Comments
 (0)