@jerome-benoit/sap-ai-provider 4.6.9 → 4.7.1

package/dist/chunk-RUCURXS7.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/base-language-model-strategy.ts"],"sourcesContent":["/** Base class for language model strategies using the Template Method pattern. */\nimport type {\n  LanguageModelV3CallOptions,\n  LanguageModelV3GenerateResult,\n  LanguageModelV3StreamResult,\n  SharedV3Warning,\n} from \"@ai-sdk/provider\";\nimport type { ChatMessage } from \"@sap-ai-sdk/orchestration\";\n\nimport { parseProviderOptions } from \"@ai-sdk/provider-utils\";\n\nimport type { ParsePartProviderOptions } from \"./sap-ai-provider-options.js\";\nimport type { SAPAIModelSettings } from \"./sap-ai-settings.js\";\nimport type { LanguageModelAPIStrategy, LanguageModelStrategyConfig } from \"./sap-ai-strategy.js\";\n\nimport { convertToSAPMessages } from \"./convert-to-sap-messages.js\";\nimport { convertToAISDKError, normalizeHeaders } from \"./sap-ai-error.js\";\nimport { getProviderName, sapAILanguageModelProviderOptions } from \"./sap-ai-provider-options.js\";\nimport {\n  buildGenerateResult,\n  buildModelParams,\n  createAISDKRequestBodySummary,\n  createStreamTransformer,\n  extractCompletionId,\n  extractResponseMetadata,\n  mapToolChoice,\n  type ParamMapping,\n  type SAPToolChoice,\n  type SDKCitation,\n  type SDKResponse,\n  type SDKStreamChunk,\n  type SDKTokenUsage,\n  StreamIdGenerator,\n} from \"./strategy-utils.js\";\nimport { VERSION } from \"./version.js\";\n\n/**\n * Result of building common parts for a language model request.\n * @template TMessages - The message array type (e.g., `ChatMessage[]`, `AzureOpenAiChatCompletionRequestMessage[]`)\n * @template TToolChoice - The tool choice type (e.g., `SAPToolChoice`)\n * @internal\n */\nexport interface CommonBuildResult<TMessages extends unknown[] = unknown[], TToolChoice = unknown> {\n  readonly messages: TMessages;\n  readonly modelParams: Record<string, unknown>;\n  readonly providerName: string;\n  readonly resolvedState?: unknown;\n  readonly sapOptions: Record<string, unknown> | undefined;\n  readonly toolChoice: TToolChoice;\n  readonly warnings: SharedV3Warning[];\n}\n\n/**\n * Stream response shape returned by executeStreamCall.\n * @internal\n */\nexport interface StreamCallResponse {\n  readonly getCitations?: () => SDKCitation[] | undefined;\n  readonly getFinishReason: () => null | string | undefined;\n  readonly getIntermediateFailures?: () => undefined | unknown[];\n  readonly getTokenUsage: () => null | SDKTokenUsage | undefined;\n  /** SAP-pipeline request id resolved by `extractResponseMetadata`. */\n  readonly requestId?: string;\n  readonly responseHeaders?: Record<string, string>;\n  /** Server-provided completion ID extracted from _data, if available. */\n  readonly responseId?: string;\n  readonly stream: AsyncIterable<SDKStreamChunk>;\n}\n\n/**\n * Abstract base class for language model strategies using the Template Method pattern.\n * @template TClient - The SDK client type (e.g., AzureOpenAiChatClient, OrchestrationClient).\n * @template TRequest - The API request type (e.g., AzureOpenAiChatCompletionParameters).\n * @template TSettings - The model settings type extending SAPAIModelSettings.\n * @internal\n */\nexport abstract class BaseLanguageModelStrategy<\n  TClient,\n  TRequest,\n  TSettings extends SAPAIModelSettings = SAPAIModelSettings,\n> implements LanguageModelAPIStrategy<TSettings> {\n  /**\n   * Common parameter mappings for language model APIs.\n   * @internal\n   */\n  static readonly COMMON_PARAM_MAPPINGS: readonly ParamMapping[] = [\n    { camelCaseKey: \"maxTokens\", optionKey: \"maxOutputTokens\", outputKey: \"max_tokens\" },\n    { camelCaseKey: \"temperature\", optionKey: \"temperature\", outputKey: \"temperature\" },\n    { camelCaseKey: \"topP\", optionKey: \"topP\", outputKey: \"top_p\" },\n    {\n      camelCaseKey: \"frequencyPenalty\",\n      optionKey: \"frequencyPenalty\",\n      outputKey: \"frequency_penalty\",\n    },\n    {\n      camelCaseKey: \"presencePenalty\",\n      optionKey: \"presencePenalty\",\n      outputKey: \"presence_penalty\",\n    },\n    { camelCaseKey: \"seed\", optionKey: \"seed\", outputKey: \"seed\" },\n    { camelCaseKey: \"parallel_tool_calls\", outputKey: \"parallel_tool_calls\" },\n  ] as const;\n\n  async doGenerate(\n    config: LanguageModelStrategyConfig,\n    settings: TSettings,\n    options: LanguageModelV3CallOptions,\n  ): Promise<LanguageModelV3GenerateResult> {\n    try {\n      const commonParts = await this.buildCommonParts(config, settings, options);\n      const { request, warnings } = this.buildRequest(config, settings, options, commonParts);\n\n      const client = this.createClient(config, settings, commonParts);\n\n      const response = await this.executeApiCall(client, request, options.abortSignal ?? undefined);\n\n      return buildGenerateResult({\n        modelId: config.modelId,\n        providerName: commonParts.providerName,\n        requestBody: request,\n        requestId: response.requestId,\n        response,\n        responseHeaders: normalizeHeaders(response.rawResponse.headers),\n        version: VERSION,\n        warnings: [...commonParts.warnings, ...warnings],\n      });\n    } catch (error) {\n      throw convertToAISDKError(error, {\n        operation: \"doGenerate\",\n        requestBody: createAISDKRequestBodySummary(options),\n        url: this.getUrl(),\n      });\n    }\n  }\n\n  async doStream(\n    config: LanguageModelStrategyConfig,\n    settings: TSettings,\n    options: LanguageModelV3CallOptions,\n  ): Promise<LanguageModelV3StreamResult> {\n    try {\n      const commonParts = await this.buildCommonParts(config, settings, options);\n      const { request, warnings } = this.buildRequest(config, settings, options, commonParts);\n\n      const client = this.createClient(config, settings, commonParts);\n\n      const streamResponse = await this.executeStreamCall(\n        client,\n        request,\n        options.abortSignal ?? undefined,\n        settings,\n      );\n\n      const idGenerator = new StreamIdGenerator();\n      const responseId = streamResponse.responseId ?? idGenerator.generateResponseId();\n\n      const streamWarnings = this.collectStreamWarnings(settings, commonParts.sapOptions);\n\n      const transformedStream = createStreamTransformer({\n        convertToAISDKError,\n        idGenerator,\n        includeRawChunks: options.includeRawChunks ?? false,\n        modelId: config.modelId,\n        options,\n        providerName: commonParts.providerName,\n        requestId: streamResponse.requestId,\n        responseId,\n        sdkStream: streamResponse.stream,\n        streamResponseGetCitations: streamResponse.getCitations,\n        streamResponseGetFinishReason: streamResponse.getFinishReason,\n        streamResponseGetIntermediateFailures: streamResponse.getIntermediateFailures,\n        streamResponseGetTokenUsage: streamResponse.getTokenUsage,\n        url: this.getUrl(),\n        version: VERSION,\n        warnings: [...commonParts.warnings, ...warnings, ...streamWarnings],\n      });\n\n      return {\n        request: {\n          body: request,\n        },\n        response: {\n          headers: streamResponse.responseHeaders,\n        },\n        stream: transformedStream,\n      };\n    } catch (error) {\n      throw convertToAISDKError(error, {\n        operation: \"doStream\",\n        requestBody: createAISDKRequestBodySummary(options),\n        url: this.getUrl(),\n      });\n    }\n  }\n\n  /**\n   * Builds common parts shared between doGenerate and doStream.\n   * @param config - Strategy configuration.\n   * @param settings - Model settings.\n   * @param options - AI SDK call options.\n   * @returns Common build result with typed messages and tool choice.\n   * @internal\n   */\n  protected async buildCommonParts(\n    config: LanguageModelStrategyConfig,\n    settings: TSettings,\n    options: LanguageModelV3CallOptions,\n  ): Promise<CommonBuildResult<ChatMessage[], SAPToolChoice | undefined>> {\n    const providerName = getProviderName(config.provider);\n\n    const sapOptions = await parseProviderOptions({\n      provider: providerName,\n      providerOptions: options.providerOptions,\n      schema: sapAILanguageModelProviderOptions,\n    });\n\n    const warnings: SharedV3Warning[] = [];\n\n    const resolvedState = this.resolveAdditionalState(\n      config,\n      settings,\n      sapOptions,\n      options,\n      warnings,\n    );\n\n    const messages = convertToSAPMessages(options.prompt, {\n      escapeTemplatePlaceholders: this.getEscapeTemplatePlaceholders(sapOptions, settings),\n      includeReasoning: this.getIncludeReasoning(sapOptions, settings),\n      parsePartProviderOptions: this.getPartProviderOptionsParser(),\n      warnings,\n    });\n\n    const { modelParams, warnings: paramWarnings } = buildModelParams({\n      options,\n      paramMappings: this.getParamMappings(),\n      providerModelParams: sapOptions?.modelParams,\n      settingsModelParams: settings.modelParams,\n    });\n    warnings.push(...paramWarnings);\n\n    const toolChoice = mapToolChoice(options.toolChoice);\n\n    return {\n      messages,\n      modelParams,\n      providerName,\n      resolvedState,\n      sapOptions,\n      toolChoice,\n      warnings,\n    };\n  }\n\n  /**\n   * Builds the API-specific request body.\n   * @param config - Strategy configuration.\n   * @param settings - Model settings.\n   * @param options - AI SDK call options.\n   * @param commonParts - Common build result from base class.\n   * @returns Request body and accumulated warnings.\n   * @internal\n   */\n  protected abstract buildRequest(\n    config: LanguageModelStrategyConfig,\n    settings: TSettings,\n    options: LanguageModelV3CallOptions,\n    commonParts: CommonBuildResult<ChatMessage[], SAPToolChoice | undefined>,\n  ): { readonly request: TRequest; readonly warnings: SharedV3Warning[] };\n\n  /**\n   * Collects stream-specific warnings.\n   * Override in subclasses to add API-specific streaming warnings.\n   * @param _settings - Model settings (unused in base implementation).\n   * @param _sapOptions - Provider options (unused in base implementation).\n   * @returns Array of warnings for streaming operations.\n   * @internal\n   */\n  protected collectStreamWarnings(\n    _settings: TSettings,\n    _sapOptions?: Record<string, unknown>,\n  ): SharedV3Warning[] {\n    return [];\n  }\n\n  /**\n   * Creates the appropriate SDK client for this API.\n   * @param config - Strategy configuration.\n   * @param settings - Model settings.\n   * @param commonParts - Common build result (messages, options, etc.).\n   * @returns SDK client instance.\n   * @internal\n   */\n  protected abstract createClient(\n    config: LanguageModelStrategyConfig,\n    settings: TSettings,\n    commonParts: CommonBuildResult<ChatMessage[], SAPToolChoice | undefined>,\n  ): TClient;\n\n  /**\n   * Executes the non-streaming API call.\n   * @param client - SDK client instance.\n   * @param request - Request body.\n   * @param abortSignal - Optional abort signal.\n   * @returns SDK response.\n   * @internal\n   */\n  protected abstract executeApiCall(\n    client: TClient,\n    request: TRequest,\n    abortSignal: AbortSignal | undefined,\n  ): Promise<SDKResponse>;\n\n  /**\n   * Executes the streaming API call.\n   * @param client - SDK client instance.\n   * @param request - Request body.\n   * @param abortSignal - Optional abort signal.\n   * @param settings - Model settings for API-specific stream options.\n   * @returns Stream response with accessors.\n   * @internal\n   */\n  protected abstract executeStreamCall(\n    client: TClient,\n    request: TRequest,\n    abortSignal: AbortSignal | undefined,\n    settings: TSettings,\n  ): Promise<StreamCallResponse>;\n\n  /**\n   * Resolves request id, completion id, and normalised headers from an SDK response.\n   * @param response - Raw SDK response or stream response.\n   * @returns Combined metadata fragment.\n   * @internal\n   */\n  protected extractMetadata(response: unknown): {\n    requestId?: string;\n    responseHeaders?: Record<string, string>;\n    responseId?: string;\n  } {\n    const responseId = extractCompletionId(\n      response as { _data?: unknown; getRequestId?: () => string | undefined },\n      this.getCompletionIdPath(),\n    );\n    const { headers, requestId } = extractResponseMetadata(response, \"rawResponse\");\n    return { requestId, responseHeaders: headers, responseId };\n  }\n\n  /**\n   * Returns the API-specific dotted path used to read the completion id off\n   * the SDK response's internal `_data` payload.\n   * @returns Path traversed under `_data` (e.g. `[\"final_result\",\"id\"]`, `[\"id\"]`).\n   * @internal\n   */\n  protected abstract getCompletionIdPath(): readonly string[];\n\n  /**\n   * Returns whether to escape template placeholders for this API.\n   * @param _sapOptions - Parsed provider options (unused in base implementation).\n   * @param _settings - Model settings (unused in base implementation).\n   * @returns false by default; Orchestration strategy overrides to return true.\n   * @internal\n   */\n  protected getEscapeTemplatePlaceholders(\n    _sapOptions: Record<string, unknown> | undefined,\n    _settings: TSettings,\n  ): boolean {\n    return false;\n  }\n\n  /**\n   * Returns whether to include reasoning in the response.\n   * @param sapOptions - Parsed provider options.\n   * @param settings - Model settings.\n   * @returns Whether to include reasoning (checks sapOptions then settings, defaults to false).\n   * @internal\n   */\n  protected getIncludeReasoning(\n    sapOptions: Record<string, unknown> | undefined,\n    settings: TSettings,\n  ): boolean {\n    return (\n      (sapOptions?.includeReasoning as boolean | undefined) ?? settings.includeReasoning ?? false\n    );\n  }\n\n  /**\n   * Returns the parameter mappings specific to this API strategy.\n   * @returns Array of parameter mappings.\n   * @internal\n   */\n  protected abstract getParamMappings(): readonly ParamMapping[];\n\n  /**\n   * Returns a parser for per-message-part `providerOptions['sap-ai']`.\n   *\n   * Default returns `undefined`; strategies honouring part-level directives\n   * (e.g. Anthropic `cacheControl` on orchestration) override to return a parser.\n   * @returns Parser callback, or undefined to disable per-part plumbing.\n   * @internal\n   */\n  protected getPartProviderOptionsParser(): ParsePartProviderOptions | undefined {\n    return undefined;\n  }\n\n  /**\n   * Returns the URL identifier for this API (used in error messages).\n   * @returns URL string identifier.\n   * @internal\n   */\n  protected abstract getUrl(): string;\n\n  /**\n   * Resolves API-specific extra state shared between doGenerate and doStream\n   * (e.g. orchestration `configRef` / `promptTemplateRef` / `tools`). Override\n   * to add API-specific deprecation checks or pre-resolve auxiliary inputs.\n   * Pushed warnings flow into the shared sink.\n   * @param _config - Strategy configuration.\n   * @param _settings - Model settings.\n   * @param _sapOptions - Parsed provider options, or `undefined`.\n   * @param _options - AI SDK call options.\n   * @param _warnings - Shared warnings sink for the current call.\n   * @returns Strategy-specific resolved state, or `undefined` (default).\n   * @internal\n   */\n  protected resolveAdditionalState(\n    _config: LanguageModelStrategyConfig,\n    _settings: TSettings,\n    _sapOptions: Record<string, unknown> | undefined,\n    _options: LanguageModelV3CallOptions,\n    _warnings: SharedV3Warning[],\n  ): unknown {\n    return undefined;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AASA,SAAS,4BAA4B;AAmE9B,IAAe,4BAAf,MAI0C;AAAA;AAAA;AAAA;AAAA;AAAA,EAK/C,OAAgB,wBAAiD;AAAA,IAC/D,EAAE,cAAc,aAAa,WAAW,mBAAmB,WAAW,aAAa;AAAA,IACnF,EAAE,cAAc,eAAe,WAAW,eAAe,WAAW,cAAc;AAAA,IAClF,EAAE,cAAc,QAAQ,WAAW,QAAQ,WAAW,QAAQ;AAAA,IAC9D;AAAA,MACE,cAAc;AAAA,MACd,WAAW;AAAA,MACX,WAAW;AAAA,IACb;AAAA,IACA;AAAA,MACE,cAAc;AAAA,MACd,WAAW;AAAA,MACX,WAAW;AAAA,IACb;AAAA,IACA,EAAE,cAAc,QAAQ,WAAW,QAAQ,WAAW,OAAO;AAAA,IAC7D,EAAE,cAAc,uBAAuB,WAAW,sBAAsB;AAAA,EAC1E;AAAA,EAEA,MAAM,WACJ,QACA,UACA,SACwC;AACxC,QAAI;AACF,YAAM,cAAc,MAAM,KAAK,iBAAiB,QAAQ,UAAU,OAAO;AACzE,YAAM,EAAE,SAAS,SAAS,IAAI,KAAK,aAAa,QAAQ,UAAU,SAAS,WAAW;AAEtF,YAAM,SAAS,KAAK,aAAa,QAAQ,UAAU,WAAW;AAE9D,YAAM,WAAW,MAAM,KAAK,eAAe,QAAQ,SAAS,QAAQ,eAAe,MAAS;AAE5F,aAAO,oBAAoB;AAAA,QACzB,SAAS,OAAO;AAAA,QAChB,cAAc,YAAY;AAAA,QAC1B,aAAa;AAAA,QACb,WAAW,SAAS;AAAA,QACpB;AAAA,QACA,iBAAiB,iBAAiB,SAAS,YAAY,OAAO;AAAA,QAC9D,SAAS;AAAA,QACT,UAAU,CAAC,GAAG,YAAY,UAAU,GAAG,QAAQ;AAAA,MACjD,CAAC;AAAA,IACH,SAAS,OAAO;AACd,YAAM,oBAAoB,OAAO;AAAA,QAC/B,WAAW;AAAA,QACX,aAAa,8BAA8B,OAAO;AAAA,QAClD,KAAK,KAAK,OAAO;AAAA,MACnB,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,MAAM,SACJ,QACA,UACA,SACsC;AACtC,QAAI;AACF,YAAM,cAAc,MAAM,KAAK,iBAAiB,QAAQ,UAAU,OAAO;AACzE,YAAM,EAAE,SAAS,SAAS,IAAI,KAAK,aAAa,QAAQ,UAAU,SAAS,WAAW;AAEtF,YAAM,SAAS,KAAK,aAAa,QAAQ,UAAU,WAAW;AAE9D,YAAM,iBAAiB,MAAM,KAAK;AAAA,QAChC;AAAA,QACA;AAAA,QACA,QAAQ,eAAe;AAAA,QACvB;AAAA,MACF;AAEA,YAAM,cAAc,IAAI,kBAAkB;AAC1C,YAAM,aAAa,eAAe,cAAc,YAAY,mBAAmB;AAE/E,YAAM,iBAAiB,KAAK,sBAAsB,UAAU,YAAY,UAAU;AAElF,YAAM,oBAAoB,wBAAwB;AAAA,QAChD;AAAA,QACA;AAAA,QACA,kBAAkB,QAAQ,oBAAoB;AAAA,QAC9C,SAAS,OAAO;AAAA,QAChB;AAAA,QACA,cAAc,YAAY;AAAA,QAC1B,WAAW,eAAe;AAAA,QAC1B;AAAA,QACA,WAAW,eAAe;AAAA,QAC1B,4BAA4B,eAAe;AAAA,QAC3C,+BAA+B,eAAe;AAAA,QAC9C,uCAAuC,eAAe;AAAA,QACtD,6BAA6B,eAAe;AAAA,QAC5C,KAAK,KAAK,OAAO;AAAA,QACjB,SAAS;AAAA,QACT,UAAU,CAAC,GAAG,YAAY,UAAU,GAAG,UAAU,GAAG,cAAc;AAAA,MACpE,CAAC;AAED,aAAO;AAAA,QACL,SAAS;AAAA,UACP,MAAM;AAAA,QACR;AAAA,QACA,UAAU;AAAA,UACR,SAAS,eAAe;AAAA,QAC1B;AAAA,QACA,QAAQ;AAAA,MACV;AAAA,IACF,SAAS,OAAO;AACd,YAAM,oBAAoB,OAAO;AAAA,QAC/B,WAAW;AAAA,QACX,aAAa,8BAA8B,OAAO;AAAA,QAClD,KAAK,KAAK,OAAO;AAAA,MACnB,CAAC;AAAA,IACH;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAgB,iBACd,QACA,UACA,SACsE;AACtE,UAAM,eAAe,gBAAgB,OAAO,QAAQ;AAEpD,UAAM,aAAa,MAAM,qBAAqB;AAAA,MAC5C,UAAU;AAAA,MACV,iBAAiB,QAAQ;AAAA,MACzB,QAAQ;AAAA,IACV,CAAC;AAED,UAAM,WAA8B,CAAC;AAErC,UAAM,gBAAgB,KAAK;AAAA,MACzB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAEA,UAAM,WAAW,qBAAqB,QAAQ,QAAQ;AAAA,MACpD,4BAA4B,KAAK,8BAA8B,YAAY,QAAQ;AAAA,MACnF,kBAAkB,KAAK,oBAAoB,YAAY,QAAQ;AAAA,MAC/D,0BAA0B,KAAK,6BAA6B;AAAA,MAC5D;AAAA,IACF,CAAC;AAED,UAAM,EAAE,aAAa,UAAU,cAAc,IAAI,iBAAiB;AAAA,MAChE;AAAA,MACA,eAAe,KAAK,iBAAiB;AAAA,MACrC,qBAAqB,YAAY;AAAA,MACjC,qBAAqB,SAAS;AAAA,IAChC,CAAC;AACD,aAAS,KAAK,GAAG,aAAa;AAE9B,UAAM,aAAa,cAAc,QAAQ,UAAU;AAEnD,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA0BU,sBACR,WACA,aACmB;AACnB,WAAO,CAAC;AAAA,EACV;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoDU,gBAAgB,UAIxB;AACA,UAAM,aAAa;AAAA,MACjB;AAAA,MACA,KAAK,oBAAoB;AAAA,IAC3B;AACA,UAAM,EAAE,SAAS,UAAU,IAAI,wBAAwB,UAAU,aAAa;AAC9E,WAAO,EAAE,WAAW,iBAAiB,SAAS,WAAW;AAAA,EAC3D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBU,8BACR,aACA,WACS;AACT,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASU,oBACR,YACA,UACS;AACT,WACG,YAAY,oBAA4C,SAAS,oBAAoB;AAAA,EAE1F;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBU,+BAAqE;AAC7E,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBU,uBACR,SACA,WACA,aACA,UACA,WACS;AACT,WAAO;AAAA,EACT;AACF;","names":[]}