@sap-ai-sdk/orchestration 0.1.0

package/dist/orchestration-client.d.ts

@@ -0,0 +1,30 @@
+import { CustomRequestConfig } from '@sap-ai-sdk/core';
+import { ResourceGroupConfiguration } from '@sap-ai-sdk/ai-api/internal.js';
+import { CompletionPostRequest } from './client/api/schema/index.js';
+import { OrchestrationModuleConfig, Prompt } from './orchestration-types.js';
+import { OrchestrationResponse } from './orchestration-response.js';
+/**
+ * Get the orchestration client.
+ */
+export declare class OrchestrationClient {
+    private config;
+    private deploymentConfig?;
+    /**
+     * Creates an instance of the orchestration client.
+     * @param config - Orchestration module configuration.
+     * @param deploymentConfig - Deployment configuration.
+     */
+    constructor(config: OrchestrationModuleConfig, deploymentConfig?: ResourceGroupConfiguration | 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>;
+}
+/**
+ * @internal
+ */
+export declare function constructCompletionPostRequest(config: OrchestrationModuleConfig, prompt?: Prompt): CompletionPostRequest;
+//# sourceMappingURL=orchestration-client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-client.d.ts","sourceRoot":"","sources":["../src/orchestration-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAEL,0BAA0B,EAC3B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,yBAAyB,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;GAEG;AACH,qBAAa,mBAAmB;IAO5B,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,gBAAgB,CAAC;IAP3B;;;;OAIG;gBAEO,MAAM,EAAE,yBAAyB,EACjC,gBAAgB,CAAC,EAAE,0BAA0B,YAAA;IAGvD;;;;;OAKG;IACG,cAAc,CAClB,MAAM,CAAC,EAAE,MAAM,EACf,aAAa,CAAC,EAAE,mBAAmB,GAClC,OAAO,CAAC,qBAAqB,CAAC;CAiBlC;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,yBAAyB,EACjC,MAAM,CAAC,EAAE,MAAM,GACd,qBAAqB,CAoBvB"}

package/dist/orchestration-client.js

@@ -0,0 +1,61 @@
+import { executeRequest } from '@sap-ai-sdk/core';
+import { resolveDeploymentId } from '@sap-ai-sdk/ai-api/internal.js';
+import { OrchestrationResponse } from './orchestration-response.js';
+/**
+ * Get the orchestration client.
+ */
+export class OrchestrationClient {
+    config;
+    deploymentConfig;
+    /**
+     * Creates an instance of the orchestration client.
+     * @param config - Orchestration module configuration.
+     * @param deploymentConfig - Deployment configuration.
+     */
+    constructor(config, deploymentConfig) {
+        this.config = config;
+        this.deploymentConfig = deploymentConfig;
+    }
+    /**
+     * Creates a completion for the chat messages.
+     * @param prompt - Prompt configuration.
+     * @param requestConfig - Request configuration.
+     * @returns The completion result.
+     */
+    async chatCompletion(prompt, requestConfig) {
+        const body = constructCompletionPostRequest(this.config, prompt);
+        const deploymentId = await resolveDeploymentId({
+            scenarioId: 'orchestration',
+            resourceGroup: this.deploymentConfig?.resourceGroup
+        });
+        const response = await executeRequest({
+            url: `/inference/deployments/${deploymentId}/completion`
+        }, body, requestConfig);
+        return new OrchestrationResponse(response);
+    }
+}
+/**
+ * @internal
+ */
+export function constructCompletionPostRequest(config, prompt) {
+    return {
+        orchestration_config: {
+            module_configurations: {
+                templating_module_config: {
+                    template: config.templatingConfig.template
+                },
+                llm_module_config: config.llmConfig,
+                ...(Object.keys(config?.filterConfig || {}).length && {
+                    filtering_module_config: config.filterConfig
+                })
+            }
+        },
+        ...(prompt?.inputParams && {
+            input_params: prompt.inputParams
+        }),
+        ...(prompt?.messagesHistory && {
+            messages_history: prompt.messagesHistory
+        })
+    };
+}
+//# sourceMappingURL=orchestration-client.js.map

package/dist/orchestration-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-client.js","sourceRoot":"","sources":["../src/orchestration-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAuB,MAAM,kBAAkB,CAAC;AACvE,OAAO,EACL,mBAAmB,EAEpB,MAAM,gCAAgC,CAAC;AAGxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAOpB;IACA;IAPV;;;;OAIG;IACH,YACU,MAAiC,EACjC,gBAA6C;QAD7C,WAAM,GAAN,MAAM,CAA2B;QACjC,qBAAgB,GAAhB,gBAAgB,CAA6B;IACpD,CAAC;IAEJ;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,MAAe,EACf,aAAmC;QAEnC,MAAM,IAAI,GAAG,8BAA8B,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACjE,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;SACzD,EACD,IAAI,EACJ,aAAa,CACd,CAAC;QAEF,OAAO,IAAI,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAC5C,MAAiC,EACjC,MAAe;IAEf,OAAO;QACL,oBAAoB,EAAE;YACpB,qBAAqB,EAAE;gBACrB,wBAAwB,EAAE;oBACxB,QAAQ,EAAE,MAAM,CAAC,gBAAgB,CAAC,QAAQ;iBAC3C;gBACD,iBAAiB,EAAE,MAAM,CAAC,SAAS;gBACnC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI;oBACpD,uBAAuB,EAAE,MAAM,CAAC,YAAY;iBAC7C,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"}

package/dist/orchestration-filter-utility.d.ts

@@ -0,0 +1,8 @@
+import { AzureContentSafety, FilteringConfig } from './client/api/index.js';
+/**
+ * Convenience function to create Azure filters.
+ * @param filter - Filtering configuration for Azure filter. If skipped, the default Azure filter configuration is used.
+ * @returns An object with the Azure filtering configuration.
+ */
+export declare function azureContentFilter(filter?: AzureContentSafety): FilteringConfig;
+//# sourceMappingURL=orchestration-filter-utility.d.ts.map

package/dist/orchestration-filter-utility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-filter-utility.d.ts","sourceRoot":"","sources":["../src/orchestration-filter-utility.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE5E;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAYjB"}

package/dist/orchestration-filter-utility.js

@@ -0,0 +1,19 @@
+/**
+ * Convenience function to create Azure filters.
+ * @param filter - Filtering configuration for Azure filter. If skipped, the default Azure filter configuration is used.
+ * @returns An object with the Azure filtering configuration.
+ */
+export function azureContentFilter(filter) {
+    if (filter && !Object.keys(filter).length) {
+        throw new Error('Filter property cannot be an empty object');
+    }
+    return {
+        filters: [
+            {
+                type: 'azure_content_safety',
+                ...(filter && { config: filter })
+            }
+        ]
+    };
+}
+//# sourceMappingURL=orchestration-filter-utility.js.map

package/dist/orchestration-filter-utility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-filter-utility.js","sourceRoot":"","sources":["../src/orchestration-filter-utility.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAChC,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"}

package/dist/orchestration-response.d.ts

@@ -0,0 +1,33 @@
+import { HttpResponse } from '@sap-cloud-sdk/http-client';
+import { CompletionPostResponse, TokenUsage } from './client/api/schema/index.js';
+/**
+ * Representation of an orchestration response.
+ */
+export declare class OrchestrationResponse {
+    readonly rawResponse: HttpResponse;
+    /**
+     * The completion post response.
+     */
+    readonly data: CompletionPostResponse;
+    constructor(rawResponse: HttpResponse);
+    /**
+     * Usage of tokens in the response.
+     * @returns Token usage.
+     */
+    getTokenUsage(): TokenUsage;
+    /**
+     * Reason for stopping the completion.
+     * @param choiceIndex - The index of the choice to parse.
+     * @returns The finish reason.
+     */
+    getFinishReason(choiceIndex?: number): string | undefined;
+    /**
+     * Parses the orchestration response and returns the content.
+     * @param choiceIndex - The index of the choice to parse.
+     * @returns The message content.
+     */
+    getContent(choiceIndex?: number): string | undefined;
+    private getChoices;
+    private logInvalidChoiceIndex;
+}
+//# sourceMappingURL=orchestration-response.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-response.d.ts","sourceRoot":"","sources":["../src/orchestration-response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,OAAO,EACL,sBAAsB,EACtB,UAAU,EACX,MAAM,8BAA8B,CAAC;AAOtC;;GAEG;AACH,qBAAa,qBAAqB;aAKJ,WAAW,EAAE,YAAY;IAJrD;;OAEG;IACH,SAAgB,IAAI,EAAE,sBAAsB,CAAC;gBACjB,WAAW,EAAE,YAAY;IAIrD;;;OAGG;IACH,aAAa,IAAI,UAAU;IAG3B;;;;OAIG;IACH,eAAe,CAAC,WAAW,SAAI,GAAG,MAAM,GAAG,SAAS;IAKpD;;;;OAIG;IACH,UAAU,CAAC,WAAW,SAAI,GAAG,MAAM,GAAG,SAAS;IAa/C,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,qBAAqB;CAK9B"}

package/dist/orchestration-response.js

@@ -0,0 +1,57 @@
+import { createLogger } from '@sap-cloud-sdk/util';
+const logger = createLogger({
+    package: 'gen-ai-hub',
+    messageContext: 'orchestration-response'
+});
+/**
+ * Representation of an orchestration response.
+ */
+export class OrchestrationResponse {
+    rawResponse;
+    /**
+     * The completion post response.
+     */
+    data;
+    constructor(rawResponse) {
+        this.rawResponse = rawResponse;
+        this.data = rawResponse.data;
+    }
+    /**
+     * Usage of tokens in the response.
+     * @returns Token usage.
+     */
+    getTokenUsage() {
+        return this.data.orchestration_result.usage;
+    }
+    /**
+     * Reason for stopping the completion.
+     * @param choiceIndex - The index of the choice to parse.
+     * @returns The finish reason.
+     */
+    getFinishReason(choiceIndex = 0) {
+        this.logInvalidChoiceIndex(choiceIndex);
+        return this.getChoices()[choiceIndex]?.finish_reason;
+    }
+    /**
+     * Parses the orchestration response and returns the content.
+     * @param choiceIndex - The index of the choice to parse.
+     * @returns The message content.
+     */
+    getContent(choiceIndex = 0) {
+        this.logInvalidChoiceIndex(choiceIndex);
+        if (this.getChoices()[choiceIndex]?.message?.content === '' &&
+            this.getChoices()[choiceIndex]?.finish_reason === 'content_filter') {
+            throw new Error('Content generated by the LLM was filtered by the output filter. Please try again with a different prompt or filter configuration.');
+        }
+        return this.getChoices()[choiceIndex]?.message?.content;
+    }
+    getChoices() {
+        return this.data.orchestration_result.choices;
+    }
+    logInvalidChoiceIndex(choiceIndex) {
+        if (choiceIndex < 0 || choiceIndex >= this.getChoices().length) {
+            logger.error(`Choice index ${choiceIndex} is out of bounds.`);
+        }
+    }
+}
+//# sourceMappingURL=orchestration-response.js.map

package/dist/orchestration-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-response.js","sourceRoot":"","sources":["../src/orchestration-response.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAMnD,MAAM,MAAM,GAAG,YAAY,CAAC;IAC1B,OAAO,EAAE,YAAY;IACrB,cAAc,EAAE,wBAAwB;CACzC,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAKJ;IAJ5B;;OAEG;IACa,IAAI,CAAyB;IAC7C,YAA4B,WAAyB;QAAzB,gBAAW,GAAX,WAAW,CAAc;QACnD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC;IAC9C,CAAC;IACD;;;;OAIG;IACH,eAAe,CAAC,WAAW,GAAG,CAAC;QAC7B,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,WAAW,GAAG,CAAC;QACxB,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;QACxC,IACE,IAAI,CAAC,UAAU,EAAE,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,OAAO,KAAK,EAAE;YACvD,IAAI,CAAC,UAAU,EAAE,CAAC,WAAW,CAAC,EAAE,aAAa,KAAK,gBAAgB,EAClE,CAAC;YACD,MAAM,IAAI,KAAK,CACb,mIAAmI,CACpI,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC;IAC1D,CAAC;IAEO,UAAU;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC;IAChD,CAAC;IAEO,qBAAqB,CAAC,WAAmB;QAC/C,IAAI,WAAW,GAAG,CAAC,IAAI,WAAW,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,CAAC;YAC/D,MAAM,CAAC,KAAK,CAAC,gBAAgB,WAAW,oBAAoB,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;CACF"}

package/dist/orchestration-types.d.ts

@@ -0,0 +1,36 @@
+import { ChatMessages, FilteringModuleConfig, LLMModuleConfig, TemplatingModuleConfig } from './client/api/index.js';
+/**
+ * Prompt configuration.
+ */
+export interface Prompt {
+    /**
+     * History.
+     */
+    messagesHistory?: ChatMessages;
+    /**
+     * Template parameters.
+     */
+    inputParams?: Record<string, string>;
+}
+/**
+ * LLMModule configuration.
+ */
+export type LlmConfig = LLMModuleConfig;
+/**
+ * Orchestration module configuration.
+ */
+export interface OrchestrationModuleConfig {
+    /**
+     * Templating configuration options.
+     */
+    templatingConfig: TemplatingModuleConfig;
+    /**
+     * Llm configuration options.
+     */
+    llmConfig: LlmConfig;
+    /**
+     * Filter configuration options.
+     */
+    filterConfig?: FilteringModuleConfig;
+}
+//# sourceMappingURL=orchestration-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-types.d.ts","sourceRoot":"","sources":["../src/orchestration-types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,qBAAqB,EACrB,eAAe,EACf,sBAAsB,EACvB,MAAM,uBAAuB,CAAC;AAE/B;;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;AAGD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,eAAe,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,yBAAyB;IAExC;;OAEG;IACH,gBAAgB,EAAE,sBAAsB,CAAC;IACzC;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,qBAAqB,CAAC;CACtC"}

package/dist/orchestration-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=orchestration-types.js.map

package/dist/orchestration-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"orchestration-types.js","sourceRoot":"","sources":["../src/orchestration-types.ts"],"names":[],"mappings":""}

