Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions .pipeline/checkstyle.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,8 @@
<!--<module name="RequireEmptyLineBeforeBlockTagGroup" />-->
<!--<module name="JavadocContentLocation" />-->

<module name="JavadocStyle">
<property name="scope" value="protected"/>
<property name="checkEmptyJavadoc" value="true"/>
<property name="checkFirstSentence" value="false"/>
<module name="SummaryJavadoc">
<property name="period" value=""/>
<property name="severity" value="info"/>
</module>
<module name="MissingJavadocMethod">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,11 @@
* .selfHarm(AzureFilterThreshold.ALLOW_SAFE_LOW);
* }</pre>
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP AI
* Core: Orchestration - Input Filtering</a>
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
* AI Core: Orchestration - Output Filtering</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP
* AI Core: Orchestration - Input Filtering</a>
*
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
* AI Core: Orchestration - Output Filtering</a>
*/
@Setter
@NoArgsConstructor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@
* Interface representing convenience wrappers of serializable content filter that defines
* thresholds for different content categories.
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP AI
* Core: Orchestration - Input Filtering</a>
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
* AI Core: Orchestration - Output Filtering</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP
* AI Core: Orchestration - Input Filtering</a>
*
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
* AI Core: Orchestration - Output Filtering</a>
*/
public interface ContentFilter {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
* SAP Data Privacy Integration (DPI) can mask personally identifiable information using either
* anonymization or pseudonymization.
*
* @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP
* AI Core: Orchestration - Data Masking</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP AI
* Core: Orchestration - Data Masking</a>
*/
@Value
@Getter(AccessLevel.PACKAGE)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
* processes. This data supplements the natural language processing capabilities of pre-trained
* models, which are trained on general material.
*
* @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/grounding">SAP AI
* Core: Orchestration - Grounding</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/grounding">SAP AI
* Core: Orchestration - Grounding</a>
*/
@Accessors(fluent = true)
public class Grounding implements GroundingProvider {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
/**
* Interface for grounding configurations.
*
* @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/grounding">SAP AI
* Core: Orchestration - Grounding</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/grounding">SAP AI
* Core: Orchestration - Grounding</a>
*/
@FunctionalInterface
public interface GroundingProvider {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,11 @@
* val filterConfig = new LlamaGuardFilter().config(config);
* }</pre>
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP AI
* Core: Orchestration - Input Filtering</a>
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
* AI Core: Orchestration - Output Filtering</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP
* AI Core: Orchestration - Input Filtering</a>
*
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
* AI Core: Orchestration - Output Filtering</a>
*/
@Accessors(fluent = true)
@Setter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
/**
* Interface for masking configurations.
*
* @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP
* AI Core: Orchestration - Data Masking</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP AI
* Core: Orchestration - Data Masking</a>
*/
public interface MaskingProvider {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ public class OrchestrationAiModel {
* "presence_penalty", 0)
* }</pre>
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/harmonized-api">SAP
* AI Core: Orchestration - Harmonized API</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/harmonized-api">SAP
* AI Core: Orchestration - Harmonized API</a>
*/
Map<String, Object> params;

Expand Down Expand Up @@ -517,7 +516,7 @@ LLMModelDetails createConfig() {
* @param key the parameter key.
* @param value the parameter value, nullable.
* @return A new model with the additional parameter.
* @link <a
* <p><a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/harmonized-api">SAP
* AI Core: Orchestration - Harmonized API</a>
*/
Expand All @@ -535,7 +534,7 @@ public OrchestrationAiModel withParam(@Nonnull final String key, @Nullable final
* @param value the parameter value, nullable.
* @param <ValueT> the parameter value type.
* @return A new model with the additional parameter.
* @link <a
* <p><a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/harmonized-api">SAP
* AI Core: Orchestration - Harmonized API</a>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@
* <li>Output Content Filtering (Optional)
* </ul>
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/orchestration-workflow">
* SAP AI Core: Orchestration - Orchestration Workflow</a>
* <p><a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/orchestration-workflow">SAP
* AI Core: Orchestration - Orchestration Workflow</a>
*/
@Value
@With
Expand All @@ -54,9 +54,9 @@ public class OrchestrationModuleConfig {
/**
* The configured language model settings. This configuration is required when executing requests.
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/model-configuration">
* SAP AI Core: Orchestration - Model Configuration</a>
* <p><a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/model-configuration">SAP
* AI Core: Orchestration - Model Configuration</a>
*/
@SuppressWarnings({"PMD.LombokGetterSetterExposesModelType", "PMD.LombokWithExposesModelType"})
@Nullable
Expand All @@ -66,8 +66,8 @@ public class OrchestrationModuleConfig {
* A template to be populated with input parameters. Upon request execution, this template will be
* enhanced with any messages and parameter values from {@link OrchestrationPrompt}.
*
* @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/templating">SAP
* AI Core: Orchestration - Templating</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/templating">SAP AI
* Core: Orchestration - Templating</a>
*/
@SuppressWarnings({"PMD.LombokGetterSetterExposesModelType", "PMD.LombokWithExposesModelType"})
@Nullable
Expand All @@ -76,9 +76,8 @@ public class OrchestrationModuleConfig {
/**
* A masking configuration to pseudonymous or anonymize sensitive data in the input.
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP AI
* Core: Orchestration - Data Masking</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP
* AI Core: Orchestration - Data Masking</a>
*/
@SuppressWarnings({"PMD.LombokGetterSetterExposesModelType", "PMD.LombokWithExposesModelType"})
@Nullable
Expand All @@ -87,12 +86,13 @@ public class OrchestrationModuleConfig {
/**
* A content filter to filter the prompt.
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP
* AI Core: Orchestration - Input Filtering</a>
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
* AI Core: Orchestration - Output Filtering</a>
* <p><a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP AI
* Core: Orchestration - Input Filtering</a>
*
* <p><a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP AI
* Core: Orchestration - Output Filtering</a>
*/
@SuppressWarnings({"PMD.LombokGetterSetterExposesModelType", "PMD.LombokWithExposesModelType"})
@Nullable
Expand All @@ -101,8 +101,9 @@ public class OrchestrationModuleConfig {
/**
* A grounding configuration to provide additional context to the AI model.
*
* @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/grounding">SAP
* AI Core: Orchestration - </a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/grounding">SAP AI
* Core: Orchestration - </a>
*
* @since 1.1.0
*/
@SuppressWarnings({"PMD.LombokGetterSetterExposesModelType", "PMD.LombokWithExposesModelType"})
Expand All @@ -112,9 +113,10 @@ public class OrchestrationModuleConfig {
/**
* Configuration for translating input content before processing.
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/enhance-model-consumption-with-translation">
* SAP AI Core: Orchestration - Input Translation</a>
* <p><a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/enhance-model-consumption-with-translation">
* SAP AI Core: Orchestration - Input Translation</a>
*
* @since 1.8.0
*/
@SuppressWarnings({"PMD.LombokGetterSetterExposesModelType", "PMD.LombokWithExposesModelType"})
Expand All @@ -124,9 +126,10 @@ public class OrchestrationModuleConfig {
/**
* Configuration for translating output content after processing.
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/enhance-model-consumption-with-output-translation">
* SAP AI Core: Orchestration - Output Translation</a>
* <p><a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/enhance-model-consumption-with-output-translation">
* SAP AI Core: Orchestration - Output Translation</a>
*
* @since 1.8.0
*/
@SuppressWarnings({"PMD.LombokGetterSetterExposesModelType", "PMD.LombokWithExposesModelType"})
Expand All @@ -148,9 +151,10 @@ public class OrchestrationModuleConfig {
/**
* Creates a new configuration with the given LLM configuration.
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/model-configuration">
* SAP AI Core: Orchestration - Model Configuration</a>
* <p><a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/model-configuration">SAP
* AI Core: Orchestration - Model Configuration</a>
*
* @param aiModel The LLM configuration to use.
* @return A new configuration with the given LLM configuration.
*/
Expand All @@ -177,9 +181,9 @@ public OrchestrationModuleConfig withStreamConfig(
/**
* Creates a new configuration with the given Data Masking configuration.
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP AI
* Core: Orchestration - Data Masking</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP
* AI Core: Orchestration - Data Masking</a>
*
* @param maskingProvider The Data Masking configuration to use.
* @param maskingProviders Additional Data Masking configurations to use.
* @return A new configuration with the given Data Masking configuration.
Expand All @@ -202,9 +206,10 @@ public OrchestrationModuleConfig withMaskingConfig(
*
* <p>Preferred over {@link #withFilteringConfig(FilteringModuleConfig)} for adding input filters.
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP
* AI Core: Orchestration - Input Filtering</a>
* <p><a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP AI
* Core: Orchestration - Input Filtering</a>
*
* @param contentFilter a filter to apply to the input.
* @param contentFilters zero or more additional content filters to apply to the input.
* @return a new {@code OrchestrationModuleConfig} instance with the specified input filters
Expand Down Expand Up @@ -240,9 +245,10 @@ public OrchestrationModuleConfig withInputFiltering(
* <p>Preferred over {@link #withFilteringConfig(FilteringModuleConfig)} for adding output
* filters.
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
* AI Core: Orchestration - Output Filtering</a>
* <p><a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP AI
* Core: Orchestration - Output Filtering</a>
*
* @param contentFilter a filter to apply to the input.
* @param contentFilters zero or more additional content filters to apply to the input.
* @return a new {@code OrchestrationModuleConfig} instance with the specified output filters
Expand Down Expand Up @@ -305,8 +311,9 @@ OrchestrationModuleConfig withOutputFilteringStreamOptions(
/**
* Creates a new configuration with the given grounding configuration.
*
* @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/grounding">SAP
* AI Core: Orchestration - Grounding</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/grounding">SAP AI
* Core: Orchestration - Grounding</a>
*
* @param groundingProvider The grounding configuration to use.
* @return A new configuration with the given grounding configuration.
*/
Expand All @@ -319,8 +326,9 @@ public OrchestrationModuleConfig withGrounding(
/**
* Creates a new configuration with the given template configuration as {@link TemplateConfig}.
*
* @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/templating">SAP
* AI Core: Orchestration - Templating</a>
* <p><a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/templating">SAP AI
* Core: Orchestration - Templating</a>
*
* @param templateConfig The template configuration to use.
* @return A new configuration with the given template configuration.
* @since 1.4.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@
/**
* Configuration helper for SAP Document Translation.
*
* @link <a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/sap-document-translation">SAP
* AI Core: Orchestration - SAP Document Translation</a>
* <p><a
* href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/sap-document-translation">SAP
* AI Core: Orchestration - SAP Document Translation</a>
*
* @since 1.14.0
*/
public interface TranslationConfig {
Expand Down Expand Up @@ -179,7 +180,7 @@ SAPDocumentTranslationOutput createSAPDocumentTranslationOutput() {
* Create a new input translation configuration.
*
* @param targetLanguage The target language code
* @link <a
* <p><a
* href="https://help.sap.com/docs/translation-hub/sap-translation-hub/supported-languages">SAP
* AI Core: Orchestration - SAP Translation Hub Table with official languages</a>
* @return A TranslationConfig configured for input translation
Expand All @@ -193,7 +194,7 @@ static TranslationConfig.Input translateInputTo(@Nonnull final String targetLang
* Create a new output translation configuration.
*
* @param targetLanguage The target language code
* @link <a
* <p><a
* href="https://help.sap.com/docs/translation-hub/sap-translation-hub/supported-languages">
* SAP AI Core: Orchestration - SAP Translation Hub Table with official languages</a>
* @return A TranslationConfig configured for output translation
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
<wiremock.version>3.13.2</wiremock.version>
<assertj-core.version>3.27.7</assertj-core.version>
<slf4j.version>2.0.17</slf4j.version>
<checkstyle.version>13.8.0</checkstyle.version>
<checkstyle.version>14.0.0</checkstyle.version>
<system-stubs.version>2.1.3</system-stubs.version>
<surefire.version>3.5.6</surefire.version>
<spring-ai.version>1.1.8</spring-ai.version>
Expand Down