@jerome-benoit/sap-ai-provider 3.0.0-rc.3 → 3.0.0-rc.5

package/README.md

@@ -7,28 +7,6 @@
 
 A community provider for SAP AI Core that integrates seamlessly with the Vercel AI SDK. Built on top of the official **@sap-ai-sdk/orchestration** package, this provider enables you to use SAP's enterprise-grade AI models through the familiar Vercel AI SDK interface.
 
-> **Note on Terminology:** This documentation uses "tool calling" (Vercel AI SDK convention), equivalent to "function calling" in OpenAI documentation. Both terms refer to the same capability of models invoking external functions.
-
-## ⚠️ Breaking Changes in v3.0.0-rc.1
-
-Version 3.0 standardizes error handling to use Vercel AI SDK native error types. **See the [Migration Guide](./MIGRATION_GUIDE.md#v2x--v30) for complete upgrade instructions.**
-
-**Key changes:**
-
-- `SAPAIError` removed → Use `APICallError` from `@ai-sdk/provider`
-- Error properties: `error.code` → `error.statusCode`
-- Automatic retries for rate limits (429) and server errors (5xx)
-
-## ⚠️ Breaking Changes in v2.0
-
-Version 2.0 uses the official SAP AI SDK. **See the [Migration Guide](./MIGRATION_GUIDE.md#v1x--v20) for complete upgrade instructions.**
-
-**Key changes:**
-
-- Authentication via `AICORE_SERVICE_KEY` environment variable
-- Synchronous provider creation: `createSAPAIProvider()` (no await)
-- Helper functions from SAP AI SDK
-
 ## Table of Contents
 
 - [Features](#features)
@@ -41,7 +19,7 @@ Version 2.0 uses the official SAP AI SDK. **See the [Migration Guide](./MIGRATIO
 - [Configuration Options](#configuration-options)
 - [Error Handling](#error-handling)
 - [Examples](#examples)
-- [Migration Guides (v1→v2, v2→v3)](./MIGRATION_GUIDE.md)
+- [Migration Guides](#migration-guides)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -258,6 +236,8 @@ The following helper functions are exported by this package for convenient confi
 
 ### Tool Calling
 
+> **Note on Terminology:** This documentation uses "tool calling" (Vercel AI SDK convention), equivalent to "function calling" in OpenAI documentation. Both terms refer to the same capability of models invoking external functions.
+
 ```typescript
 import "dotenv/config"; // Load environment variables
 import { createSAPAIProvider } from "@mymediset/sap-ai-provider";
@@ -461,7 +441,29 @@ npx tsx examples/example-generate-text.ts
 
 **Note:** Examples require `AICORE_SERVICE_KEY` environment variable. See [Environment Setup](./ENVIRONMENT_SETUP.md) for configuration.
 
-**Upgrading from v1 or v2?** See the [Migration Guide](./MIGRATION_GUIDE.md) for detailed instructions (v1→v2, v2→v3).
+## Migration Guides
+
+### Upgrading from v2.x to v3.x
+
+Version 3.0 standardizes error handling to use Vercel AI SDK native error types. **See the [Migration Guide](./MIGRATION_GUIDE.md#v2x--v30) for complete upgrade instructions.**
+
+**Key changes:**
+
+- `SAPAIError` removed → Use `APICallError` from `@ai-sdk/provider`
+- Error properties: `error.code` → `error.statusCode`
+- Automatic retries for rate limits (429) and server errors (5xx)
+
+### Upgrading from v1.x to v2.x
+
+Version 2.0 uses the official SAP AI SDK. **See the [Migration Guide](./MIGRATION_GUIDE.md#v1x--v20) for complete upgrade instructions.**
+
+**Key changes:**
+
+- Authentication via `AICORE_SERVICE_KEY` environment variable
+- Synchronous provider creation: `createSAPAIProvider()` (no await)
+- Helper functions from SAP AI SDK
+
+**For detailed migration instructions with code examples, see the [complete Migration Guide](./MIGRATION_GUIDE.md).**
 
 ## Important Note
 

package/dist/index.cjs

@@ -29737,16 +29737,17 @@ var require_dist = __commonJS({
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  OrchestrationClient: () => import_orchestration4.OrchestrationClient,
-  OrchestrationResponse: () => import_orchestration3.OrchestrationResponse,
-  OrchestrationStreamChunkResponse: () => import_orchestration3.OrchestrationStreamChunkResponse,
-  OrchestrationStreamResponse: () => import_orchestration3.OrchestrationStreamResponse,
+  OrchestrationClient: () => import_orchestration5.OrchestrationClient,
+  OrchestrationResponse: () => import_orchestration4.OrchestrationResponse,
+  OrchestrationStreamChunkResponse: () => import_orchestration4.OrchestrationStreamChunkResponse,
+  OrchestrationStreamResponse: () => import_orchestration4.OrchestrationStreamResponse,
   buildAzureContentSafetyFilter: () => import_orchestration2.buildAzureContentSafetyFilter,
   buildDocumentGroundingConfig: () => import_orchestration2.buildDocumentGroundingConfig,
   buildDpiMaskingProvider: () => import_orchestration2.buildDpiMaskingProvider,
   buildLlamaGuard38BFilter: () => import_orchestration2.buildLlamaGuard38BFilter,
   buildTranslationConfig: () => import_orchestration2.buildTranslationConfig,
   createSAPAIProvider: () => createSAPAIProvider,
+  isConfigReference: () => import_orchestration3.isConfigReference,
   sapai: () => sapai
 });
 module.exports = __toCommonJS(index_exports);
@@ -30909,11 +30910,14 @@ var sapai = createSAPAIProvider();
 // src/sap-ai-chat-settings.ts
 var import_orchestration2 = require("@sap-ai-sdk/orchestration");
 
-// src/types/completion-response.ts
+// src/types/completion-request.ts
 var import_orchestration3 = require("@sap-ai-sdk/orchestration");
 
-// src/index.ts
+// src/types/completion-response.ts
 var import_orchestration4 = require("@sap-ai-sdk/orchestration");
+
+// src/index.ts
+var import_orchestration5 = require("@sap-ai-sdk/orchestration");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   OrchestrationClient,
@@ -30926,6 +30930,7 @@ var import_orchestration4 = require("@sap-ai-sdk/orchestration");
   buildLlamaGuard38BFilter,
   buildTranslationConfig,
   createSAPAIProvider,
+  isConfigReference,
   sapai
 });
 /*! Bundled license information: