add tests and docs

packages/orchestration/README.md

@@ -175,9 +175,10 @@ Abort controller can be useful, e.g., when end-user wants to stop the stream or
 #### Stream Options
 
 The orchestration service offers multiple streaming options, which you can configure in addition to the LLM's streaming options.
-There are two ways to add specific streaming options to your client, either at initalization, or dynamically when calling the stream API.
+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.
 
-Dynamically setting these options after client initialization is particularly helpful when you've initialized a client with a config meant for regular chat completion and now want to switch to using streaming.
+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).
 
@@ -197,8 +198,8 @@ const response = orchestrationClient.stream(
 );
 ```
 
-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 options.llm = null.
+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.

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

@@ -435,4 +435,6 @@ describe('orchestration service client', () => {
       'Could not parse JSON'
     );
   });
+
+  // add test for executing streaming with options with a JSON client, check for warning log<f
 });

packages/orchestration/src/orchestration-stream-chunk-response.test.ts

@@ -3,8 +3,7 @@ import { OrchestrationStreamChunkResponse } from './orchestration-stream-chunk-r
 
 describe('Orchestration chat completion stream chunk response', () => {
   let mockResponses: {
-    tokenUsageResponse: any;
-    finishReasonResponse: any;
+    tokenUsageAndFinishReasonResponse: any;
     deltaContentResponse: any;
   };
   let orchestrationStreamChunkResponses: {
@@ -15,13 +14,9 @@ describe('Orchestration chat completion stream chunk response', () => {
 
   beforeAll(async () => {
     mockResponses = {
-      tokenUsageResponse: await parseMockResponse<any>(
+      tokenUsageAndFinishReasonResponse: await parseMockResponse<any>(
         'orchestration',
-        'orchestration-chat-completion-stream-chunk-response-token-usage.json'
-      ),
-      finishReasonResponse: await parseMockResponse<any>(
-        'orchestration',
-        'orchestration-chat-completion-stream-chunk-response-finish-reason.json'
+        'orchestration-chat-completion-stream-chunk-response-token-usage-and-finish-reason.json'
       ),
       deltaContentResponse: await parseMockResponse<any>(
         'orchestration',
@@ -30,10 +25,10 @@ describe('Orchestration chat completion stream chunk response', () => {
     };
     orchestrationStreamChunkResponses = {
       tokenUsageResponse: new OrchestrationStreamChunkResponse(
-        mockResponses.tokenUsageResponse
+        mockResponses.tokenUsageAndFinishReasonResponse
       ),
       finishReasonResponse: new OrchestrationStreamChunkResponse(
-        mockResponses.finishReasonResponse
+        mockResponses.tokenUsageAndFinishReasonResponse
       ),
       deltaContentResponse: new OrchestrationStreamChunkResponse(
         mockResponses.deltaContentResponse
@@ -44,10 +39,10 @@ describe('Orchestration chat completion stream chunk response', () => {
   it('should return the chat completion stream chunk response', () => {
     expect(
       orchestrationStreamChunkResponses.tokenUsageResponse.data
-    ).toStrictEqual(mockResponses.tokenUsageResponse);
+    ).toStrictEqual(mockResponses.tokenUsageAndFinishReasonResponse);
     expect(
       orchestrationStreamChunkResponses.finishReasonResponse.data
-    ).toStrictEqual(mockResponses.finishReasonResponse);
+    ).toStrictEqual(mockResponses.tokenUsageAndFinishReasonResponse);
     expect(
       orchestrationStreamChunkResponses.deltaContentResponse.data
     ).toStrictEqual(mockResponses.deltaContentResponse);

packages/orchestration/src/orchestration-utils.temp.ts

@@ -0,0 +1,4 @@
+// create complete config
+// test with config + addStreamOptionsToLlmModuleConfig
+// test with config + addStreamOptionsToOutputFilteringConfig
+// test complete flo with addStreamOptions

packages/orchestration/tsconfig.json

@@ -6,7 +6,7 @@
     "tsBuildInfoFile": "./dist/.tsbuildinfo",
     "composite": true
   },
-  "include": ["src/**/*.ts"],
+  "include": ["src/**/*.ts", "src/orchestration-utils.temp.ts"],
   "exclude": ["dist/**/*", "test/**/*", "**/*.test.ts", "node_modules/**/*"],
   "references": [{ "path": "../core" }, { "path": "../ai-api" }]
 }