@jerome-benoit/sap-ai-provider 4.0.0-rc.2 → 4.0.0

package/README.md

@@ -347,10 +347,7 @@ const dpiConfig = buildDpiMaskingProvider({
 
 ```typescript
 import "dotenv/config"; // Load environment variables
-import {
-  createSAPAIProvider,
-  buildAzureContentSafetyFilter,
-} from "@mymediset/sap-ai-provider";
+import { createSAPAIProvider, buildAzureContentSafetyFilter } from "@mymediset/sap-ai-provider";
 
 const provider = createSAPAIProvider({
   defaultSettings: {
@@ -521,14 +518,16 @@ Error code reference table: [API Reference - HTTP Status Codes](./API_REFERENCE.
 
 The `examples/` directory contains complete, runnable examples demonstrating key features:
 
-| Example                             | Description                 | Key Features                           |
-| ----------------------------------- | --------------------------- | -------------------------------------- |
-| `example-generate-text.ts`          | Basic text generation       | Simple prompts, synchronous generation |
-| `example-simple-chat-completion.ts` | Simple chat conversation    | System messages, user prompts          |
-| `example-chat-completion-tool.ts`   | Tool calling with functions | Weather API tool, function execution   |
-| `example-streaming-chat.ts`         | Streaming responses         | Real-time text generation, SSE         |
-| `example-image-recognition.ts`      | Multi-modal with images     | Vision models, image analysis          |
-| `example-data-masking.ts`           | Data privacy integration    | DPI masking, anonymization             |
+| Example                             | Description                 | Key Features                            |
+| ----------------------------------- | --------------------------- | --------------------------------------- |
+| `example-generate-text.ts`          | Basic text generation       | Simple prompts, synchronous generation  |
+| `example-simple-chat-completion.ts` | Simple chat conversation    | System messages, user prompts           |
+| `example-chat-completion-tool.ts`   | Tool calling with functions | Weather API tool, function execution    |
+| `example-streaming-chat.ts`         | Streaming responses         | Real-time text generation, SSE          |
+| `example-image-recognition.ts`      | Multi-modal with images     | Vision models, image analysis           |
+| `example-data-masking.ts`           | Data privacy integration    | DPI masking, anonymization              |
+| `example-document-grounding.ts`     | Document grounding (RAG)    | Vector store, retrieval-augmented gen   |
+| `example-translation.ts`            | Input/output translation    | Multi-language support, SAP translation |
 
 **Running Examples:**
 

package/dist/index.cjs

@@ -29910,9 +29910,7 @@ function convertToSAPMessages(prompt, options = {}) {
       }
       default: {
         const _exhaustiveCheck = message;
-        throw new Error(
-          `Unsupported role: ${_exhaustiveCheck.role}`
-        );
+        throw new Error(`Unsupported role: ${_exhaustiveCheck.role}`);
       }
     }
   }
@@ -30194,6 +30192,8 @@ var SAPAILanguageModel = class {
    * to SAP AI Core - the request continues executing on the server. This is a
    * limitation of the SAP AI SDK's chatCompletion API.
    *
+   * @see https://github.com/SAP/ai-sdk-js/issues/1429 for tracking true cancellation support
+   *
    * @param options - Generation options including prompt, tools, and settings
    * @returns Promise resolving to the generation result with content, usage, and metadata
    *
@@ -30377,6 +30377,13 @@ var SAPAILanguageModel = class {
    * - Usage format: `{ inputTokens: { total, ... }, outputTokens: { total, ... } }`
    * - Warnings only in `stream-start` event
    *
+   * **Note on Abort Signal:**
+   * The abort signal implementation uses Promise.race to reject the promise when
+   * the signal is aborted. However, this does not cancel the underlying HTTP request
+   * to SAP AI Core - the request continues executing on the server. This is a
+   * limitation of the SAP AI SDK's chatCompletion API.
+   *
+   * @see https://github.com/SAP/ai-sdk-js/issues/1429 for tracking true cancellation support
    * @see {@link https://sdk.vercel.ai/docs/ai-sdk-core/streaming Vercel AI SDK Streaming}
    *
    * @param options - Streaming options including prompt, tools, and settings
@@ -30423,11 +30430,9 @@ var SAPAILanguageModel = class {
           return filtering && Object.keys(filtering).length > 0 ? { filtering } : {};
         })()
       };
-      const streamResponse = await client.stream(
-        requestBody,
-        options.abortSignal,
-        { promptTemplating: { include_usage: true } }
-      );
+      const streamResponse = await client.stream(requestBody, options.abortSignal, {
+        promptTemplating: { include_usage: true }
+      });
       const idGenerator = new StreamIdGenerator();
       let textBlockId = null;
       const streamState = {
@@ -30714,12 +30719,9 @@ var SAPAILanguageModel = class {
           let parameters;
           if (toolWithParams.parameters && isZodSchema(toolWithParams.parameters)) {
             try {
-              const jsonSchema = (0, import_zod_to_json_schema.zodToJsonSchema)(
-                toolWithParams.parameters,
-                {
-                  $refStrategy: "none"
-                }
-              );
+              const jsonSchema = (0, import_zod_to_json_schema.zodToJsonSchema)(toolWithParams.parameters, {
+                $refStrategy: "none"
+              });
               const schemaRecord = jsonSchema;
               delete schemaRecord.$schema;
               parameters = buildSAPToolParameters(schemaRecord);
@@ -30865,11 +30867,7 @@ var SAPAILanguageModel = class {
    * @internal
    */
   createClient(config) {
-    return new import_orchestration.OrchestrationClient(
-      config,
-      this.config.deploymentConfig,
-      this.config.destination
-    );
+    return new import_orchestration.OrchestrationClient(config, this.config.deploymentConfig, this.config.destination);
   }
 };
 function buildSAPToolParameters(schema) {
@@ -30898,9 +30896,7 @@ function buildSAPToolParameters(schema) {
 function createAISDKRequestBodySummary(options) {
   return {
     hasImageParts: options.prompt.some(
-      (message) => message.role === "user" && message.content.some(
-        (part) => part.type === "file" && part.mediaType.startsWith("image/")
-      )
+      (message) => message.role === "user" && message.content.some((part) => part.type === "file" && part.mediaType.startsWith("image/"))
     ),
     maxOutputTokens: options.maxOutputTokens,
     promptMessages: options.prompt.length,
@@ -31019,9 +31015,7 @@ function createSAPAIProvider(options = {}) {
   };
   const provider = function(modelId, settings) {
     if (new.target) {
-      throw new Error(
-        "The SAP AI provider function cannot be called with the new keyword."
-      );
+      throw new Error("The SAP AI provider function cannot be called with the new keyword.");
     }
     return createModel(modelId, settings);
   };