@jerome-benoit/sap-ai-provider-v2 4.1.3 → 4.2.1

package/dist/index.d.cts

@@ -158,8 +158,9 @@ declare class SAPAIEmbeddingModelV2 implements EmbeddingModelV2<string> {
 }
 
 /**
- * The provider identifier used for provider options.
- * Use this key in `providerOptions` to pass SAP AI-specific options.
+ * Default provider name.
+ *
+ * Use this as key in `providerOptions` and `providerMetadata` when using the default provider name.
  * @example
  * ```typescript
  * providerOptions: {
@@ -168,6 +169,22 @@ declare class SAPAIEmbeddingModelV2 implements EmbeddingModelV2<string> {
  * ```
  */
 declare const SAP_AI_PROVIDER_NAME: "sap-ai";
+/**
+ * Extracts the provider name from a provider identifier.
+ *
+ * Following the AI SDK convention, provider identifiers use the format `{name}.{type}`
+ * (e.g., `"openai.chat"`, `"anthropic.messages"`). This function extracts the provider name
+ * for use with `providerOptions` and `providerMetadata`, which use the provider name as key.
+ * @param providerIdentifier - The provider identifier (e.g., `"sap-ai.chat"`, `"sap-ai.embedding"`)
+ * @returns The provider name (e.g., `"sap-ai"`)
+ * @example
+ * ```typescript
+ * getProviderName("sap-ai.chat") // => "sap-ai"
+ * getProviderName("sap-ai-core.embedding") // => "sap-ai-core"
+ * getProviderName("sap-ai") // => "sap-ai" (no type suffix)
+ * ```
+ */
+declare function getProviderName(providerIdentifier: string): string;
 /**
  * Zod schema for SAP AI language model provider options.
  *
@@ -804,6 +821,31 @@ interface SAPAIProviderSettings {
      * ```
      */
     readonly destination?: HttpDestinationOrFetchOptions;
+    /**
+     * Provider name.
+     *
+     * Used as the key for `providerOptions` and `providerMetadata` in AI SDK calls.
+     * The provider identifier (exposed via `model.provider`) follows the AI SDK convention
+     * `{name}.{type}` (e.g., `"sap-ai.chat"`, `"sap-ai.embedding"`).
+     * @default 'sap-ai'
+     * @example
+     * ```typescript
+     * const provider = createSAPAIProvider({ name: 'sap-ai-core' });
+     * const model = provider('gpt-4o');
+     *
+     * console.log(model.provider); // => "sap-ai-core.chat"
+     *
+     * // Use provider name in providerOptions:
+     * await generateText({
+     *   model,
+     *   prompt: 'Hello',
+     *   providerOptions: {
+     *     'sap-ai-core': { includeReasoning: true }
+     *   }
+     * });
+     * ```
+     */
+    readonly name?: string;
     /**
      * SAP AI Core resource group.
      *
@@ -878,6 +920,15 @@ interface SAPAIProviderV2 extends ProviderV2 {
      * @param modelId - The embedding model identifier (e.g., 'text-embedding-ada-002')
      * @param settings - Optional embedding model settings
      * @returns Configured SAP AI embedding model instance (V2)
+     * @example
+     * ```typescript
+     * import { embed } from 'ai';
+     *
+     * const { embedding } = await embed({
+     *   model: provider.embedding('text-embedding-ada-002'),
+     *   value: 'Hello, world!'
+     * });
+     * ```
      */
     embedding(modelId: SAPAIEmbeddingModelId, settings?: SAPAIEmbeddingSettings): SAPAIEmbeddingModelV2;
     /**
@@ -898,7 +949,8 @@ interface SAPAIProviderV2 extends ProviderV2 {
     /**
      * Create a language model instance (V2).
      *
-     * This is the standard method for creating language models.
+     * Standard ProviderV2 method for creating language models.
+     * Equivalent to calling the provider function directly or using `chat()`.
      * @param modelId - The SAP AI Core model identifier
      * @param settings - Optional model configuration settings
      * @returns Configured SAP AI language model instance (V2)
@@ -907,7 +959,8 @@ interface SAPAIProviderV2 extends ProviderV2 {
     /**
      * Create a text embedding model instance (V2).
      *
-     * Alias for the embedding() method. Provides compatibility with common provider patterns.
+     * Standard ProviderV2 method for creating embedding models.
+     * Equivalent to calling `embedding()`.
      * @param modelId - The embedding model identifier
      * @param settings - Optional embedding model settings
      * @returns Configured SAP AI embedding model instance (V2)
@@ -994,4 +1047,4 @@ declare function createSAPAIProvider(options?: SAPAIProviderSettings): SAPAIProv
  */
 declare const sapai: SAPAIProviderV2;
 
