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

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}`);
       }
     }
   }
@@ -29981,18 +29979,29 @@ function convertToAISDKError(error, context) {
   if (error instanceof import_provider2.APICallError || error instanceof import_provider2.LoadAPIKeyError) {
     return error;
   }
-  if (isOrchestrationErrorResponse(error)) {
-    return convertSAPErrorToAPICallError(error, {
+  const rootError = error instanceof Error && (0, import_util.isErrorWithCause)(error) ? error.rootCause : error;
+  if (isOrchestrationErrorResponse(rootError)) {
+    return convertSAPErrorToAPICallError(rootError, {
       ...context,
       responseHeaders: context?.responseHeaders ?? getAxiosResponseHeaders(error)
     });
   }
+  if (rootError instanceof Error) {
+    const parsedError = tryExtractSAPErrorFromMessage(rootError.message);
+    if (parsedError && isOrchestrationErrorResponse(parsedError)) {
+      return convertSAPErrorToAPICallError(parsedError, {
+        ...context,
+        responseHeaders: context?.responseHeaders ?? getAxiosResponseHeaders(error)
+      });
+    }
+  }
   const responseHeaders = context?.responseHeaders ?? getAxiosResponseHeaders(error);
-  if (error instanceof Error) {
-    const errorMsg = error.message.toLowerCase();
-    if (errorMsg.includes("authentication") || errorMsg.includes("unauthorized") || errorMsg.includes("aicore_service_key") || errorMsg.includes("invalid credentials")) {
+  if (rootError instanceof Error) {
+    const errorMsg = rootError.message.toLowerCase();
+    const originalMsg = rootError.message;
+    if (errorMsg.includes("authentication") || errorMsg.includes("unauthorized") || errorMsg.includes("aicore_service_key") || errorMsg.includes("invalid credentials") || errorMsg.includes("service credentials") || errorMsg.includes("service binding")) {
       return new import_provider2.LoadAPIKeyError({
-        message: `SAP AI Core authentication failed: ${error.message}
+        message: `SAP AI Core authentication failed: ${originalMsg}
 
 Make sure your AICORE_SERVICE_KEY environment variable is set correctly.
 See: https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/create-service-key`
@@ -30002,15 +30011,79 @@ See: https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/create-serv
       return new import_provider2.APICallError({
         cause: error,
         isRetryable: true,
-        message: `Network error connecting to SAP AI Core: ${error.message}`,
+        message: `Network error connecting to SAP AI Core: ${originalMsg}`,
         requestBodyValues: context?.requestBody,
         responseHeaders,
         statusCode: 503,
         url: context?.url ?? ""
       });
     }
+    if (errorMsg.includes("could not resolve destination")) {
+      return new import_provider2.APICallError({
+        cause: error,
+        isRetryable: false,
+        message: `SAP AI Core destination error: ${originalMsg}
+
+Check your destination configuration or provide a valid destinationName.`,
+        requestBodyValues: context?.requestBody,
+        responseHeaders,
+        statusCode: 500,
+        url: context?.url ?? ""
+      });
+    }
+    if (errorMsg.includes("failed to resolve deployment") || errorMsg.includes("no deployment matched")) {
+      return new import_provider2.APICallError({
+        cause: error,
+        isRetryable: false,
+        message: `SAP AI Core deployment error: ${originalMsg}
+
+Make sure you have a running orchestration deployment in your AI Core instance.
+See: https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/create-deployment-for-orchestration`,
+        requestBodyValues: context?.requestBody,
+        responseHeaders,
+        statusCode: 404,
+        url: context?.url ?? ""
+      });
+    }
+    if (errorMsg.includes("filtered by the output filter")) {
+      return new import_provider2.APICallError({
+        cause: error,
+        isRetryable: false,
+        message: `Content was filtered: ${originalMsg}
+
+The model's response was blocked by content safety filters. Try a different prompt.`,
+        requestBodyValues: context?.requestBody,
+        responseHeaders,
+        statusCode: 400,
+        url: context?.url ?? ""
+      });
+    }
+    const statusMatch = /status code (\d+)/i.exec(originalMsg);
+    if (statusMatch) {
+      const extractedStatus = parseInt(statusMatch[1], 10);
+      return new import_provider2.APICallError({
+        cause: error,
+        isRetryable: isRetryable(extractedStatus),
+        message: `SAP AI Core request failed: ${originalMsg}`,
+        requestBodyValues: context?.requestBody,
+        responseHeaders,
+        statusCode: extractedStatus,
+        url: context?.url ?? ""
+      });
+    }
+    if (errorMsg.includes("iterate over") || errorMsg.includes("consumed stream") || errorMsg.includes("parse message into json") || errorMsg.includes("no body")) {
+      return new import_provider2.APICallError({
+        cause: error,
+        isRetryable: true,
+        message: `SAP AI Core streaming error: ${originalMsg}`,
+        requestBodyValues: context?.requestBody,
+        responseHeaders,
+        statusCode: 500,
+        url: context?.url ?? ""
+      });
+    }
   }
