@apertis/ai-sdk-provider 0.1.1 → 1.1.0

package/README.md

@@ -2,10 +2,15 @@
 
 Apertis AI provider for the [Vercel AI SDK](https://sdk.vercel.ai/).
 
+## Compatibility
+
+- **Requires AI SDK 6.0+** - This package implements the `LanguageModelV3` specification
+- **Node.js 18+** - Minimum supported Node.js version
+
 ## Installation
 
 ```bash
-npm install @apertis/ai-sdk-provider
+npm install @apertis/ai-sdk-provider ai
 ```
 
 ## Setup
@@ -74,15 +79,87 @@ const { text } = await generateText({
 });
 ```
 
+### Text Completions
+
+For models that support the legacy completion API:
+
+```typescript
+import { apertis } from '@apertis/ai-sdk-provider';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: apertis.completion('gpt-3.5-turbo-instruct'),
+  prompt: 'Complete this: The quick brown fox',
+});
+```
+
+### Embeddings
+
+Generate vector embeddings for semantic search and similarity:
+
+```typescript
+import { apertis } from '@apertis/ai-sdk-provider';
+import { embed, embedMany } from 'ai';
+
+// Single embedding
+const { embedding } = await embed({
+  model: apertis.textEmbeddingModel('text-embedding-3-small'),
+  value: 'Hello world',
+});
+
+// Multiple embeddings
+const { embeddings } = await embedMany({
+  model: apertis.textEmbeddingModel('text-embedding-3-large', {
+    dimensions: 1024, // Optional: reduce dimensions
+  }),
+  values: ['Hello', 'World'],
+});
+```
+
 ## Supported Models
 
 Any model available on Apertis AI, including:
 
+### Chat Models
 - `gpt-5.2`, `gpt-5.2-codex`, `gpt-5.1`
 - `claude-opus-4-5-20251101`, `claude-sonnet-4.5`, `claude-haiku-4.5`
 - `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-2.5-flash-preview`
 - And 470+ more models
 
+### Completion Models
+- `gpt-3.5-turbo-instruct`
+- `davinci-002`, `babbage-002`
+
+### Embedding Models
+- `text-embedding-3-small`, `text-embedding-3-large`
+- `text-embedding-ada-002`
+
+## Provider Configuration
+
+```typescript
+import { createApertis } from '@apertis/ai-sdk-provider';
+
+const apertis = createApertis({
+  apiKey: 'sk-your-api-key',     // Optional if APERTIS_API_KEY is set
+  baseURL: 'https://api.apertis.ai/v1',  // Custom API endpoint
+  headers: { 'X-Custom': 'value' },      // Custom headers
+});
+```
+
+## What's New (v1.1.0)
+
+- **ProviderV3 Interface** - Full implementation of `ProviderV3` specification
+- **Completion Models** - Support for text completion via `apertis.completion()`
+- **Embedding Models** - Support for embeddings via `apertis.textEmbeddingModel()`
+
+## Breaking Changes (v1.0.0)
+
+- **Requires AI SDK 6+** - No longer compatible with AI SDK 5.x
+- **V3 Specification** - Implements `LanguageModelV3` interface
+- **Content format** - Output uses `content` array instead of separate `text`/`toolCalls`
+- **Usage format** - Token tracking uses new `inputTokens`/`outputTokens` structure
+- **Supported URLs** - New `supportedUrls` property for image URL support
+
 ## License
 
 Apache-2.0