-export { type DeploymentConfig, SAPAIEmbeddingModelV2 as SAPAIEmbeddingModel, type SAPAIEmbeddingModelId, type SAPAIEmbeddingProviderOptions, type SAPAIEmbeddingSettings, type SAPAILanguageModelProviderOptions, type SAPAIModelId, type SAPAIProviderV2 as SAPAIProvider, type SAPAIProviderSettings, type SAPAISettings, SAP_AI_PROVIDER_NAME, createSAPAIProvider, sapAIEmbeddingProviderOptions, sapAILanguageModelProviderOptions, sapai };
+export { type DeploymentConfig, SAPAIEmbeddingModelV2 as SAPAIEmbeddingModel, type SAPAIEmbeddingModelId, type SAPAIEmbeddingProviderOptions, type SAPAIEmbeddingSettings, type SAPAILanguageModelProviderOptions, type SAPAIModelId, type SAPAIProviderV2 as SAPAIProvider, type SAPAIProviderSettings, type SAPAISettings, SAP_AI_PROVIDER_NAME, createSAPAIProvider, getProviderName, sapAIEmbeddingProviderOptions, sapAILanguageModelProviderOptions, sapai };

package/dist/index.d.ts

@@ -158,8 +158,9 @@ declare class SAPAIEmbeddingModelV2 implements EmbeddingModelV2<string> {
 }
 
 /**
- * The provider identifier used for provider options.
- * Use this key in `providerOptions` to pass SAP AI-specific options.
+ * Default provider name.
+ *
+ * Use this as key in `providerOptions` and `providerMetadata` when using the default provider name.
  * @example
  * ```typescript
  * providerOptions: {
@@ -168,6 +169,22 @@ declare class SAPAIEmbeddingModelV2 implements EmbeddingModelV2<string> {
  * ```
  */
 declare const SAP_AI_PROVIDER_NAME: "sap-ai";
+/**
+ * Extracts the provider name from a provider identifier.
+ *
+ * Following the AI SDK convention, provider identifiers use the format `{name}.{type}`
+ * (e.g., `"openai.chat"`, `"anthropic.messages"`). This function extracts the provider name
+ * for use with `providerOptions` and `providerMetadata`, which use the provider name as key.
+ * @param providerIdentifier - The provider identifier (e.g., `"sap-ai.chat"`, `"sap-ai.embedding"`)
+ * @returns The provider name (e.g., `"sap-ai"`)
+ * @example
+ * ```typescript
+ * getProviderName("sap-ai.chat") // => "sap-ai"
+ * getProviderName("sap-ai-core.embedding") // => "sap-ai-core"
+ * getProviderName("sap-ai") // => "sap-ai" (no type suffix)
+ * ```
+ */
+declare function getProviderName(providerIdentifier: string): string;
 /**
  * Zod schema for SAP AI language model provider options.
  *
@@ -804,6 +821,31 @@ interface SAPAIProviderSettings {
      * ```
      */
     readonly destination?: HttpDestinationOrFetchOptions;
+    /**
+     * Provider name.
+     *
+     * Used as the key for `providerOptions` and `providerMetadata` in AI SDK calls.
+     * The provider identifier (exposed via `model.provider`) follows the AI SDK convention
+     * `{name}.{type}` (e.g., `"sap-ai.chat"`, `"sap-ai.embedding"`).
+     * @default 'sap-ai'
+     * @example
+     * ```typescript
+     * const provider = createSAPAIProvider({ name: 'sap-ai-core' });
+     * const model = provider('gpt-4o');
+     *
+     * console.log(model.provider); // => "sap-ai-core.chat"
+     *
+     * // Use provider name in providerOptions:
+     * await generateText({
+     *   model,
+     *   prompt: 'Hello',
+     *   providerOptions: {
+     *     'sap-ai-core': { includeReasoning: true }
+     *   }
+     * });
+     * ```
+     */
+    readonly name?: string;
     /**
      * SAP AI Core resource group.
      *
@@ -878,6 +920,15 @@ interface SAPAIProviderV2 extends ProviderV2 {
      * @param modelId - The embedding model identifier (e.g., 'text-embedding-ada-002')
      * @param settings - Optional embedding model settings
      * @returns Configured SAP AI embedding model instance (V2)
+     * @example
+     * ```typescript
+     * import { embed } from 'ai';
+     *
+     * const { embedding } = await embed({
+     *   model: provider.embedding('text-embedding-ada-002'),
+     *   value: 'Hello, world!'
+     * });
+     * ```
      */
     embedding(modelId: SAPAIEmbeddingModelId, settings?: SAPAIEmbeddingSettings): SAPAIEmbeddingModelV2;
     /**
@@ -898,7 +949,8 @@ interface SAPAIProviderV2 extends ProviderV2 {
     /**
      * Create a language model instance (V2).
      *
-     * This is the standard method for creating language models.
+     * Standard ProviderV2 method for creating language models.
+     * Equivalent to calling the provider function directly or using `chat()`.
      * @param modelId - The SAP AI Core model identifier
      * @param settings - Optional model configuration settings
      * @returns Configured SAP AI language model instance (V2)
@@ -907,7 +959,8 @@ interface SAPAIProviderV2 extends ProviderV2 {
     /**
      * Create a text embedding model instance (V2).
      *
-     * Alias for the embedding() method. Provides compatibility with common provider patterns.
+     * Standard ProviderV2 method for creating embedding models.
+     * Equivalent to calling `embedding()`.
      * @param modelId - The embedding model identifier
      * @param settings - Optional embedding model settings
      * @returns Configured SAP AI embedding model instance (V2)
@@ -994,4 +1047,4 @@ declare function createSAPAIProvider(options?: SAPAIProviderSettings): SAPAIProv
  */
 declare const sapai: SAPAIProviderV2;
 
-export { type DeploymentConfig, SAPAIEmbeddingModelV2 as SAPAIEmbeddingModel, type SAPAIEmbeddingModelId, type SAPAIEmbeddingProviderOptions, type SAPAIEmbeddingSettings, type SAPAILanguageModelProviderOptions, type SAPAIModelId, type SAPAIProviderV2 as SAPAIProvider, type SAPAIProviderSettings, type SAPAISettings, SAP_AI_PROVIDER_NAME, createSAPAIProvider, sapAIEmbeddingProviderOptions, sapAILanguageModelProviderOptions, sapai };
+export { type DeploymentConfig, SAPAIEmbeddingModelV2 as SAPAIEmbeddingModel, type SAPAIEmbeddingModelId, type SAPAIEmbeddingProviderOptions, type SAPAIEmbeddingSettings, type SAPAILanguageModelProviderOptions, type SAPAIModelId, type SAPAIProviderV2 as SAPAIProvider, type SAPAIProviderSettings, type SAPAISettings, SAP_AI_PROVIDER_NAME, createSAPAIProvider, getProviderName, sapAIEmbeddingProviderOptions, sapAILanguageModelProviderOptions, sapai };

package/dist/index.js

