@sap-ai-sdk/orchestration 1.5.1-20250113013141.0 → 1.6.0

package/README.md

@@ -86,6 +86,125 @@ The client allows you to combine various modules, such as templating and content
 
 In addition to the examples below, you can find more **sample code** [here](https://github.com/SAP/ai-sdk-js/blob/main/sample-code/src/orchestration.ts).
 
+### Streaming
+
+The `OrchestrationClient` supports streaming responses for chat completion requests based on the [Server-sent events](https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events) standard.
+
+Use the `stream()` method to receive a stream of chunk responses from the model.
+After consuming the stream, call the helper methods to get the finish reason and token usage information.
+
+```ts
+const orchestrationClient = new OrchestrationClient({
+  llm: {
+    model_name: 'gpt-4o',
+    model_params: { max_tokens: 50, temperature: 0.1 }
+  },
+  templating: {
+    template: [
+      { role: 'user', content: 'Give a long history of {{?country}}?' }
+    ]
+  }
+});
+
+const response = await orchestrationClient.stream({
+  inputParams: { country: 'France' }
+});
+
+for await (const chunk of response.stream) {
+  console.log(JSON.stringify(chunk));
+}
+
+const finishReason = response.getFinishReason();
+const tokenUsage = response.getTokenUsage();
+
+console.log(`Finish reason: ${finishReason}\n`);
+console.log(`Token usage: ${JSON.stringify(tokenUsage)}\n`);
+```
+
+#### Streaming the Delta Content
+
+The client provides a helper method to extract the text chunks as strings:
+
+```ts
+for await (const chunk of response.stream.toContentStream()) {
+  console.log(chunk); // will log the delta content
+}
+```
+
+Each chunk will be a string containing the delta content.
+
+#### Streaming with Abort Controller
+
+Streaming request can be aborted using the `AbortController` API.
+In case of an error, the SAP Cloud SDK for AI will automatically close the stream.
+Additionally, it can be aborted manually by calling the `stream()` method with an `AbortController` object.
+
+```ts
+const orchestrationClient = new OrchestrationClient({
+  llm: {
+    model_name: 'gpt-4o',
+    model_params: { max_tokens: 50, temperature: 0.1 }
+  },
+  templating: {
+    template: [
+      { role: 'user', content: 'Give a long history of {{?country}}?' }
+    ]
+  }
+});
+
+const controller = new AbortController();
+const response = await orchestrationClient.stream(
+  {
+    inputParams: { country: 'France' }
+  },
+  controller
+);
+
+// Abort the streaming request after one second
+setTimeout(() => {
+  controller.abort();
+}, 1000);
+
+for await (const chunk of response.stream) {
+  console.log(JSON.stringify(chunk));
+}
+```
+
+In this example, streaming request will be aborted after one second.
+Abort controller can be useful, e.g., when end-user wants to stop the stream or refreshes the page.
+
+#### Stream Options
+
+The orchestration service offers multiple streaming options, which you can configure in addition to the LLM's streaming options.
+These include options like definining the maximum number of characters per chunk or modifying the output filter behavior.
+There are two ways to add specific streaming options to your client, either at initialization of orchestration client, or when calling the stream API.
+
+Setting streaming options dynamically could be useful if an initialized orchestration client will also be used for streaming.
+
+You can check the list of available stream options in the [orchestration service's documentation](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/streaming).
+
+An example for setting the streaming options when calling the stream API looks like the following:
+
+```ts
+const response = orchestrationClient.stream(
+  {
+    inputParams: { country: 'France' }
+  },
+  controller,
+  {
+    llm: { include_usage: false },
+    global: { chunk_size: 10 },
+    outputFiltering: { overlap: 200 }
+  }
+);
+```
+
+Usage metrics are collected by default, if you do not want to receive them, set `include_usage` to `false`.
+If you don't want any streaming options as part of your call to the LLM, set `streamOptions.llm` to `null`.
+
+> [!NOTE]
+> When initalizing a client with a JSON module config, providing streaming options is not possible.
+
 ### Templating
 
 Use the orchestration client with templating to pass a prompt containing placeholders that will be replaced with input parameters during a chat completion request.
@@ -330,6 +449,7 @@ return response.getContent();
 ### Grounding
 
 Grounding enables integrating external, contextually relevant, domain-specific, or real-time data into AI processes.
+The grounding configuration can be provided as a raw JSON object or by using the `buildDocumentGroundingConfig()` function, which requires only the minimal mandatory values.
 
 ```ts
 const orchestrationClient = new OrchestrationClient({
@@ -346,21 +466,16 @@ const orchestrationClient = new OrchestrationClient({
     ],
     defaults: {}
   },
-  grounding: {
-    type: 'document_grounding_service',
-    config: {
-      filters: [
+  grounding: buildDocumentGroundingConfig(
+    input_params: ['groundingRequest'],
+    output_param: 'groundingOutput',
+    filters: [
         {
           id: 'filter1',
-          data_repositories: ['*'],
-          search_config: {},
-          data_repository_type: 'vector'
+          data_repositories: ['repository-id']
         }
       ],
-      input_params: ['groundingRequest'],
-      output_param: 'groundingOutput'
-    }
-  }
+    )
 });
 
 const response = await orchestrationClient.chatCompletion({

package/dist/index.d.ts

@@ -1,7 +1,10 @@
-export type { CompletionPostResponse, ChatMessages, TokenUsage, TemplatingModuleConfig, OrchestrationConfig, ModuleResults, ModuleConfigs, MaskingModuleConfig, MaskingProviderConfig, GroundingModuleConfig, DocumentGroundingFilter, GroundingFilterId, GroundingFilterSearchConfiguration, DataRepositoryType, KeyValueListPair, SearchDocumentKeyValueListPair, SearchSelectOptionEnum, LlmModuleResult, LlmChoice, GenericModuleResult, FilteringModuleConfig, InputFilteringConfig, OutputFilteringConfig, FilterConfig, ErrorResponse, DpiEntities, DpiEntityConfig, DpiConfig, CompletionPostRequest, ChatMessage, AzureThreshold, AzureContentSafety, AzureContentSafetyFilterConfig, ImageContent, TextContent, MultiChatMessageContent, MultiChatMessage } from './client/api/schema/index.js';
-export type { OrchestrationModuleConfig, LlmModuleConfig, Prompt, LlmModelParams } from './orchestration-types.js';
+export * from './client/api/schema/index.js';
+export type { OrchestrationModuleConfig, LlmModuleConfig, Prompt, RequestOptions, StreamOptions, DocumentGroundingServiceConfig, DocumentGroundingServiceFilter, LlmModelParams } from './orchestration-types.js';
+export { OrchestrationStreamResponse } from './orchestration-stream-response.js';
+export { OrchestrationStreamChunkResponse } from './orchestration-stream-chunk-response.js';
+export { OrchestrationStream } from './orchestration-stream.js';
 export { OrchestrationClient } from './orchestration-client.js';
-export { buildAzureContentFilter } from './orchestration-utils.js';
+export { buildAzureContentFilter, buildDocumentGroundingConfig } from './orchestration-utils.js';
 export { OrchestrationResponse } from './orchestration-response.js';
 export type { ChatModel } from './model-types.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,sBAAsB,EACtB,YAAY,EACZ,UAAU,EACV,sBAAsB,EACtB,mBAAmB,EACnB,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,uBAAuB,EACvB,iBAAiB,EACjB,kCAAkC,EAClC,kBAAkB,EAClB,gBAAgB,EAChB,8BAA8B,EAC9B,sBAAsB,EACtB,eAAe,EACf,SAAS,EACT,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,YAAY,EACZ,aAAa,EACb,WAAW,EACX,eAAe,EACf,SAAS,EACT,qBAAqB,EACrB,WAAW,EACX,cAAc,EACd,kBAAkB,EAClB,8BAA8B,EAC9B,YAAY,EACZ,WAAW,EACX,uBAAuB,EACvB,gBAAgB,EACjB,MAAM,8BAA8B,CAAC;AAEtC,YAAY,EACV,yBAAyB,EACzB,eAAe,EACf,MAAM,EACN,cAAc,EACf,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AAEnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE,YAAY,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAE7C,YAAY,EACV,yBAAyB,EACzB,eAAe,EACf,MAAM,EACN,cAAc,EACd,aAAa,EACb,8BAA8B,EAC9B,8BAA8B,EAC9B,cAAc,EACf,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAEjF,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAE5F,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EACL,uBAAuB,EACvB,4BAA4B,EAC7B,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE,YAAY,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -1,4 +1,8 @@
+export * from './client/api/schema/index.js';
+export { OrchestrationStreamResponse } from './orchestration-stream-response.js';
+export { OrchestrationStreamChunkResponse } from './orchestration-stream-chunk-response.js';
+export { OrchestrationStream } from './orchestration-stream.js';
 export { OrchestrationClient } from './orchestration-client.js';
-export { buildAzureContentFilter } from './orchestration-utils.js';
+export { buildAzureContentFilter, buildDocumentGroundingConfig } from './orchestration-utils.js';
 export { OrchestrationResponse } from './orchestration-response.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA+CA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AAEnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAa7C,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAEjF,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAE5F,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EACL,uBAAuB,EACvB,4BAA4B,EAC7B,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC"}

package/dist/model-types.d.ts

@@ -2,5 +2,5 @@ import type { AiCoreOpenSourceChatModel, AwsBedrockChatModel, AzureOpenAiChatMod
 /**
  * Supported chat models for orchestration.
  */
-export type ChatModel = Exclude<AzureOpenAiChatModel, 'gpt-4o-mini'> | GcpVertexAiChatModel | AwsBedrockChatModel | AiCoreOpenSourceChatModel;
+export type ChatModel = AzureOpenAiChatModel | GcpVertexAiChatModel | AwsBedrockChatModel | AiCoreOpenSourceChatModel;
 //# sourceMappingURL=model-types.d.ts.map

package/dist/model-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"model-types.d.ts","sourceRoot":"","sources":["../src/model-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,kBAAkB,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,OAAO,CAAC,oBAAoB,EAAE,aAAa,CAAC,GAC5C,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,CAAC"}
+{"version":3,"file":"model-types.d.ts","sourceRoot":"","sources":["../src/model-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,kBAAkB,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,oBAAoB,GACpB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,CAAC"}

package/dist/orchestration-client.d.ts

@@ -1,8 +1,9 @@
+import { OrchestrationStreamResponse } from './orchestration-stream-response.js';
 import { OrchestrationResponse } from './orchestration-response.js';
-import type { CustomRequestConfig } from '@sap-ai-sdk/core';
+import type { CustomRequestConfig } from '@sap-cloud-sdk/http-client';
 import type { ResourceGroupConfig } from '@sap-ai-sdk/ai-api/internal.js';
-import type { CompletionPostRequest } from './client/api/schema/index.js';
-import type { OrchestrationModuleConfig, Prompt } from './orchestration-types.js';
+import type { OrchestrationModuleConfig, Prompt, StreamOptions } from './orchestration-types.js';
+import type { OrchestrationStreamChunkResponse } from './orchestration-stream-chunk-response.js';
 import type { HttpDestinationOrFetchOptions } from '@sap-cloud-sdk/connectivity';
 /**
  * Get the orchestration client.
@@ -18,20 +19,9 @@ export declare class OrchestrationClient {
      * @param destination - The destination to use for the request.
      */
     constructor(config: OrchestrationModuleConfig | string, deploymentConfig?: ResourceGroupConfig | undefined, destination?: HttpDestinationOrFetchOptions | undefined);
-    /**
-     * Creates a completion for the chat messages.
-     * @param prompt - Prompt configuration.
-     * @param requestConfig - Request configuration.
-     * @returns The completion result.
-     */
     chatCompletion(prompt?: Prompt, requestConfig?: CustomRequestConfig): Promise<OrchestrationResponse>;
+    stream(prompt?: Prompt, controller?: AbortController, options?: StreamOptions, requestConfig?: CustomRequestConfig): Promise<OrchestrationStreamResponse<OrchestrationStreamChunkResponse>>;
+    private executeRequest;
+    private createStreamResponse;
 }
-/**
- * @internal
- */
-export declare function constructCompletionPostRequestFromJson(config: string, prompt?: Prompt): Record<string, any>;
-/**
- * @internal
- */
-export declare function constructCompletionPostRequest(config: OrchestrationModuleConfig, prompt?: Prompt): CompletionPostRequest;
 //# sourceMappingURL=orchestration-client.d.ts.map

package/dist/orchestration-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"orchestration-client.d.ts","sourceRoot":"","sources":["../src/orchestration-client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,KAAK,EACV,yBAAyB,EACzB,MAAM,EACP,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,6BAA6B,CAAC;AAEjF;;GAEG;AACH,qBAAa,mBAAmB;IAQ5B,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,gBAAgB,CAAC;IACzB,OAAO,CAAC,WAAW,CAAC;IATtB;;;;;OAKG;gBAEO,MAAM,EAAE,yBAAyB,GAAG,MAAM,EAC1C,gBAAgB,CAAC,EAAE,mBAAmB,YAAA,EACtC,WAAW,CAAC,EAAE,6BAA6B,YAAA;IAGrD;;;;;OAKG;IACG,cAAc,CAClB,MAAM,CAAC,EAAE,MAAM,EACf,aAAa,CAAC,EAAE,mBAAmB,GAClC,OAAO,CAAC,qBAAqB,CAAC;CAuBlC;AAED;;GAEG;AACH,wBAAgB,sCAAsC,CACpD,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,GACd,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAUrB;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,yBAAyB,EACjC,MAAM,CAAC,EAAE,MAAM,GACd,qBAAqB,CAwBvB"}
+{"version":3,"file":"orchestration-client.d.ts","sourceRoot":"","sources":["../src/orchestration-client.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAKpE,OAAO,KAAK,EAEV,mBAAmB,EACpB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAC1E,OAAO,KAAK,EACV,yBAAyB,EACzB,MAAM,EAEN,aAAa,EACd,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AACjG,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,6BAA6B,CAAC;AAOjF;;GAEG;AACH,qBAAa,mBAAmB;IAQ5B,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,gBAAgB,CAAC;IACzB,OAAO,CAAC,WAAW,CAAC;IATtB;;;;;OAKG;gBAEO,MAAM,EAAE,yBAAyB,GAAG,MAAM,EAC1C,gBAAgB,CAAC,EAAE,mBAAmB,YAAA,EACtC,WAAW,CAAC,EAAE,6BAA6B,YAAA;IAW/C,cAAc,CAClB,MAAM,CAAC,EAAE,MAAM,EACf,aAAa,CAAC,EAAE,mBAAmB,GAClC,OAAO,CAAC,qBAAqB,CAAC;IAS3B,MAAM,CACV,MAAM,CAAC,EAAE,MAAM,EACf,UAAU,kBAAwB,EAClC,OAAO,GAAE,aAAkB,EAC3B,aAAa,CAAC,EAAE,mBAAmB,GAClC,OAAO,CAAC,2BAA2B,CAAC,gCAAgC,CAAC,CAAC;YAkB3D,cAAc;YAiCd,oBAAoB;CAwBnC"}

package/dist/orchestration-client.js

@@ -1,6 +1,14 @@
 import { executeRequest } from '@sap-ai-sdk/core';
 import { resolveDeploymentId } from '@sap-ai-sdk/ai-api/internal.js';
+import { createLogger } from '@sap-cloud-sdk/util';
+import { OrchestrationStream } from './orchestration-stream.js';
+import { OrchestrationStreamResponse } from './orchestration-stream-response.js';
 import { OrchestrationResponse } from './orchestration-response.js';
+import { constructCompletionPostRequest, constructCompletionPostRequestFromJsonModuleConfig } from './orchestration-utils.js';
+const logger = createLogger({
+    package: 'orchestration',
+    messageContext: 'orchestration-client'
+});
 /**
  * Get the orchestration client.
  */
@@ -18,69 +26,64 @@ export class OrchestrationClient {
         this.config = config;
         this.deploymentConfig = deploymentConfig;
         this.destination = destination;
+        try {
+            if (typeof config === 'string') {
+                JSON.parse(config);
+            }
+        }
+        catch (error) {
+            throw new Error(`Could not parse JSON: ${error}`);
+        }
     }
-    /**
-     * Creates a completion for the chat messages.
-     * @param prompt - Prompt configuration.
-     * @param requestConfig - Request configuration.
-     * @returns The completion result.
-     */
     async chatCompletion(prompt, requestConfig) {
+        const response = await this.executeRequest({
+            prompt,
+            requestConfig,
+            stream: false
+        });
+        return new OrchestrationResponse(response);
+    }
+    async stream(prompt, controller = new AbortController(), options = {}, requestConfig) {
+        if (typeof this.config === 'string' && options) {
+            logger.warn('Stream options are not supported when using a JSON module config.');
+        }
+        return this.createStreamResponse({
+            prompt,
+            requestConfig,
+            stream: true,
+            streamOptions: options
+        }, controller);
+    }
+    async executeRequest(options) {
+        const { prompt, requestConfig, stream, streamOptions } = options;
         const body = typeof this.config === 'string'
-            ? constructCompletionPostRequestFromJson(this.config, prompt)
-            : constructCompletionPostRequest(this.config, prompt);
+            ? constructCompletionPostRequestFromJsonModuleConfig(JSON.parse(this.config), prompt, stream)
+            : constructCompletionPostRequest(this.config, prompt, stream, streamOptions);
         const deploymentId = await resolveDeploymentId({
             scenarioId: 'orchestration',
-            resourceGroup: this.deploymentConfig?.resourceGroup
+            ...(this.deploymentConfig ?? {})
         });
-        const response = await executeRequest({
+        return executeRequest({
             url: `/inference/deployments/${deploymentId}/completion`,
-            resourceGroup: this.deploymentConfig?.resourceGroup
+            ...(this.deploymentConfig ?? {})
         }, body, requestConfig, this.destination);
-        return new OrchestrationResponse(response);
-    }
-}
-/**
- * @internal
- */
-export function constructCompletionPostRequestFromJson(config, prompt) {
-    try {
-        return {
-            messages_history: prompt?.messagesHistory || [],
-            input_params: prompt?.inputParams || {},
-            orchestration_config: JSON.parse(config)
-        };
     }
-    catch (error) {
-        throw new Error(`Could not parse JSON: ${error}`);
-    }
-}
-/**
- * @internal
- */
-export function constructCompletionPostRequest(config, prompt) {
-    return {
-        orchestration_config: {
-            module_configurations: {
-                templating_module_config: config.templating,
-                llm_module_config: config.llm,
-                ...(Object.keys(config?.filtering || {}).length && {
-                    filtering_module_config: config.filtering
-                }),
-                ...(Object.keys(config?.masking || {}).length && {
-                    masking_module_config: config.masking
-                }),
-                ...(Object.keys(config?.grounding || {}).length && {
-                    grounding_module_config: config.grounding
-                })
+    async createStreamResponse(options, controller) {
+        const response = new OrchestrationStreamResponse();
+        const streamResponse = await this.executeRequest({
+            ...options,
+            requestConfig: {
+                ...options.requestConfig,
+                responseType: 'stream',
+                signal: controller.signal
             }
-        },
-        ...(prompt?.inputParams && {
-            input_params: prompt.inputParams
-        }),
-        ...(prompt?.messagesHistory && {
-            messages_history: prompt.messagesHistory
-        })
-    };
+        });
+        const stream = OrchestrationStream._create(streamResponse, controller);
+        response.stream = stream
+            ._pipe(OrchestrationStream._processChunk)
+            ._pipe(OrchestrationStream._processFinishReason, response)
+            ._pipe(OrchestrationStream._processTokenUsage, response);
+        return response;
+    }
 }
 //# sourceMappingURL=orchestration-client.js.map

package/dist/orchestration-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"orchestration-client.js","sourceRoot":"","sources":["../src/orchestration-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAUpE;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAQpB;IACA;IACA;IATV;;;;;OAKG;IACH,YACU,MAA0C,EAC1C,gBAAsC,EACtC,WAA2C;QAF3C,WAAM,GAAN,MAAM,CAAoC;QAC1C,qBAAgB,GAAhB,gBAAgB,CAAsB;QACtC,gBAAW,GAAX,WAAW,CAAgC;IAClD,CAAC;IAEJ;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,MAAe,EACf,aAAmC;QAEnC,MAAM,IAAI,GACR,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ;YAC7B,CAAC,CAAC,sCAAsC,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YAC7D,CAAC,CAAC,8BAA8B,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAE1D,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC;YAC7C,UAAU,EAAE,eAAe;YAC3B,aAAa,EAAE,IAAI,CAAC,gBAAgB,EAAE,aAAa;SACpD,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,cAAc,CACnC;YACE,GAAG,EAAE,0BAA0B,YAAY,aAAa;YACxD,aAAa,EAAE,IAAI,CAAC,gBAAgB,EAAE,aAAa;SACpD,EACD,IAAI,EACJ,aAAa,EACb,IAAI,CAAC,WAAW,CACjB,CAAC;QAEF,OAAO,IAAI,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,sCAAsC,CACpD,MAAc,EACd,MAAe;IAEf,IAAI,CAAC;QACH,OAAO;YACL,gBAAgB,EAAE,MAAM,EAAE,eAAe,IAAI,EAAE;YAC/C,YAAY,EAAE,MAAM,EAAE,WAAW,IAAI,EAAE;YACvC,oBAAoB,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;SACzC,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,yBAAyB,KAAK,EAAE,CAAC,CAAC;IACpD,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAC5C,MAAiC,EACjC,MAAe;IAEf,OAAO;QACL,oBAAoB,EAAE;YACpB,qBAAqB,EAAE;gBACrB,wBAAwB,EAAE,MAAM,CAAC,UAAU;gBAC3C,iBAAiB,EAAE,MAAM,CAAC,GAAG;gBAC7B,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI;oBACjD,uBAAuB,EAAE,MAAM,CAAC,SAAS;iBAC1C,CAAC;gBACF,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI;oBAC/C,qBAAqB,EAAE,MAAM,CAAC,OAAO;iBACtC,CAAC;gBACF,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI;oBACjD,uBAAuB,EAAE,MAAM,CAAC,SAAS;iBAC1C,CAAC;aACH;SACF;QACD,GAAG,CAAC,MAAM,EAAE,WAAW,IAAI;YACzB,YAAY,EAAE,MAAM,CAAC,WAAW;SACjC,CAAC;QACF,GAAG,CAAC,MAAM,EAAE,eAAe,IAAI;YAC7B,gBAAgB,EAAE,MAAM,CAAC,eAAe;SACzC,CAAC;KACH,CAAC;AACJ,CAAC"}
+{"version":3,"file":"orchestration-client.js","sourceRoot":"","sources":["../src/orchestration-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EACL,8BAA8B,EAC9B,kDAAkD,EACnD,MAAM,0BAA0B,CAAC;AAelC,MAAM,MAAM,GAAG,YAAY,CAAC;IAC1B,OAAO,EAAE,eAAe;IACxB,cAAc,EAAE,sBAAsB;CACvC,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAQpB;IACA;IACA;IATV;;;;;OAKG;IACH,YACU,MAA0C,EAC1C,gBAAsC,EACtC,WAA2C;QAF3C,WAAM,GAAN,MAAM,CAAoC;QAC1C,qBAAgB,GAAhB,gBAAgB,CAAsB;QACtC,gBAAW,GAAX,WAAW,CAAgC;QAEnD,IAAI,CAAC;YACH,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,yBAAyB,KAAK,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,MAAe,EACf,aAAmC;QAEnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC;YACzC,MAAM;YACN,aAAa;YACb,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;QACH,OAAO,IAAI,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,MAAM,CACV,MAAe,EACf,UAAU,GAAG,IAAI,eAAe,EAAE,EAClC,UAAyB,EAAE,EAC3B,aAAmC;QAEnC,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,EAAE,CAAC;YAC/C,MAAM,CAAC,IAAI,CACT,mEAAmE,CACpE,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,oBAAoB,CAC9B;YACE,MAAM;YACN,aAAa;YACb,MAAM,EAAE,IAAI;YACZ,aAAa,EAAE,OAAO;SACvB,EACD,UAAU,CACX,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,OAAuB;QAClD,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;QAEjE,MAAM,IAAI,GACR,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ;YAC7B,CAAC,CAAC,kDAAkD,CAChD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EACvB,MAAM,EACN,MAAM,CACP;YACH,CAAC,CAAC,8BAA8B,CAC5B,IAAI,CAAC,MAAM,EACX,MAAM,EACN,MAAM,EACN,aAAa,CACd,CAAC;QAER,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC;YAC7C,UAAU,EAAE,eAAe;YAC3B,GAAG,CAAC,IAAI,CAAC,gBAAgB,IAAI,EAAE,CAAC;SACjC,CAAC,CAAC;QAEH,OAAO,cAAc,CACnB;YACE,GAAG,EAAE,0BAA0B,YAAY,aAAa;YACxD,GAAG,CAAC,IAAI,CAAC,gBAAgB,IAAI,EAAE,CAAC;SACjC,EACD,IAAI,EACJ,aAAa,EACb,IAAI,CAAC,WAAW,CACjB,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAChC,OAAuB,EACvB,UAA2B;QAE3B,MAAM,QAAQ,GACZ,IAAI,2BAA2B,EAAoC,CAAC;QAEtE,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC;YAC/C,GAAG,OAAO;YACV,aAAa,EAAE;gBACb,GAAG,OAAO,CAAC,aAAa;gBACxB,YAAY,EAAE,QAAQ;gBACtB,MAAM,EAAE,UAAU,CAAC,MAAM;aAC1B;SACF,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,mBAAmB,CAAC,OAAO,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QACvE,QAAQ,CAAC,MAAM,GAAG,MAAM;aACrB,KAAK,CAAC,mBAAmB,CAAC,aAAa,CAAC;aACxC,KAAK,CAAC,mBAAmB,CAAC,oBAAoB,EAAE,QAAQ,CAAC;aACzD,KAAK,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QAE3D,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/dist/orchestration-stream-chunk-response.d.ts

@@ -0,0 +1,27 @@
+import type { CompletionPostResponseStreaming, TokenUsage } from './client/api/schema/index.js';
+/**
+ * Orchestration stream chunk response.
+ */
+export declare class OrchestrationStreamChunkResponse {
+    readonly data: CompletionPostResponseStreaming;
+    constructor(data: CompletionPostResponseStreaming);
+    /**
+     * Usage of tokens in the chunk response.
+     * @returns Token usage.
+     */
+    getTokenUsage(): TokenUsage | undefined;
+    /**
+     * Reason for stopping the completion stream chunk.
+     * @param choiceIndex - The index of the choice to parse.
+     * @returns The finish reason.
+     */
+    getFinishReason(choiceIndex?: number): string | undefined;
+    /**
+     * Parses the chunk response and returns the delta content.
+     * @param choiceIndex - The index of the choice to parse.
+     * @returns The message delta content.
+     */
+    getDeltaContent(choiceIndex?: number): string | undefined;
+    private getChoices;
+}
+//# sourceMappingURL=orchestration-stream-chunk-response.d.ts.map

package/dist/orchestration-stream-chunk-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-stream-chunk-response.d.ts","sourceRoot":"","sources":["../src/orchestration-stream-chunk-response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,+BAA+B,EAE/B,UAAU,EACX,MAAM,8BAA8B,CAAC;AAEtC;;GAEG;AACH,qBAAa,gCAAgC;aACf,IAAI,EAAE,+BAA+B;gBAArC,IAAI,EAAE,+BAA+B;IAIjE;;;OAGG;IACH,aAAa,IAAI,UAAU,GAAG,SAAS;IAIvC;;;;OAIG;IACH,eAAe,CAAC,WAAW,SAAI,GAAG,MAAM,GAAG,SAAS;IAMpD;;;;OAIG;IACH,eAAe,CAAC,WAAW,SAAI,GAAG,MAAM,GAAG,SAAS;IAMpD,OAAO,CAAC,UAAU;CAGnB"}

package/dist/orchestration-stream-chunk-response.js

@@ -0,0 +1,37 @@
+/**
+ * Orchestration stream chunk response.
+ */
+export class OrchestrationStreamChunkResponse {
+    data;
+    constructor(data) {
+        this.data = data;
+        this.data = data;
+    }
+    /**
+     * Usage of tokens in the chunk response.
+     * @returns Token usage.
+     */
+    getTokenUsage() {
+        return this.data.orchestration_result?.usage;
+    }
+    /**
+     * Reason for stopping the completion stream chunk.
+     * @param choiceIndex - The index of the choice to parse.
+     * @returns The finish reason.
+     */
+    getFinishReason(choiceIndex = 0) {
+        return this.getChoices()?.find((c) => c.index === choiceIndex)?.finish_reason;
+    }
+    /**
+     * Parses the chunk response and returns the delta content.
+     * @param choiceIndex - The index of the choice to parse.
+     * @returns The message delta content.
+     */
+    getDeltaContent(choiceIndex = 0) {
+        return this.getChoices()?.find((c) => c.index === choiceIndex)?.delta.content;
+    }
+    getChoices() {
+        return this.data.orchestration_result?.choices;
+    }
+}
+//# sourceMappingURL=orchestration-stream-chunk-response.js.map

package/dist/orchestration-stream-chunk-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-stream-chunk-response.js","sourceRoot":"","sources":["../src/orchestration-stream-chunk-response.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,OAAO,gCAAgC;IACf;IAA5B,YAA4B,IAAqC;QAArC,SAAI,GAAJ,IAAI,CAAiC;QAC/D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,WAAW,GAAG,CAAC;QAC7B,OAAO,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAC5B,CAAC,CAAqB,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,WAAW,CACnD,EAAE,aAAa,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,WAAW,GAAG,CAAC;QAC7B,OAAO,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAC5B,CAAC,CAAqB,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,WAAW,CACnD,EAAE,KAAK,CAAC,OAAO,CAAC;IACnB,CAAC;IAEO,UAAU;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,OAAO,CAAC;IACjD,CAAC;CACF"}

package/dist/orchestration-stream-response.d.ts

@@ -0,0 +1,33 @@
+import type { TokenUsage } from './client/api/schema/index.js';
+import type { OrchestrationStream } from './orchestration-stream.js';
+/**
+ * Orchestration stream response.
+ */
+export declare class OrchestrationStreamResponse<T> {
+    private _usage;
+    /**
+     * Finish reasons for all choices.
+     */
+    private _finishReasons;
+    private _stream;
+    getTokenUsage(): TokenUsage | undefined;
+    /**
+     * @internal
+     */
+    _setTokenUsage(usage: TokenUsage): void;
+    getFinishReason(choiceIndex?: number): string | undefined;
+    /**
+     * @internal
+     */
+    _getFinishReasons(): Map<number, string>;
+    /**
+     * @internal
+     */
+    _setFinishReasons(finishReasons: Map<number, string>): void;
+    get stream(): OrchestrationStream<T>;
+    /**
+     * @internal
+     */
+    set stream(stream: OrchestrationStream<T>);
+}
+//# sourceMappingURL=orchestration-stream-response.d.ts.map

package/dist/orchestration-stream-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-stream-response.d.ts","sourceRoot":"","sources":["../src/orchestration-stream-response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAErE;;GAEG;AACH,qBAAa,2BAA2B,CAAC,CAAC;IACxC,OAAO,CAAC,MAAM,CAAyB;IACvC;;OAEG;IACH,OAAO,CAAC,cAAc,CAAkC;IACxD,OAAO,CAAC,OAAO,CAAqC;IAE7C,aAAa,IAAI,UAAU,GAAG,SAAS;IAI9C;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAIhC,eAAe,CAAC,WAAW,SAAI,GAAG,MAAM,GAAG,SAAS;IAI3D;;OAEG;IACH,iBAAiB,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAIxC;;OAEG;IACH,iBAAiB,CAAC,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IAI3D,IAAI,MAAM,IAAI,mBAAmB,CAAC,CAAC,CAAC,CAKnC;IAED;;OAEG;IACH,IAAI,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAExC;CACF"}

package/dist/orchestration-stream-response.js

@@ -0,0 +1,48 @@
+/**
+ * Orchestration stream response.
+ */
+export class OrchestrationStreamResponse {
+    _usage;
+    /**
+     * Finish reasons for all choices.
+     */
+    _finishReasons = new Map();
+    _stream;
+    getTokenUsage() {
+        return this._usage;
+    }
+    /**
+     * @internal
+     */
+    _setTokenUsage(usage) {
+        this._usage = usage;
+    }
+    getFinishReason(choiceIndex = 0) {
+        return this._finishReasons.get(choiceIndex);
+    }
+    /**
+     * @internal
+     */
+    _getFinishReasons() {
+        return this._finishReasons;
+    }
+    /**
+     * @internal
+     */
+    _setFinishReasons(finishReasons) {
+        this._finishReasons = finishReasons;
+    }
+    get stream() {
+        if (!this._stream) {
+            throw new Error('Response stream is undefined.');
+        }
+        return this._stream;
+    }
+    /**
+     * @internal
+     */
+    set stream(stream) {
+        this._stream = stream;
+    }
+}
+//# sourceMappingURL=orchestration-stream-response.js.map

package/dist/orchestration-stream-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-stream-response.js","sourceRoot":"","sources":["../src/orchestration-stream-response.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,OAAO,2BAA2B;IAC9B,MAAM,CAAyB;IACvC;;OAEG;IACK,cAAc,GAAwB,IAAI,GAAG,EAAE,CAAC;IAChD,OAAO,CAAqC;IAE7C,aAAa;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,KAAiB;QAC9B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAEM,eAAe,CAAC,WAAW,GAAG,CAAC;QACpC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAC,aAAkC;QAClD,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED,IAAI,MAAM;QACR,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM,CAAC,MAA8B;QACvC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;CACF"}

package/dist/orchestration-stream.d.ts

@@ -0,0 +1,55 @@
+import { SseStream } from '@sap-ai-sdk/core';
+import { OrchestrationStreamChunkResponse } from './orchestration-stream-chunk-response.js';
+import type { CompletionPostResponseStreaming } from './client/api/schema/index.js';
+import type { HttpResponse } from '@sap-cloud-sdk/http-client';
+import type { OrchestrationStreamResponse } from './orchestration-stream-response.js';
+/**
+ * Orchestration stream containing post-processing functions.
+ */
+export declare class OrchestrationStream<Item> extends SseStream<Item> {
+    iterator: () => AsyncIterator<Item>;
+    /**
+     * Create an orchestration stream based on the http response.
+     * @param response - Http response.
+     * @returns An orchestration stream.
+     * @internal
+     */
+    static _create(response: HttpResponse, controller: AbortController): OrchestrationStream<CompletionPostResponseStreaming>;
+    /**
+     * Wrap raw chunk data with chunk response class to provide helper functions.
+     * @param stream - Orchestration stream.
+     * @internal
+     */
+    static _processChunk(stream: OrchestrationStream<CompletionPostResponseStreaming>): AsyncGenerator<OrchestrationStreamChunkResponse>;
+    /**
+     * @internal
+     */
+    static _processFinishReason(stream: OrchestrationStream<OrchestrationStreamChunkResponse>, response?: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>): AsyncGenerator<OrchestrationStreamChunkResponse>;
+    /**
+     * @internal
+     */
+    static _processTokenUsage(stream: OrchestrationStream<OrchestrationStreamChunkResponse>, response?: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>): AsyncGenerator<OrchestrationStreamChunkResponse>;
+    /**
+     * Transform a stream of chunks into a stream of content strings.
+     * @param stream - Orchestration stream.
+     * @param choiceIndex - The index of the choice to parse.
+     * @internal
+     */
+    static _processContentStream(stream: OrchestrationStream<OrchestrationStreamChunkResponse>): AsyncGenerator<string>;
+    constructor(iterator: () => AsyncIterator<Item>, controller: AbortController);
+    /**
+     * Pipe the stream through a processing function.
+     * @param processFn - The function to process the input stream.
+     * @param response - The `OrchestrationStreamResponse` object for process function to store finish reason, token usage, etc.
+     * @returns The output stream containing processed items.
+     * @internal
+     */
+    _pipe<TReturn>(processFn: (stream: OrchestrationStream<Item>, response?: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>) => AsyncIterator<TReturn>, response?: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>): OrchestrationStream<TReturn>;
+    /**
+     * Transform the stream of chunks into a stream of content strings.
+     * @param this - Orchestration stream.
+     * @returns A stream of content strings.
+     */
+    toContentStream(this: OrchestrationStream<OrchestrationStreamChunkResponse>): OrchestrationStream<string>;
+}
+//# sourceMappingURL=orchestration-stream.d.ts.map

package/dist/orchestration-stream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-stream.d.ts","sourceRoot":"","sources":["../src/orchestration-stream.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAC5F,OAAO,KAAK,EACV,+BAA+B,EAEhC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAOtF;;GAEG;AACH,qBAAa,mBAAmB,CAAC,IAAI,CAAE,SAAQ,SAAS,CAAC,IAAI,CAAC;IAkHnD,QAAQ,EAAE,MAAM,aAAa,CAAC,IAAI,CAAC;IAjH5C;;;;;OAKG;WACW,OAAO,CACnB,QAAQ,EAAE,YAAY,EACtB,UAAU,EAAE,eAAe,GAC1B,mBAAmB,CAAC,+BAA+B,CAAC;IASvD;;;;OAIG;WACW,aAAa,CACzB,MAAM,EAAE,mBAAmB,CAAC,+BAA+B,CAAC,GAC3D,cAAc,CAAC,gCAAgC,CAAC;IAMnD;;OAEG;WACW,oBAAoB,CAChC,MAAM,EAAE,mBAAmB,CAAC,gCAAgC,CAAC,EAC7D,QAAQ,CAAC,EAAE,2BAA2B,CAAC,gCAAgC,CAAC,GACvE,cAAc,CAAC,gCAAgC,CAAC;IAsCnD;;OAEG;WACW,kBAAkB,CAC9B,MAAM,EAAE,mBAAmB,CAAC,gCAAgC,CAAC,EAC7D,QAAQ,CAAC,EAAE,2BAA2B,CAAC,gCAAgC,CAAC,GACvE,cAAc,CAAC,gCAAgC,CAAC;IAanD;;;;;OAKG;WACW,qBAAqB,CACjC,MAAM,EAAE,mBAAmB,CAAC,gCAAgC,CAAC,GAC5D,cAAc,CAAC,MAAM,CAAC;gBAWhB,QAAQ,EAAE,MAAM,aAAa,CAAC,IAAI,CAAC,EAC1C,UAAU,EAAE,eAAe;IAK7B;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,EACX,SAAS,EAAE,CACT,MAAM,EAAE,mBAAmB,CAAC,IAAI,CAAC,EACjC,QAAQ,CAAC,EAAE,2BAA2B,CAAC,gCAAgC,CAAC,KACrE,aAAa,CAAC,OAAO,CAAC,EAC3B,QAAQ,CAAC,EAAE,2BAA2B,CAAC,gCAAgC,CAAC,GACvE,mBAAmB,CAAC,OAAO,CAAC;IAU/B;;;;OAIG;IACI,eAAe,CACpB,IAAI,EAAE,mBAAmB,CAAC,gCAAgC,CAAC,GAC1D,mBAAmB,CAAC,MAAM,CAAC;CAM/B"}

package/dist/orchestration-stream.js

@@ -0,0 +1,121 @@
+import { createLogger } from '@sap-cloud-sdk/util';
+import { SseStream } from '@sap-ai-sdk/core';
+import { OrchestrationStreamChunkResponse } from './orchestration-stream-chunk-response.js';
+const logger = createLogger({
+    package: 'orchestration',
+    messageContext: 'orchestration-chat-completion-stream'
+});
+/**
+ * Orchestration stream containing post-processing functions.
+ */
+export class OrchestrationStream extends SseStream {
+    iterator;
+    /**
+     * Create an orchestration stream based on the http response.
+     * @param response - Http response.
+     * @returns An orchestration stream.
+     * @internal
+     */
+    static _create(response, controller) {
+        const stream = SseStream.transformToSseStream(response, controller);
+        return new OrchestrationStream(stream.iterator, controller);
+    }
+    /**
+     * Wrap raw chunk data with chunk response class to provide helper functions.
+     * @param stream - Orchestration stream.
+     * @internal
+     */
+    static async *_processChunk(stream) {
+        for await (const chunk of stream) {
+            yield new OrchestrationStreamChunkResponse(chunk);
+        }
+    }
+    /**
+     * @internal
+     */
+    static async *_processFinishReason(stream, response) {
+        for await (const chunk of stream) {
+            chunk.data.orchestration_result?.choices.forEach((choice) => {
+                const choiceIndex = choice.index;
+                if (choiceIndex >= 0) {
+                    const finishReason = chunk.getFinishReason(choiceIndex);
+                    if (finishReason) {
+                        if (response) {
+                            response._getFinishReasons().set(choiceIndex, finishReason);
+                        }
+                        switch (finishReason) {
+                            case 'content_filter':
+                                logger.error(`Choice ${choiceIndex}: Stream finished with content filter hit.`);
+                                break;
+                            case 'length':
+                                logger.error(`Choice ${choiceIndex}: Stream finished with token length exceeded.`);
+                                break;
+                            case 'stop':
+                                logger.debug(`Choice ${choiceIndex}: Stream finished.`);
+                                break;
+                            default:
+                                logger.error(`Choice ${choiceIndex}: Stream finished with unknown reason '${finishReason}'.`);
+                        }
+                    }
+                }
+            });
+            yield chunk;
+        }
+    }
+    /**
+     * @internal
+     */
+    static async *_processTokenUsage(stream, response) {
+        for await (const chunk of stream) {
+            const usage = chunk.getTokenUsage();
+            if (usage) {
+                if (response) {
+                    response._setTokenUsage(usage);
+                }
+                logger.debug(`Token usage: ${JSON.stringify(usage)}`);
+            }
+            yield chunk;
+        }
+    }
+    /**
+     * Transform a stream of chunks into a stream of content strings.
+     * @param stream - Orchestration stream.
+     * @param choiceIndex - The index of the choice to parse.
+     * @internal
+     */
+    static async *_processContentStream(stream) {
+        for await (const chunk of stream) {
+            const deltaContent = chunk.getDeltaContent();
+            if (!deltaContent) {
+                continue;
+            }
+            yield deltaContent;
+        }
+    }
+    constructor(iterator, controller) {
+        super(iterator, controller);
+        this.iterator = iterator;
+    }
+    /**
+     * Pipe the stream through a processing function.
+     * @param processFn - The function to process the input stream.
+     * @param response - The `OrchestrationStreamResponse` object for process function to store finish reason, token usage, etc.
+     * @returns The output stream containing processed items.
+     * @internal
+     */
+    _pipe(processFn, response) {
+        if (response) {
+            return new OrchestrationStream(() => processFn(this, response), this.controller);
+        }
+        return new OrchestrationStream(() => processFn(this), this.controller);
+    }
+    /**
+     * Transform the stream of chunks into a stream of content strings.
+     * @param this - Orchestration stream.
+     * @returns A stream of content strings.
+     */
+    toContentStream() {
+        return new OrchestrationStream(() => OrchestrationStream._processContentStream(this), this.controller);
+    }
+}
+//# sourceMappingURL=orchestration-stream.js.map

package/dist/orchestration-stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-stream.js","sourceRoot":"","sources":["../src/orchestration-stream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAQ5F,MAAM,MAAM,GAAG,YAAY,CAAC;IAC1B,OAAO,EAAE,eAAe;IACxB,cAAc,EAAE,sCAAsC;CACvD,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,OAAO,mBAA0B,SAAQ,SAAe;IAkHnD;IAjHT;;;;;OAKG;IACI,MAAM,CAAC,OAAO,CACnB,QAAsB,EACtB,UAA2B;QAE3B,MAAM,MAAM,GACV,SAAS,CAAC,oBAAoB,CAC5B,QAAQ,EACR,UAAU,CACX,CAAC;QACJ,OAAO,IAAI,mBAAmB,CAAC,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,CACzB,MAA4D;QAE5D,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACjC,MAAM,IAAI,gCAAgC,CAAC,KAAK,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAChC,MAA6D,EAC7D,QAAwE;QAExE,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACjC,KAAK,CAAC,IAAI,CAAC,oBAAoB,EAAE,OAAO,CAAC,OAAO,CAC9C,CAAC,MAA0B,EAAE,EAAE;gBAC7B,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC;gBACjC,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;oBACrB,MAAM,YAAY,GAAG,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;oBACxD,IAAI,YAAY,EAAE,CAAC;wBACjB,IAAI,QAAQ,EAAE,CAAC;4BACb,QAAQ,CAAC,iBAAiB,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;wBAC9D,CAAC;wBACD,QAAQ,YAAY,EAAE,CAAC;4BACrB,KAAK,gBAAgB;gCACnB,MAAM,CAAC,KAAK,CACV,UAAU,WAAW,4CAA4C,CAClE,CAAC;gCACF,MAAM;4BACR,KAAK,QAAQ;gCACX,MAAM,CAAC,KAAK,CACV,UAAU,WAAW,+CAA+C,CACrE,CAAC;gCACF,MAAM;4BACR,KAAK,MAAM;gCACT,MAAM,CAAC,KAAK,CAAC,UAAU,WAAW,oBAAoB,CAAC,CAAC;gCACxD,MAAM;4BACR;gCACE,MAAM,CAAC,KAAK,CACV,UAAU,WAAW,0CAA0C,YAAY,IAAI,CAChF,CAAC;wBACN,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC,CACF,CAAC;YACF,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,CAAC,kBAAkB,CAC9B,MAA6D,EAC7D,QAAwE;QAExE,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;YACpC,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,QAAQ,EAAE,CAAC;oBACb,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACjC,CAAC;gBACD,MAAM,CAAC,KAAK,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACxD,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,CAAC,qBAAqB,CACjC,MAA6D;QAE7D,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACjC,MAAM,YAAY,GAAG,KAAK,CAAC,eAAe,EAAE,CAAC;YAC7C,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,SAAS;YACX,CAAC;YACD,MAAM,YAAY,CAAC;QACrB,CAAC;IACH,CAAC;IAED,YACS,QAAmC,EAC1C,UAA2B;QAE3B,KAAK,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAHrB,aAAQ,GAAR,QAAQ,CAA2B;IAI5C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CACH,SAG2B,EAC3B,QAAwE;QAExE,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,IAAI,mBAAmB,CAC5B,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,EAC/B,IAAI,CAAC,UAAU,CAChB,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,mBAAmB,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACI,eAAe;QAGpB,OAAO,IAAI,mBAAmB,CAC5B,GAAG,EAAE,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,IAAI,CAAC,EACrD,IAAI,CAAC,UAAU,CAChB,CAAC;IACJ,CAAC;CACF"}

package/dist/orchestration-types.d.ts

@@ -1,5 +1,6 @@
+import type { CustomRequestConfig } from '@sap-cloud-sdk/http-client';
 import type { ChatModel } from './model-types.js';
-import type { ChatMessages, FilteringModuleConfig, GroundingModuleConfig, MaskingModuleConfig, LlmModuleConfig as OriginalLlmModuleConfig, TemplatingModuleConfig } from './client/api/schema/index.js';
+import type { ChatMessages, DataRepositoryType, DocumentGroundingFilter, FilteringModuleConfig, FilteringStreamOptions, GlobalStreamOptions, GroundingModuleConfig, MaskingModuleConfig, LlmModuleConfig as OriginalLlmModuleConfig, TemplatingModuleConfig } from './client/api/schema/index.js';
 /**
  * Prompt configuration.
  */
@@ -57,4 +58,73 @@ export interface OrchestrationModuleConfig {
      */
     grounding?: GroundingModuleConfig;
 }
+/**
+ * Request options for orchestration.
+ */
+export interface RequestOptions {
+    /**
+     * Prompt configuration.
+     */
+    prompt?: Prompt;
+    /**
+     * Custom request configuration.
+     */
+    requestConfig?: CustomRequestConfig;
+    /**
+     * Whether to stream the response.
+     */
+    stream?: boolean;
+    /**
+     * Options for the stream.
+     */
+    streamOptions?: StreamOptions;
+}
+/**
+ * Options for the stream.
+ */
+export interface StreamOptions {
+    /**
+     * LLM specific stream options.
+     */
+    llm?: {
+        include_usage?: boolean;
+        [key: string]: any;
+    } | null;
+    /**
+     * Output filtering stream options.
+     */
+    outputFiltering?: FilteringStreamOptions;
+    /**
+     * Global stream options.
+     */
+    global?: GlobalStreamOptions;
+}
+/**
+ * Represents a filter configuration for the Document Grounding Service.
+ */
+export type DocumentGroundingServiceFilter = Omit<DocumentGroundingFilter, 'data_repository_type'> & {
+    /**
+     * 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 {
+    /**
+     * Defines 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;
+}
 //# sourceMappingURL=orchestration-types.d.ts.map

package/dist/orchestration-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"orchestration-types.d.ts","sourceRoot":"","sources":["../src/orchestration-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EACV,YAAY,EACZ,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,IAAI,uBAAuB,EAC1C,sBAAsB,EACvB,MAAM,8BAA8B,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,YAAY,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,uBAAuB,GAAG;IACtD,MAAM;IACN,UAAU,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,cAAc,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC;IACnC;;OAEG;IACH,GAAG,EAAE,eAAe,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,qBAAqB,CAAC;CACnC"}
+{"version":3,"file":"orchestration-types.d.ts","sourceRoot":"","sources":["../src/orchestration-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EACV,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,IAAI,uBAAuB,EAC1C,sBAAsB,EACvB,MAAM,8BAA8B,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,YAAY,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,uBAAuB,GAAG;IACtD,MAAM;IACN,UAAU,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,cAAc,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC;IACnC;;OAEG;IACH,GAAG,EAAE,eAAe,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,qBAAqB,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,GAAG,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,IAAI,CAAC;IAC7D;;OAEG;IACH,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,IAAI,CAC/C,uBAAuB,EACvB,sBAAsB,CACvB,GAAG;IACF;;;OAGG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,OAAO,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAC3C;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB"}

package/dist/orchestration-utils.d.ts

@@ -1,8 +1,35 @@
-import type { AzureContentSafety, InputFilteringConfig, OutputFilteringConfig } from './client/api/schema/index.js';
+import type { DocumentGroundingServiceConfig, Prompt, StreamOptions, LlmModuleConfig, OrchestrationModuleConfig } from './orchestration-types.js';
+import type { AzureContentSafety, GroundingModuleConfig, InputFilteringConfig, CompletionPostRequest, FilteringStreamOptions, ModuleConfigs, OrchestrationConfig, OutputFilteringConfig } from './client/api/schema/index.js';
+/**
+ * @internal
+ */
+export declare function constructCompletionPostRequestFromJsonModuleConfig(config: Record<string, any>, prompt?: Prompt, stream?: boolean): Record<string, any>;
+/**
+ * @internal
+ */
+export declare function addStreamOptionsToLlmModuleConfig(llmModuleConfig: LlmModuleConfig, streamOptions?: StreamOptions): LlmModuleConfig;
+/**
+ * @internal
+ */
+export declare function addStreamOptionsToOutputFilteringConfig(outputFilteringConfig: OutputFilteringConfig, filteringStreamOptions: FilteringStreamOptions): OutputFilteringConfig;
+/**
+ * @internal
+ */
+export declare function addStreamOptions(moduleConfigs: ModuleConfigs, streamOptions?: StreamOptions): OrchestrationConfig;
+/**
+ * @internal
+ */
+export declare function constructCompletionPostRequest(config: OrchestrationModuleConfig, prompt?: Prompt, stream?: boolean, streamOptions?: StreamOptions): CompletionPostRequest;
 /**
  * Convenience function to create Azure content filters.
  * @param filter - Filtering configuration for Azure filter. If skipped, the default Azure content filter configuration is used.
  * @returns An object with the Azure filtering configuration.
  */
 export declare function buildAzureContentFilter(filter?: AzureContentSafety): InputFilteringConfig | OutputFilteringConfig;
+/**
+ * Convenience function to create Document Grounding configuration.
+ * @param groundingConfig - Configuration for the document grounding service.
+ * @returns An object with the full grounding configuration.
+ */
+export declare function buildDocumentGroundingConfig(groundingConfig: DocumentGroundingServiceConfig): GroundingModuleConfig;
 //# sourceMappingURL=orchestration-utils.d.ts.map

package/dist/orchestration-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"orchestration-utils.d.ts","sourceRoot":"","sources":["../src/orchestration-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,8BAA8B,CAAC;AAEtC;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,CAAC,EAAE,kBAAkB,GAC1B,oBAAoB,GAAG,qBAAqB,CAY9C"}
+{"version":3,"file":"orchestration-utils.d.ts","sourceRoot":"","sources":["../src/orchestration-utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,8BAA8B,EAC9B,MAAM,EACN,aAAa,EACb,eAAe,EACf,yBAAyB,EAC1B,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,aAAa,EACb,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,8BAA8B,CAAC;AAOtC;;GAEG;AACH,wBAAgB,kDAAkD,CAChE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,MAAM,CAAC,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,OAAO,GACf,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAarB;AAED;;GAEG;AACH,wBAAgB,iCAAiC,CAC/C,eAAe,EAAE,eAAe,EAChC,aAAa,CAAC,EAAE,aAAa,GAC5B,eAAe,CAiBjB;AAED;;GAEG;AACH,wBAAgB,uCAAuC,CACrD,qBAAqB,EAAE,qBAAqB,EAC5C,sBAAsB,EAAE,sBAAsB,GAC7C,qBAAqB,CAQvB;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,aAAa,EAAE,aAAa,EAC5B,aAAa,CAAC,EAAE,aAAa,GAC5B,mBAAmB,CAgCrB;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,yBAAyB,EACjC,MAAM,CAAC,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,OAAO,EAChB,aAAa,CAAC,EAAE,aAAa,GAC5B,qBAAqB,CA6BvB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,CAAC,EAAE,kBAAkB,GAC1B,oBAAoB,GAAG,qBAAqB,CAY9C;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAC1C,eAAe,EAAE,8BAA8B,GAC9C,qBAAqB,CAcvB"}

package/dist/orchestration-utils.js

@@ -1,3 +1,116 @@
+import { createLogger } from '@sap-cloud-sdk/util';
+const logger = createLogger({
+    package: 'orchestration',
+    messageContext: 'orchestration-utils'
+});
+/**
+ * @internal
+ */
+export function constructCompletionPostRequestFromJsonModuleConfig(config, prompt, stream) {
+    const orchestration_config = { ...config };
+    if (stream) {
+        orchestration_config.stream = true;
+    }
+    else {
+        delete orchestration_config.stream;
+    }
+    return {
+        messages_history: prompt?.messagesHistory || [],
+        input_params: prompt?.inputParams || {},
+        orchestration_config
+    };
+}
+/**
+ * @internal
+ */
+export function addStreamOptionsToLlmModuleConfig(llmModuleConfig, streamOptions) {
+    if (streamOptions?.llm === null) {
+        return llmModuleConfig;
+    }
+    return {
+        ...llmModuleConfig,
+        model_params: {
+            ...llmModuleConfig.model_params,
+            ...(streamOptions?.llm !== null && {
+                stream_options: {
+                    include_usage: true,
+                    ...(llmModuleConfig.model_params?.stream_options || {}),
+                    ...(streamOptions?.llm || {})
+                }
+            })
+        }
+    };
+}
+/**
+ * @internal
+ */
+export function addStreamOptionsToOutputFilteringConfig(outputFilteringConfig, filteringStreamOptions) {
+    return {
+        ...outputFilteringConfig,
+        stream_options: {
+            ...(outputFilteringConfig.stream_options || {}),
+            ...filteringStreamOptions
+        }
+    };
+}
+/**
+ * @internal
+ */
+export function addStreamOptions(moduleConfigs, streamOptions) {
+    const { llm_module_config, filtering_module_config } = moduleConfigs;
+    const outputFiltering = streamOptions?.outputFiltering;
+    const globalOptions = streamOptions?.global;
+    if (!moduleConfigs?.filtering_module_config?.output && outputFiltering) {
+        logger.warn('Output filter stream options are not applied because filtering module is not configured.');
+    }
+    return {
+        stream: true,
+        ...(globalOptions && { stream_options: globalOptions }),
+        module_configurations: {
+            ...moduleConfigs,
+            llm_module_config: addStreamOptionsToLlmModuleConfig(llm_module_config, streamOptions),
+            ...(outputFiltering &&
+                filtering_module_config?.output && {
+                filtering_module_config: {
+                    ...filtering_module_config,
+                    output: addStreamOptionsToOutputFilteringConfig(filtering_module_config.output, outputFiltering)
+                }
+            })
+        }
+    };
+}
+/**
+ * @internal
+ */
+export function constructCompletionPostRequest(config, prompt, stream, streamOptions) {
+    const moduleConfigurations = {
+        templating_module_config: config.templating,
+        llm_module_config: config.llm,
+        ...(config?.filtering &&
+            Object.keys(config.filtering).length && {
+            filtering_module_config: config.filtering
+        }),
+        ...(config?.masking &&
+            Object.keys(config.masking).length && {
+            masking_module_config: config.masking
+        }),
+        ...(config?.grounding &&
+            Object.keys(config.grounding).length && {
+            grounding_module_config: config.grounding
+        })
+    };
+    return {
+        orchestration_config: stream
+            ? addStreamOptions(moduleConfigurations, streamOptions)
+            : { module_configurations: moduleConfigurations },
+        ...(prompt?.inputParams && {
+            input_params: prompt.inputParams
+        }),
+        ...(prompt?.messagesHistory && {
+            messages_history: prompt.messagesHistory
+        })
+    };
+}
 /**
  * Convenience function to create Azure content filters.
  * @param filter - Filtering configuration for Azure filter. If skipped, the default Azure content filter configuration is used.
@@ -16,4 +129,24 @@ export function buildAzureContentFilter(filter) {
         ]
     };
 }
+/**
+ * Convenience function to create Document Grounding configuration.
+ * @param groundingConfig - Configuration for the document grounding service.
+ * @returns An object with the full grounding configuration.
+ */
+export function buildDocumentGroundingConfig(groundingConfig) {
+    return {
+        type: 'document_grounding_service',
+        config: {
+            input_params: groundingConfig.input_params,
+            output_param: groundingConfig.output_param,
+            ...(groundingConfig.filters && {
+                filters: groundingConfig.filters?.map(filter => ({
+                    data_repository_type: 'vector',
+                    ...filter
+                }))
+            })
+        }
+    };
+}
 //# sourceMappingURL=orchestration-utils.js.map

package/dist/orchestration-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"orchestration-utils.js","sourceRoot":"","sources":["../src/orchestration-utils.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAA2B;IAE3B,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,sBAAsB;gBAC5B,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;aAClC;SACF;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"orchestration-utils.js","sourceRoot":"","sources":["../src/orchestration-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAmBnD,MAAM,MAAM,GAAG,YAAY,CAAC;IAC1B,OAAO,EAAE,eAAe;IACxB,cAAc,EAAE,qBAAqB;CACtC,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,UAAU,kDAAkD,CAChE,MAA2B,EAC3B,MAAe,EACf,MAAgB;IAEhB,MAAM,oBAAoB,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;IAC3C,IAAI,MAAM,EAAE,CAAC;QACX,oBAAoB,CAAC,MAAM,GAAG,IAAI,CAAC;IACrC,CAAC;SAAM,CAAC;QACN,OAAO,oBAAoB,CAAC,MAAM,CAAC;IACrC,CAAC;IAED,OAAO;QACL,gBAAgB,EAAE,MAAM,EAAE,eAAe,IAAI,EAAE;QAC/C,YAAY,EAAE,MAAM,EAAE,WAAW,IAAI,EAAE;QACvC,oBAAoB;KACrB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iCAAiC,CAC/C,eAAgC,EAChC,aAA6B;IAE7B,IAAI,aAAa,EAAE,GAAG,KAAK,IAAI,EAAE,CAAC;QAChC,OAAO,eAAe,CAAC;IACzB,CAAC;IACD,OAAO;QACL,GAAG,eAAe;QAClB,YAAY,EAAE;YACZ,GAAG,eAAe,CAAC,YAAY;YAC/B,GAAG,CAAC,aAAa,EAAE,GAAG,KAAK,IAAI,IAAI;gBACjC,cAAc,EAAE;oBACd,aAAa,EAAE,IAAI;oBACnB,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,cAAc,IAAI,EAAE,CAAC;oBACvD,GAAG,CAAC,aAAa,EAAE,GAAG,IAAI,EAAE,CAAC;iBAC9B;aACF,CAAC;SACH;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uCAAuC,CACrD,qBAA4C,EAC5C,sBAA8C;IAE9C,OAAO;QACL,GAAG,qBAAqB;QACxB,cAAc,EAAE;YACd,GAAG,CAAC,qBAAqB,CAAC,cAAc,IAAI,EAAE,CAAC;YAC/C,GAAG,sBAAsB;SAC1B;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC9B,aAA4B,EAC5B,aAA6B;IAE7B,MAAM,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,GAAG,aAAa,CAAC;IACrE,MAAM,eAAe,GAAG,aAAa,EAAE,eAAe,CAAC;IACvD,MAAM,aAAa,GAAG,aAAa,EAAE,MAAM,CAAC;IAE5C,IAAI,CAAC,aAAa,EAAE,uBAAuB,EAAE,MAAM,IAAI,eAAe,EAAE,CAAC;QACvE,MAAM,CAAC,IAAI,CACT,0FAA0F,CAC3F,CAAC;IACJ,CAAC;IAED,OAAO;QACL,MAAM,EAAE,IAAI;QACZ,GAAG,CAAC,aAAa,IAAI,EAAE,cAAc,EAAE,aAAa,EAAE,CAAC;QACvD,qBAAqB,EAAE;YACrB,GAAG,aAAa;YAChB,iBAAiB,EAAE,iCAAiC,CAClD,iBAAiB,EACjB,aAAa,CACd;YACD,GAAG,CAAC,eAAe;gBACjB,uBAAuB,EAAE,MAAM,IAAI;gBACjC,uBAAuB,EAAE;oBACvB,GAAG,uBAAuB;oBAC1B,MAAM,EAAE,uCAAuC,CAC7C,uBAAuB,CAAC,MAAM,EAC9B,eAAe,CAChB;iBACF;aACF,CAAC;SACL;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAC5C,MAAiC,EACjC,MAAe,EACf,MAAgB,EAChB,aAA6B;IAE7B,MAAM,oBAAoB,GAAG;QAC3B,wBAAwB,EAAE,MAAM,CAAC,UAAU;QAC3C,iBAAiB,EAAE,MAAM,CAAC,GAAG;QAC7B,GAAG,CAAC,MAAM,EAAE,SAAS;YACnB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,IAAI;YACtC,uBAAuB,EAAE,MAAM,CAAC,SAAS;SAC1C,CAAC;QACJ,GAAG,CAAC,MAAM,EAAE,OAAO;YACjB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,IAAI;YACpC,qBAAqB,EAAE,MAAM,CAAC,OAAO;SACtC,CAAC;QACJ,GAAG,CAAC,MAAM,EAAE,SAAS;YACnB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,IAAI;YACtC,uBAAuB,EAAE,MAAM,CAAC,SAAS;SAC1C,CAAC;KACL,CAAC;IAEF,OAAO;QACL,oBAAoB,EAAE,MAAM;YAC1B,CAAC,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,aAAa,CAAC;YACvD,CAAC,CAAC,EAAE,qBAAqB,EAAE,oBAAoB,EAAE;QACnD,GAAG,CAAC,MAAM,EAAE,WAAW,IAAI;YACzB,YAAY,EAAE,MAAM,CAAC,WAAW;SACjC,CAAC;QACF,GAAG,CAAC,MAAM,EAAE,eAAe,IAAI;YAC7B,gBAAgB,EAAE,MAAM,CAAC,eAAe;SACzC,CAAC;KACH,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAA2B;IAE3B,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,sBAAsB;gBAC5B,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;aAClC;SACF;KACF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAC1C,eAA+C;IAE/C,OAAO;QACL,IAAI,EAAE,4BAA4B;QAClC,MAAM,EAAE;YACN,YAAY,EAAE,eAAe,CAAC,YAAY;YAC1C,YAAY,EAAE,eAAe,CAAC,YAAY;YAC1C,GAAG,CAAC,eAAe,CAAC,OAAO,IAAI;gBAC7B,OAAO,EAAE,eAAe,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBAC/C,oBAAoB,EAAE,QAAQ;oBAC9B,GAAG,MAAM;iBACV,CAAC,CAAC;aACJ,CAAC;SACH;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ai-sdk/orchestration",
-  "version": "1.5.1-20250113013141.0",
+  "version": "1.6.0",
   "description": "",
   "license": "Apache-2.0",
   "keywords": [
@@ -20,10 +20,13 @@
     "internal.d.ts"
   ],
   "dependencies": {
+    "@sap-cloud-sdk/util": "^3.25.0",
+    "@sap-ai-sdk/core": "^1.6.0",
+    "@sap-ai-sdk/ai-api": "^1.6.0"
+  },
+  "devDependencies": {
     "@sap-cloud-sdk/http-client": "^3.25.0",
-    "@sap-cloud-sdk/connectivity": "^3.25.0",
-    "@sap-ai-sdk/core": "^1.5.1-20250113013141.0",
-    "@sap-ai-sdk/ai-api": "^1.5.1-20250113013141.0"
+    "@sap-cloud-sdk/connectivity": "^3.25.0"
   },
   "scripts": {
     "compile": "tsc",