package/internal.d.ts

@@ -0,0 +1,3 @@
+// eslint-disable-next-line import/no-internal-modules
+export * from './dist/internal.js';
+// # sourceMappingURL=internal.d.ts.map

package/internal.js

@@ -0,0 +1,2 @@
+export * from './dist/internal.js';
+//# sourceMappingURL=internal.js.map

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@sap-ai-sdk/orchestration",
+  "version": "0.1.0",
+  "description": "",
+  "license": "Apache-2.0",
+  "keywords": [
+    "sap-ai-sdk",
+    "orchestration",
+    "llm-access"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map",
+    "internal.js",
+    "internal.d.ts"
+  ],
+  "dependencies": {
+    "@sap-cloud-sdk/http-client": "^3.20.0",
+    "@sap-cloud-sdk/connectivity": "^3.20.0",
+    "@sap-cloud-sdk/util": "^3.20.0",
+    "@sap-cloud-sdk/openapi": "^3.20.0",
+    "@sap-ai-sdk/core": "^0.1.0",
+    "@sap-ai-sdk/ai-api": "^0.1.0"
+  },
+  "devDependencies": {
+    "@sap-cloud-sdk/openapi-generator": "^3.20.0",
+    "typescript": "^5.5.4",
+    "nock": "^13.5.5"
+  },
+  "scripts": {
+    "compile": "tsc",
+    "compile:cjs": "tsc -p tsconfig.cjs.json",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "lint": "eslint \"**/*.ts\" && prettier . --config ../../.prettierrc --ignore-path ../../.prettierignore -c",
+    "lint:fix": "eslint \"**/*.ts\" --fix && prettier . --config ../../.prettierrc --ignore-path ../../.prettierignore -w --log-level error",
+    "generate": "openapi-generator --generateESM --clearOutputDir -i ./src/spec/api.yaml -o ./src/client && pnpm lint:fix",
+    "check:public-api": "node --loader ts-node/esm ../../scripts/check-public-api-cli.ts"
+  }
+}