@@ -30207,6 +30207,10 @@ function tryExtractSAPErrorFromMessage(message) {
 import { lazySchema, zodSchema } from "@ai-sdk/provider-utils";
 import { z } from "zod";
 var SAP_AI_PROVIDER_NAME = "sap-ai";
+function getProviderName(providerIdentifier) {
+  const dotIndex = providerIdentifier.indexOf(".");
+  return dotIndex === -1 ? providerIdentifier : providerIdentifier.slice(0, dotIndex);
+}
 var modelParamsSchema = z.object({
   /**
    * Frequency penalty between -2.0 and 2.0.
@@ -30394,8 +30398,9 @@ var SAPAIEmbeddingModel = class {
    */
   async doEmbed(options) {
     const { abortSignal, providerOptions, values } = options;
+    const providerName = getProviderName(this.config.provider);
     const sapOptions = await parseProviderOptions({
-      provider: SAP_AI_PROVIDER_NAME,
+      provider: providerName,
       providerOptions,
       schema: sapAIEmbeddingProviderOptions
     });
@@ -30425,7 +30430,7 @@ var SAPAIEmbeddingModel = class {
         (data) => this.normalizeEmbedding(data.embedding)
       );
       const providerMetadata = {
-        "sap-ai": {
+        [providerName]: {
           model: this.modelId
         }
       };
@@ -30952,11 +30957,12 @@ var SAPAILanguageModel = class {
         tokenUsage,
         toolCalls
       };
+      const providerName = getProviderName(this.config.provider);
       return {
         content,
         finishReason,
         providerMetadata: {
-          "sap-ai": {
+          [providerName]: {
             finishReason: finishReasonRaw ?? "unknown",
             finishReasonMapped: finishReason,
             ...typeof responseHeaders?.["x-request-id"] === "string" ? { requestId: responseHeaders["x-request-id"] } : {}
@@ -31087,6 +31093,7 @@ var SAPAILanguageModel = class {
       const toolCallsInProgress = /* @__PURE__ */ new Map();
       const sdkStream = streamResponse.stream;
       const modelId = this.modelId;
+      const providerName = getProviderName(this.config.provider);
       const warningsSnapshot = [...warnings];
       const warningsOut = [...warningsSnapshot];
       const transformedStream = new ReadableStream({
@@ -31275,7 +31282,7 @@ var SAPAILanguageModel = class {
             controller.enqueue({
               finishReason: streamState.finishReason,
               providerMetadata: {
-                "sap-ai": {
+                [providerName]: {
                   finishReason: streamState.finishReason.raw,
                   responseId
                 }
@@ -31331,8 +31338,9 @@ var SAPAILanguageModel = class {
    * @internal
    */
   async buildOrchestrationConfig(options) {
+    const providerName = getProviderName(this.config.provider);
     const sapOptions = await parseProviderOptions2({
-      provider: SAP_AI_PROVIDER_NAME,
+      provider: providerName,
       providerOptions: options.providerOptions,
       schema: sapAILanguageModelProviderOptions
     });
@@ -31755,6 +31763,7 @@ function createSAPAIProvider(options = {}) {
   if (options.defaultSettings?.modelParams) {
     validateModelParamsSettings(options.defaultSettings.modelParams);
   }
+  const providerName = options.name ?? SAP_AI_PROVIDER_NAME;
   const resourceGroup = options.resourceGroup ?? "default";
   const warnOnAmbiguousConfig = options.warnOnAmbiguousConfig ?? true;
   if (warnOnAmbiguousConfig && options.deploymentId && options.resourceGroup) {
@@ -31779,14 +31788,14 @@ function createSAPAIProvider(options = {}) {
     return new SAPAILanguageModelV2(modelId, mergedSettings, {
       deploymentConfig,
       destination: options.destination,
-      provider: "sap-ai"
+      provider: `${providerName}.chat`
     });
   };
   const createEmbeddingModel = (modelId, settings = {}) => {
     return new SAPAIEmbeddingModelV2(modelId, settings, {
       deploymentConfig,
       destination: options.destination,
-      provider: "sap-ai"
+      provider: `${providerName}.embedding`
     });
   };
   const provider = function(modelId, settings) {
@@ -31795,8 +31804,8 @@ function createSAPAIProvider(options = {}) {
     }
     return createModel(modelId, settings);
   };
-  provider.languageModel = createModel;
   provider.chat = createModel;
+  provider.languageModel = createModel;
   provider.embedding = createEmbeddingModel;
   provider.textEmbeddingModel = createEmbeddingModel;
   provider.imageModel = (modelId) => {
@@ -31841,6 +31850,7 @@ export {
   buildLlamaGuard38BFilter,
   buildTranslationConfig,
   createSAPAIProvider,
+  getProviderName,
   isConfigReference,
   sapAIEmbeddingProviderOptions,
   sapAILanguageModelProviderOptions,