@jerome-benoit/sap-ai-provider-v2 4.6.8 → 4.7.0

package/dist/index.d.cts

@@ -7,6 +7,63 @@ export { AssistantChatMessage, ChatCompletionRequest, ChatCompletionTool, ChatMe
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { InferSchema } from '@ai-sdk/provider-utils';
 
+/** Default provider name used as key in `providerOptions` and `providerMetadata` objects. */
+declare const SAP_AI_PROVIDER_NAME: "sap-ai";
+/**
+ * Extracts the provider name from a provider identifier (e.g., "sap-ai.chat" → "sap-ai").
+ * @param providerIdentifier - The full provider identifier string.
+ * @returns The provider name without any suffix.
+ */
+declare function getProviderName(providerIdentifier: string): string;
+/** @internal */
+declare const sapAILanguageModelProviderOptions: _ai_sdk_provider_utils.LazySchema<{
+    api?: "orchestration" | "foundation-models" | undefined;
+    escapeTemplatePlaceholders?: boolean | undefined;
+    includeReasoning?: boolean | undefined;
+    modelParams?: {
+        [x: string]: unknown;
+        frequencyPenalty?: number | undefined;
+        maxTokens?: number | undefined;
+        n?: number | undefined;
+        parallel_tool_calls?: boolean | undefined;
+        presencePenalty?: number | undefined;
+        temperature?: number | undefined;
+        topP?: number | undefined;
+    } | undefined;
+    orchestrationConfigRef?: {
+        id: string;
+    } | {
+        name: string;
+        scenario: string;
+        version: string;
+    } | undefined;
+    placeholderValues?: Record<string, string> | undefined;
+    promptTemplateRef?: {
+        id: string;
+        scope?: "tenant" | "resource_group" | undefined;
+    } | {
+        name: string;
+        scenario: string;
+        version: string;
+        scope?: "tenant" | "resource_group" | undefined;
+    } | undefined;
+}>;
+/** @internal */
+type SAPAILanguageModelProviderOptions = InferSchema<typeof sapAILanguageModelProviderOptions>;
+/** @internal */
+declare const sapAIEmbeddingProviderOptions: _ai_sdk_provider_utils.LazySchema<{
+    api?: "orchestration" | "foundation-models" | undefined;
+    modelParams?: {
+        [x: string]: unknown;
+        dimensions?: number | undefined;
+        encoding_format?: "base64" | "binary" | "float" | undefined;
+        normalize?: boolean | undefined;
+    } | undefined;
+    type?: "document" | "query" | "text" | undefined;
+}>;
+/** @internal */
+type SAPAIEmbeddingProviderOptions = InferSchema<typeof sapAIEmbeddingProviderOptions>;
+
 /**
  * Escapes Jinja2 template delimiters by inserting zero-width spaces.
  *
@@ -138,7 +195,9 @@ interface OrchestrationModelSettings {
     readonly grounding?: GroundingModule;
     /** @default false */
     readonly includeReasoning?: boolean;
-    readonly masking?: MaskingModule;
+    readonly masking?: MaskingModule | {
+        providers: MaskingModule["masking_providers"];
+    };
     readonly modelParams?: OrchestrationModelParams;
     readonly modelVersion?: string;
     /**
@@ -214,7 +273,9 @@ type SAPAIDefaultSettingsConfig = FoundationModelsDefaultSettings | Orchestratio
 interface SAPAIEmbeddingSettings {
     readonly api?: SAPAIApiType;
     /** Orchestration API only. */
-    readonly masking?: MaskingModule;
+    readonly masking?: MaskingModule | {
+        providers: MaskingModule["masking_providers"];
+    };
     /** @default 2048 */
     readonly maxEmbeddingsPerCall?: number;
     readonly modelParams?: FoundationModelsEmbeddingParams | Record<string, unknown>;
@@ -255,7 +316,9 @@ interface SAPAISettings {
     /** @default false */
     readonly includeReasoning?: boolean;
     /** Orchestration API only. */
-    readonly masking?: MaskingModule;
+    readonly masking?: MaskingModule | {
+        providers: MaskingModule["masking_providers"];
+    };
     readonly modelParams?: CommonModelParams;
     readonly modelVersion?: string;
     /** Orchestration API only. */
@@ -518,63 +581,6 @@ declare class SAPAILanguageModelV2 implements LanguageModelV2 {
     }>;
 }
 
-/** Default provider name used as key in `providerOptions` and `providerMetadata` objects. */
-declare const SAP_AI_PROVIDER_NAME: "sap-ai";
-/**
- * Extracts the provider name from a provider identifier (e.g., "sap-ai.chat" → "sap-ai").
- * @param providerIdentifier - The full provider identifier string.
- * @returns The provider name without any suffix.
- */
-declare function getProviderName(providerIdentifier: string): string;
-/** @internal */
-declare const sapAILanguageModelProviderOptions: _ai_sdk_provider_utils.LazySchema<{
-    api?: "foundation-models" | "orchestration" | undefined;
-    escapeTemplatePlaceholders?: boolean | undefined;
-    includeReasoning?: boolean | undefined;
-    modelParams?: {
-        [x: string]: unknown;
-        frequencyPenalty?: number | undefined;
-        maxTokens?: number | undefined;
-        n?: number | undefined;
-        parallel_tool_calls?: boolean | undefined;
-        presencePenalty?: number | undefined;
-        temperature?: number | undefined;
-        topP?: number | undefined;
-    } | undefined;
-    orchestrationConfigRef?: {
-        id: string;
-    } | {
-        name: string;
-        scenario: string;
-        version: string;
-    } | undefined;
-    placeholderValues?: Record<string, string> | undefined;
-    promptTemplateRef?: {
-        id: string;
-        scope?: "resource_group" | "tenant" | undefined;
-    } | {
-        name: string;
-        scenario: string;
-        version: string;
-        scope?: "resource_group" | "tenant" | undefined;
-    } | undefined;
-}>;
-/** @internal */
-type SAPAILanguageModelProviderOptions = InferSchema<typeof sapAILanguageModelProviderOptions>;
-/** @internal */
-declare const sapAIEmbeddingProviderOptions: _ai_sdk_provider_utils.LazySchema<{
-    api?: "foundation-models" | "orchestration" | undefined;
-    modelParams?: {
-        [x: string]: unknown;
-        dimensions?: number | undefined;
-        encoding_format?: "base64" | "binary" | "float" | undefined;
-        normalize?: boolean | undefined;
-    } | undefined;
-    type?: "text" | "document" | "query" | undefined;
-}>;
-/** @internal */
-type SAPAIEmbeddingProviderOptions = InferSchema<typeof sapAIEmbeddingProviderOptions>;
-
 /** SAP AI Core deployment configuration: either a deployment ID or a resource group. */
 type DeploymentConfig = DeploymentIdConfig | ResourceGroupConfig;
 /**

package/dist/index.d.ts

@@ -7,6 +7,63 @@ export { AssistantChatMessage, ChatCompletionRequest, ChatCompletionTool, ChatMe
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { InferSchema } from '@ai-sdk/provider-utils';
 
+/** Default provider name used as key in `providerOptions` and `providerMetadata` objects. */
+declare const SAP_AI_PROVIDER_NAME: "sap-ai";
+/**
+ * Extracts the provider name from a provider identifier (e.g., "sap-ai.chat" → "sap-ai").
+ * @param providerIdentifier - The full provider identifier string.
+ * @returns The provider name without any suffix.
+ */
+declare function getProviderName(providerIdentifier: string): string;
+/** @internal */
+declare const sapAILanguageModelProviderOptions: _ai_sdk_provider_utils.LazySchema<{
+    api?: "orchestration" | "foundation-models" | undefined;
+    escapeTemplatePlaceholders?: boolean | undefined;
+    includeReasoning?: boolean | undefined;
+    modelParams?: {
+        [x: string]: unknown;
+        frequencyPenalty?: number | undefined;
+        maxTokens?: number | undefined;
+        n?: number | undefined;
+        parallel_tool_calls?: boolean | undefined;
+        presencePenalty?: number | undefined;
+        temperature?: number | undefined;
+        topP?: number | undefined;
+    } | undefined;
+    orchestrationConfigRef?: {
+        id: string;
+    } | {
+        name: string;
+        scenario: string;
+        version: string;
+    } | undefined;
+    placeholderValues?: Record<string, string> | undefined;
+    promptTemplateRef?: {
+        id: string;
+        scope?: "tenant" | "resource_group" | undefined;
+    } | {
+        name: string;
+        scenario: string;
+        version: string;
+        scope?: "tenant" | "resource_group" | undefined;
+    } | undefined;
+}>;
+/** @internal */
+type SAPAILanguageModelProviderOptions = InferSchema<typeof sapAILanguageModelProviderOptions>;
+/** @internal */
+declare const sapAIEmbeddingProviderOptions: _ai_sdk_provider_utils.LazySchema<{
+    api?: "orchestration" | "foundation-models" | undefined;
+    modelParams?: {
+        [x: string]: unknown;
+        dimensions?: number | undefined;
+        encoding_format?: "base64" | "binary" | "float" | undefined;
+        normalize?: boolean | undefined;
+    } | undefined;
+    type?: "document" | "query" | "text" | undefined;
+}>;
+/** @internal */
+type SAPAIEmbeddingProviderOptions = InferSchema<typeof sapAIEmbeddingProviderOptions>;
+
 /**
  * Escapes Jinja2 template delimiters by inserting zero-width spaces.
  *
@@ -138,7 +195,9 @@ interface OrchestrationModelSettings {
     readonly grounding?: GroundingModule;
     /** @default false */
     readonly includeReasoning?: boolean;
-    readonly masking?: MaskingModule;
+    readonly masking?: MaskingModule | {
+        providers: MaskingModule["masking_providers"];
+    };
     readonly modelParams?: OrchestrationModelParams;
     readonly modelVersion?: string;
     /**
@@ -214,7 +273,9 @@ type SAPAIDefaultSettingsConfig = FoundationModelsDefaultSettings | Orchestratio
 interface SAPAIEmbeddingSettings {
     readonly api?: SAPAIApiType;
     /** Orchestration API only. */
-    readonly masking?: MaskingModule;
+    readonly masking?: MaskingModule | {
+        providers: MaskingModule["masking_providers"];
+    };
     /** @default 2048 */
     readonly maxEmbeddingsPerCall?: number;
     readonly modelParams?: FoundationModelsEmbeddingParams | Record<string, unknown>;
@@ -255,7 +316,9 @@ interface SAPAISettings {
     /** @default false */
     readonly includeReasoning?: boolean;
     /** Orchestration API only. */
-    readonly masking?: MaskingModule;
+    readonly masking?: MaskingModule | {
+        providers: MaskingModule["masking_providers"];
+    };
     readonly modelParams?: CommonModelParams;
     readonly modelVersion?: string;
     /** Orchestration API only. */
@@ -518,63 +581,6 @@ declare class SAPAILanguageModelV2 implements LanguageModelV2 {
     }>;
 }
 
-/** Default provider name used as key in `providerOptions` and `providerMetadata` objects. */
-declare const SAP_AI_PROVIDER_NAME: "sap-ai";
-/**
- * Extracts the provider name from a provider identifier (e.g., "sap-ai.chat" → "sap-ai").
- * @param providerIdentifier - The full provider identifier string.
- * @returns The provider name without any suffix.
- */
-declare function getProviderName(providerIdentifier: string): string;
-/** @internal */
-declare const sapAILanguageModelProviderOptions: _ai_sdk_provider_utils.LazySchema<{
-    api?: "foundation-models" | "orchestration" | undefined;
-    escapeTemplatePlaceholders?: boolean | undefined;
-    includeReasoning?: boolean | undefined;
-    modelParams?: {
-        [x: string]: unknown;
-        frequencyPenalty?: number | undefined;
-        maxTokens?: number | undefined;
-        n?: number | undefined;
-        parallel_tool_calls?: boolean | undefined;
-        presencePenalty?: number | undefined;
-        temperature?: number | undefined;
-        topP?: number | undefined;
-    } | undefined;
-    orchestrationConfigRef?: {
-        id: string;
-    } | {
-        name: string;
-        scenario: string;
-        version: string;
-    } | undefined;
-    placeholderValues?: Record<string, string> | undefined;
-    promptTemplateRef?: {
-        id: string;
-        scope?: "resource_group" | "tenant" | undefined;
-    } | {
-        name: string;
-        scenario: string;
-        version: string;
-        scope?: "resource_group" | "tenant" | undefined;
-    } | undefined;
-}>;
-/** @internal */
-type SAPAILanguageModelProviderOptions = InferSchema<typeof sapAILanguageModelProviderOptions>;
-/** @internal */
-declare const sapAIEmbeddingProviderOptions: _ai_sdk_provider_utils.LazySchema<{
-    api?: "foundation-models" | "orchestration" | undefined;
-    modelParams?: {
-        [x: string]: unknown;
-        dimensions?: number | undefined;
-        encoding_format?: "base64" | "binary" | "float" | undefined;
-        normalize?: boolean | undefined;
-    } | undefined;
-    type?: "text" | "document" | "query" | undefined;
-}>;
-/** @internal */
-type SAPAIEmbeddingProviderOptions = InferSchema<typeof sapAIEmbeddingProviderOptions>;
-
 /** SAP AI Core deployment configuration: either a deployment ID or a resource group. */
 type DeploymentConfig = DeploymentIdConfig | ResourceGroupConfig;
 /**

package/dist/index.js

@@ -1,22 +1,26 @@
 import {createRequire as __createRequire} from 'module';var require=__createRequire(import.meta.url);
+import {
+  mergeSettingsWithApi,
+  resolveApi,
+  validateSettings
+} from "./chunk-WDUOKIKD.js";
 import {
   escapeOrchestrationPlaceholders,
   unescapeOrchestrationPlaceholders
-} from "./chunk-IIBSUXGT.js";
+} from "./chunk-4JIMBRMV.js";
 import {
   ApiSwitchError,
   SAP_AI_PROVIDER_NAME,
   UnsupportedFeatureError,
   VERSION,
   __toESM,
-  deepMerge,
   getProviderName,
   require_dist,
   sapAIEmbeddingProviderOptions,
   sapAILanguageModelProviderOptions,
   validateEmbeddingModelParamsSettings,
   validateModelParamsSettings
-} from "./chunk-7OGNFVGC.js";
+} from "./chunk-TVXWNZQT.js";
 
 // src/sap-ai-adapters-v3-to-v2.ts
 function convertFinishReasonToV2(internalFinishReason) {
@@ -249,183 +253,24 @@ function getOrCreateLanguageModelStrategy(api) {
 async function createEmbeddingModelStrategy(api) {
   if (api === "foundation-models") {
     const { AzureOpenAiEmbeddingClient } = await import("@sap-ai-sdk/foundation-models");
-    const { FoundationModelsEmbeddingModelStrategy } = await import("./foundation-models-embedding-model-strategy-GXJRGM4X.js");
+    const { FoundationModelsEmbeddingModelStrategy } = await import("./foundation-models-embedding-model-strategy-YWPDIJEN.js");
     return new FoundationModelsEmbeddingModelStrategy(AzureOpenAiEmbeddingClient);
   }
   const { OrchestrationEmbeddingClient: OrchestrationEmbeddingClient2 } = await import("@sap-ai-sdk/orchestration");
-  const { OrchestrationEmbeddingModelStrategy } = await import("./orchestration-embedding-model-strategy-663QYZL7.js");
+  const { OrchestrationEmbeddingModelStrategy } = await import("./orchestration-embedding-model-strategy-66QYAO64.js");
   return new OrchestrationEmbeddingModelStrategy(OrchestrationEmbeddingClient2);
 }
 async function createLanguageModelStrategy(api) {
   if (api === "foundation-models") {
     const { AzureOpenAiChatClient } = await import("@sap-ai-sdk/foundation-models");
-    const { FoundationModelsLanguageModelStrategy } = await import("./foundation-models-language-model-strategy-FGUGQPBL.js");
+    const { FoundationModelsLanguageModelStrategy } = await import("./foundation-models-language-model-strategy-WDSQWU64.js");
     return new FoundationModelsLanguageModelStrategy(AzureOpenAiChatClient);
   }
   const { OrchestrationClient: OrchestrationClient2 } = await import("@sap-ai-sdk/orchestration");
-  const { OrchestrationLanguageModelStrategy } = await import("./orchestration-language-model-strategy-X3LKHORW.js");
+  const { OrchestrationLanguageModelStrategy } = await import("./orchestration-language-model-strategy-4TKRZK7U.js");
   return new OrchestrationLanguageModelStrategy(OrchestrationClient2);
 }
 
-// src/sap-ai-validation.ts
-function validateEscapeTemplatePlaceholders(api, escapeTemplatePlaceholders) {
-  if (api === "foundation-models" && escapeTemplatePlaceholders === true) {
-    throw new UnsupportedFeatureError(
-      ESCAPE_TEMPLATE_PLACEHOLDERS_DESCRIPTION,
-      "foundation-models",
-      "orchestration"
-    );
-  }
-}
-function validateFoundationModelsOnlyOptions(settings) {
-  if (!settings) return;
-  const fmSettings = settings;
-  for (const feature of FOUNDATION_MODELS_ONLY_FEATURE_KEYS) {
-    if (fmSettings[feature] !== void 0) {
-      throw new UnsupportedFeatureError(
-        FOUNDATION_MODELS_ONLY_FEATURES[feature],
-        "orchestration",
-        "foundation-models"
-      );
-    }
-  }
-}
-function validateOrchestrationOnlyEmbeddingOptions(settings) {
-  if (!settings) return;
-  for (const feature of ORCHESTRATION_ONLY_EMBEDDING_FEATURE_KEYS) {
-    if (settings[feature] !== void 0) {
-      throw new UnsupportedFeatureError(
-        ORCHESTRATION_ONLY_EMBEDDING_FEATURES[feature],
-        "foundation-models",
-        "orchestration"
-      );
-    }
-  }
-}
-function validateOrchestrationOnlyOptions(settings) {
-  if (!settings) return;
-  const orchSettings = settings;
-  for (const feature of ORCHESTRATION_ONLY_FEATURE_KEYS) {
-    if (orchSettings[feature] !== void 0) {
-      throw new UnsupportedFeatureError(
-        ORCHESTRATION_ONLY_FEATURES[feature],
-        "foundation-models",
-        "orchestration"
-      );
-    }
-  }
-}
-var ORCHESTRATION_ONLY_FEATURE_KEYS = [
-  "filtering",
-  "grounding",
-  "masking",
-  "orchestrationConfigRef",
-  "placeholderValues",
-  "promptTemplateRef",
-  "streamOptions",
-  "tools",
-  "translation"
-];
-var ORCHESTRATION_ONLY_FEATURES = {
-  filtering: "Content filtering",
-  grounding: "Document grounding",
-  masking: "Data masking",
-  orchestrationConfigRef: "Orchestration config reference (orchestrationConfigRef)",
-  placeholderValues: "Placeholder values (placeholderValues)",
-  promptTemplateRef: "Prompt template reference (promptTemplateRef)",
-  streamOptions: "Stream options for post-LLM modules",
-  tools: "SAP-format tool definitions (use AI SDK tools instead)",
-  translation: "Translation"
-};
-var FOUNDATION_MODELS_ONLY_FEATURE_KEYS = ["dataSources"];
-var FOUNDATION_MODELS_ONLY_FEATURES = {
-  dataSources: "Azure On Your Data (dataSources)"
-};
-var ORCHESTRATION_ONLY_INVOCATION_FEATURE_KEYS = [
-  "orchestrationConfigRef",
-  "placeholderValues",
-  "promptTemplateRef"
-];
-var ORCHESTRATION_ONLY_EMBEDDING_FEATURE_KEYS = ["masking"];
-var ORCHESTRATION_ONLY_EMBEDDING_FEATURES = {
-  masking: ORCHESTRATION_ONLY_FEATURES.masking
-};
-var ESCAPE_TEMPLATE_PLACEHOLDERS_DESCRIPTION = "escapeTemplatePlaceholders (Jinja2 template escaping)";
-function validateApiSwitch(fromApi, toApi, modelSettings) {
-  if (fromApi === toApi) return;
-  if (!modelSettings) return;
-  if (fromApi === "orchestration" && toApi === "foundation-models") {
-    const orchSettings = modelSettings;
-    for (const feature of ORCHESTRATION_ONLY_FEATURE_KEYS) {
-      if (orchSettings[feature] !== void 0) {
-        throw new ApiSwitchError(fromApi, toApi, feature);
-      }
-    }
-  }
-  if (fromApi === "foundation-models" && toApi === "orchestration") {
-    const fmSettings = modelSettings;
-    for (const feature of FOUNDATION_MODELS_ONLY_FEATURE_KEYS) {
-      if (fmSettings[feature] !== void 0) {
-        throw new ApiSwitchError(fromApi, toApi, feature);
-      }
-    }
-  }
-}
-var VALID_API_TYPES = ["orchestration", "foundation-models"];
-function mergeSettingsWithApi(defaultSettings, callSettings, fallbackApi) {
-  return {
-    ...deepMerge(defaultSettings, callSettings),
-    api: callSettings.api ?? defaultSettings?.api ?? fallbackApi
-  };
-}
-function resolveApi(providerApi, modelApi, invocationApi) {
-  return invocationApi ?? modelApi ?? providerApi ?? "orchestration";
-}
-function validateApiInput(api) {
-  if (api === void 0) return;
-  if (typeof api !== "string" || !VALID_API_TYPES.includes(api)) {
-    throw new Error(
-      `Invalid API type: ${JSON.stringify(api)}. Valid values are: ${VALID_API_TYPES.map((t) => `"${t}"`).join(", ")}`
-    );
-  }
-}
-function validateSettings(options) {
-  const { api, embeddingSettings, invocationSettings, modelApi, modelSettings } = options;
-  validateApiInput(api);
-  if (invocationSettings?.api !== void 0) {
-    validateApiInput(invocationSettings.api);
-  }
-  if (invocationSettings?.api !== void 0) {
-    const effectiveModelApi = modelApi ?? "orchestration";
-    if (effectiveModelApi !== invocationSettings.api) {
-      validateApiSwitch(effectiveModelApi, invocationSettings.api, modelSettings);
-    }
-  }
-  if (api === "foundation-models") {
-    validateOrchestrationOnlyOptions(modelSettings);
-    validateOrchestrationOnlyInvocationOptions(invocationSettings);
-    validateOrchestrationOnlyEmbeddingOptions(embeddingSettings);
-  } else {
-    validateFoundationModelsOnlyOptions(modelSettings);
-  }
-  const modelEscape = modelSettings?.escapeTemplatePlaceholders;
-  const invocationEscape = invocationSettings?.escapeTemplatePlaceholders;
-  const effectiveEscape = invocationEscape ?? modelEscape;
-  validateEscapeTemplatePlaceholders(api, effectiveEscape);
-}
-function validateOrchestrationOnlyInvocationOptions(invocationSettings) {
-  if (!invocationSettings) return;
-  for (const feature of ORCHESTRATION_ONLY_INVOCATION_FEATURE_KEYS) {
-    if (invocationSettings[feature] !== void 0) {
-      throw new UnsupportedFeatureError(
-        ORCHESTRATION_ONLY_FEATURES[feature],
-        "foundation-models",
-        "orchestration"
-      );
-    }
-  }
-}
-
 // src/sap-ai-embedding-model.ts
 var DEFAULT_MAX_EMBEDDINGS_PER_CALL = 2048;
 var SAPAIEmbeddingModel = class {
@@ -520,7 +365,7 @@ var SAPAIEmbeddingModelV2 = class {
     }
     return {
       embeddings: result.embeddings,
-      providerMetadata: castProviderMetadataToV2(result.providerMetadata),
+      providerMetadata: convertProviderMetadataToV2(result.providerMetadata),
       response: result.response ? {
         body: result.response.body,
         headers: result.response.headers
@@ -529,21 +374,12 @@ var SAPAIEmbeddingModelV2 = class {
     };
   }
 };
-function castProviderMetadataToV2(metadata) {
-  return metadata;
-}
 
 // src/sap-ai-language-model.ts
 import { parseProviderOptions as parseProviderOptions2 } from "@ai-sdk/provider-utils";
 var SAPAILanguageModel = class {
   modelId;
   specificationVersion = "v3";
-  supportsImageUrls = true;
-  supportsMultipleCompletions = true;
-  supportsParallelToolCalls = true;
-  supportsStreaming = true;
-  supportsStructuredOutputs = true;
-  supportsToolCalls = true;
   get provider() {
     return this.config.provider;
   }