feat: Add grounding convenience function

.changeset/shiny-brooms-punch.md

@@ -0,0 +1,5 @@
+---
+'@sap-ai-sdk/orchestration': minor
+---
+
+[Improvement] Add convenience function for creating document grounding configuration

packages/orchestration/README.md

@@ -327,6 +327,23 @@ const response = await orchestrationClient.chatCompletion({
 return response.getContent();
 ```
 
+`buildDocumentGroundingConfig` function provides convenience to create the document grounding service configuration using the minimal set of required values:
+
+```ts
+import {
+  buildDocumentGroundingConfig
+} from '@sap-ai-sdk/orchestration';
+
+const orchestrationConfig: {
+  ...,
+  grounding: buildDocumentGroundingConfig(
+    input_params: ['groundingInput'],
+    output_param: 'groundingOutput',
+    filters: [{id: 'filter-id', data_repositories: ['repository-id'],}]
+    )
+}
+```
+
 ### Using a JSON Configuration from AI Launchpad
 
 If you already have an orchestration workflow created in AI Launchpad, you can either download the configuration as a JSON file or copy the JSON string directly to use it with the orchestration client.

packages/orchestration/src/index.ts

@@ -37,12 +37,17 @@ export type {
 export type {
   OrchestrationModuleConfig,
   LlmModuleConfig,
-  Prompt
+  Prompt,
+  DocumentGroundingServiceConfig,
+  DocumentGroundingServiceFilter
 } from './orchestration-types.js';
 
 export { OrchestrationClient } from './orchestration-client.js';
 
-export { buildAzureContentFilter } from './orchestration-filter-utility.js';
+export {
+  buildAzureContentFilter,
+  buildDocumentGroundingConfig
+} from './orchestration-util.js';
 
 export { OrchestrationResponse } from './orchestration-response.js';
 

packages/orchestration/src/internal.ts

@@ -1,4 +1,4 @@
 export * from './orchestration-client.js';
-export * from './orchestration-filter-utility.js';
+export * from './orchestration-util.js';
 export * from './orchestration-types.js';
 export * from './orchestration-response.js';

packages/orchestration/src/orchestration-client.test.ts

@@ -10,7 +10,7 @@ import {
   constructCompletionPostRequest,
   OrchestrationClient
 } from './orchestration-client.js';
-import { buildAzureContentFilter } from './orchestration-filter-utility.js';
+import { buildAzureContentFilter } from './orchestration-util.js';
 import { OrchestrationResponse } from './orchestration-response.js';
 import type { CompletionPostResponse } from './client/api/schema/index.js';
 import type {

packages/orchestration/src/orchestration-completion-post-request.test.ts

@@ -1,6 +1,6 @@
 import { constructCompletionPostRequest } from './orchestration-client.js';
-import { buildAzureContentFilter } from './orchestration-filter-utility.js';
-import type { CompletionPostRequest } from './client/api/schema';
+import { buildAzureContentFilter } from './orchestration-util.js';
+import type { CompletionPostRequest } from './client/api/schema/index.js';
 import type { OrchestrationModuleConfig } from './orchestration-types.js';
 
 describe('construct completion post request', () => {

packages/orchestration/src/orchestration-types.ts

@@ -1,6 +1,8 @@
 import type { ChatModel } from './model-types.js';
 import type {
   ChatMessages,
+  DataRepositoryType,
+  DocumentGroundingFilter,
   FilteringModuleConfig,
   GroundingModuleConfig,
   MaskingModuleConfig,
@@ -56,3 +58,42 @@ export interface OrchestrationModuleConfig {
    */
   grounding?: GroundingModuleConfig;
 }
+
+/**
+ * Represents a filter configuration for the Document Grounding Service.
+ *
+ */
+export type DocumentGroundingServiceFilter = Pick<
+  DocumentGroundingFilter,
+  | 'id'
+  | 'search_config'
+  | 'data_repositories'
+  | 'data_repository_metadata'
+  | 'document_metadata'
+  | 'chunk_metadata'
+> & {
+  /**
+   * Defines the type of data repository.
+   * If not set, the default value is 'vector'.
+   */
+  data_repository_type?: DataRepositoryType;
+};
+
+/**
+ * Represents the configuration for the Document Grounding Service.
+ */
+export interface DocumentGroundingServiceConfig {
+  /**
+   * Define the filters to apply during the grounding process.
+   */
+  filters?: DocumentGroundingServiceFilter[];
+  /**
+   * Contains the input parameters used for grounding input questions.
+   */
+  input_params: string[];
+  /**
+   * Parameter name used for grounding output.
+   * @example "groundingOutput"
+   */
+  output_param: string;
+}