-  const message = error instanceof Error ? error.message : typeof error === "string" ? error : "Unknown error occurred";
+  const message = rootError instanceof Error ? rootError.message : typeof rootError === "string" ? rootError : "Unknown error occurred";
   const fullMessage = context?.operation ? `SAP AI Core ${context.operation} failed: ${message}` : `SAP AI Core error: ${message}`;
   return new import_provider2.APICallError({
     cause: error,
@@ -30071,13 +30144,35 @@ function normalizeHeaders(headers) {
   if (entries.length === 0) return void 0;
   return Object.fromEntries(entries);
 }
+function tryExtractSAPErrorFromMessage(message) {
+  const jsonMatch = /\{[\s\S]*\}/.exec(message);
+  if (!jsonMatch) return null;
+  try {
+    const parsed = JSON.parse(jsonMatch[0]);
+    if (parsed && typeof parsed === "object" && "error" in parsed) {
+      return parsed;
+    }
+    if (parsed && typeof parsed === "object" && "message" in parsed) {
+      return { error: parsed };
+    }
+    return null;
+  } catch {
+    return null;
+  }
+}
 
 // src/sap-ai-language-model.ts
 var StreamIdGenerator = class {
+  /**
+   * Generates a unique ID for a response stream.
+   * @returns RFC 4122-compliant UUID
+   */
+  generateResponseId() {
+    return crypto.randomUUID();
+  }
   /**
    * Generates a unique ID for a text block.
-   *
-   * @returns RFC 4122-compliant UUID string
+   * @returns RFC 4122-compliant UUID
    */
   generateTextBlockId() {
     return crypto.randomUUID();
@@ -30094,7 +30189,11 @@ var SAPAILanguageModel = class {
    * SAP AI Core will fail the request at runtime.
    */
   supportsImageUrls = true;
-  /** Multiple completions via the `n` parameter (provider-specific support). */
+  /**
+   * Multiple completions via the `n` parameter.
+   * Note: Amazon and Anthropic models do not support this feature.
+   * The provider silently omits the parameter for unsupported models.
+   */
   supportsMultipleCompletions = true;
   /** Parallel tool calls. */
   supportsParallelToolCalls = true;
@@ -30105,52 +30204,14 @@ var SAPAILanguageModel = class {
   /** Tool/function calling. */
   supportsToolCalls = true;
   /**
-   * Generates text completion using SAP AI Core's Orchestration API.
-   *
-   * This method implements the `LanguageModelV3.doGenerate` interface,
-   * providing synchronous (non-streaming) text generation with support for:
-   * - Multi-turn conversations with system/user/assistant messages
-   * - Tool calling (function calling) with structured outputs
-   * - Multi-modal inputs (text + images)
-   * - Data masking via SAP DPI
-   * - Content filtering via Azure Content Safety or Llama Guard
-   *
-   * **Return Structure:**
-   * - Finish reason: `{ unified: string, raw?: string }`
-   * - Usage: Nested structure with token breakdown `{ inputTokens: { total, ... }, outputTokens: { total, ... } }`
-   * - Warnings: Array of warnings with `type` and optional `feature` field
-   *
-   * @param options - Generation options including prompt, tools, temperature, etc.
-   * @returns Promise resolving to generation result with content, usage, and metadata
-   *
-   * @throws {InvalidPromptError} If prompt format is invalid
-   * @throws {InvalidArgumentError} If arguments are malformed
-   * @throws {APICallError} If the SAP AI Core API call fails
-   *
-   * @example
-   * ```typescript
-   * const result = await model.doGenerate({
-   *   prompt: [
-   *     { role: 'user', content: [{ type: 'text', text: 'Hello!' }] }
-   *   ],
-   *   temperature: 0.7,
-   *   maxTokens: 100
-   * });
-   *
-   * console.log(result.content); // Array of V3 content parts
-   * console.log(result.finishReason.unified); // "stop", "length", "tool-calls", etc.
-   * console.log(result.usage.inputTokens.total); // Total input tokens
-   * ```
-   *
-   * @since 1.0.0
-   * @since 4.0.0 Updated to LanguageModelV3 interface
+   * Returns the provider identifier.
+   * @returns The provider name
    */
   get provider() {
     return this.config.provider;
   }
   /**
    * Returns supported URL patterns for different content types.
-   *
    * @returns Record of content types to regex patterns
    */
   get supportedUrls() {
@@ -30162,13 +30223,10 @@ var SAPAILanguageModel = class {
   settings;
   /**
    * Creates a new SAP AI Chat Language Model instance.
-   *
+   * @internal
    * @param modelId - The model identifier
    * @param settings - Model-specific configuration settings
    * @param config - Internal configuration (deployment config, destination, etc.)
-   *
-   * @internal This constructor is not meant to be called directly.
-   * Use the provider function instead.
    */
   constructor(modelId, settings, config) {
     this.settings = settings;
@@ -30190,13 +30248,12 @@ var SAPAILanguageModel = class {
    *
    * **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.
-   *
+   * aborted. However, this does not cancel the underlying HTTP request to SAP AI Core -
+   * the request continues executing on the server. This is a current limitation of the
+   * SAP AI SDK's API. See https://github.com/SAP/ai-sdk-js/issues/1429
    * @param options - Generation options including prompt, tools, and settings
    * @returns Promise resolving to the generation result with content, usage, and metadata
-   *
+   * @since 1.0.0
    * @example
    * ```typescript
    * const result = await model.doGenerate({
@@ -30355,33 +30412,29 @@ var SAPAILanguageModel = class {
   /**
    * Generates a streaming completion.
    *
-   * This method implements the `LanguageModelV3.doStream` interface,
-   * sending a streaming request to SAP AI Core and returning a stream of response parts.
+   * Implements `LanguageModelV3.doStream`, sending a streaming request to SAP AI Core
+   * and returning a stream of response parts.
    *
    * **Stream Events:**
-   * - `stream-start` - Stream initialization with warnings
-   * - `response-metadata` - Response metadata (model, timestamp)
+   * - `stream-start` - Initialization with warnings
+   * - `response-metadata` - Model, timestamp, response ID
    * - `text-start` - Text block begins (with unique ID)
-   * - `text-delta` - Incremental text chunks (with block ID)
-   * - `text-end` - Text block completes (with accumulated text)
-   * - `tool-input-start` - Tool input begins
-   * - `tool-input-delta` - Tool input chunk
-   * - `tool-input-end` - Tool input completes
+   * - `text-delta` - Incremental text chunks
+   * - `text-end` - Text block completes
+   * - `tool-input-start/delta/end` - Tool input lifecycle
    * - `tool-call` - Complete tool call
    * - `finish` - Stream completes with usage and finish reason
    * - `error` - Error occurred
    *
-   * **Stream Structure:**
-   * - Text blocks have explicit lifecycle with unique IDs
-   * - Finish reason format: `{ unified: string, raw?: string }`
-   * - Usage format: `{ inputTokens: { total, ... }, outputTokens: { total, ... } }`
-   * - Warnings only in `stream-start` event
+   * **Response ID:**
+   * Client-generated UUID in `response-metadata.id` and `providerMetadata['sap-ai'].responseId`.
+   * TODO: Use backend's `x-request-id` when `OrchestrationStreamResponse` exposes `rawResponse`.
    *
+   * **Abort Signal:**
+   * Same limitation as `doGenerate` - see its documentation for details.
    * @see {@link https://sdk.vercel.ai/docs/ai-sdk-core/streaming Vercel AI SDK Streaming}
-   *
    * @param options - Streaming options including prompt, tools, and settings
    * @returns Promise resolving to stream and request metadata
-   *
    * @example
    * ```typescript
    * const { stream } = await model.doStream({
@@ -30394,13 +30447,9 @@ var SAPAILanguageModel = class {
    *   if (part.type === 'text-delta') {
    *     process.stdout.write(part.delta);
    *   }
-   *   if (part.type === 'text-end') {
-   *     console.log('Block complete:', part.id, part.text);
-   *   }
    * }
    * ```
-   *
-   * @since 4.0.0
+   * @since 1.0.0
    */
   async doStream(options) {
     try {
@@ -30423,12 +30472,11 @@ 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();
+      const responseId = idGenerator.generateResponseId();
       let textBlockId = null;
       const streamState = {
         activeText: false,
@@ -30472,6 +30520,7 @@ var SAPAILanguageModel = class {
               if (streamState.isFirstChunk) {
                 streamState.isFirstChunk = false;
                 controller.enqueue({
+                  id: responseId,
                   modelId,
                   timestamp: /* @__PURE__ */ new Date(),
                   type: "response-metadata"
@@ -30634,6 +30683,12 @@ var SAPAILanguageModel = class {
             }
             controller.enqueue({
               finishReason: streamState.finishReason,
+              providerMetadata: {
+                "sap-ai": {
+                  finishReason: streamState.finishReason.raw,
+                  responseId
+                }
+              },
               type: "finish",
               usage: streamState.usage
             });
@@ -30668,7 +30723,6 @@ var SAPAILanguageModel = class {
   }
   /**
    * Checks if a URL is supported for file/image uploads.
-   *
    * @param url - The URL to check
    * @returns True if the URL protocol is HTTPS or data with valid image format
    */
@@ -30681,7 +30735,6 @@ var SAPAILanguageModel = class {
   }
   /**
    * Builds orchestration module config for SAP AI SDK.
-   *
    * @param options - Call options from the AI SDK
    * @returns Object containing orchestration config, messages, and warnings
    * @internal
@@ -30714,12 +30767,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);
@@ -30859,17 +30909,12 @@ var SAPAILanguageModel = class {
   }
   /**
    * Creates an OrchestrationClient instance.
-   *
    * @param config - Orchestration module configuration
    * @returns OrchestrationClient instance
    * @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 +30943,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 +31062,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);
   };