@ai-sdk/openai-compatible 3.0.76 → 3.0.78

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @ai-sdk/openai-compatible
 
+## 3.0.78
+
+### Patch Changes
+
+- e729d58: chore(docs): update `README.md` for consistent format and to avoid duplication
+- Updated dependencies [5475347]
+- Updated dependencies [e729d58]
+  - @ai-sdk/provider@4.0.34
+  - @ai-sdk/provider-utils@5.0.68
+
+## 3.0.77
+
+### Patch Changes
+
+- Updated dependencies [8202f5b]
+- Updated dependencies [85d84a1]
+  - @ai-sdk/provider-utils@5.0.67
+  - @ai-sdk/provider@4.0.33
+
 ## 3.0.76
 
 ### Patch Changes

package/README.md

@@ -2,16 +2,12 @@
 
 This package provides a foundation for implementing providers that expose an OpenAI-compatible API.
 
-The primary [OpenAI provider](../openai/README.md) is more feature-rich, including OpenAI-specific experimental and legacy features. This package offers a lighter-weight alternative focused on core OpenAI-compatible functionality.
-
 > **Deploying to Vercel?** With Vercel's AI Gateway you can access hundreds of models from any provider — no additional packages, API keys, or extra cost. [Get started with AI Gateway](https://vercel.com/ai-gateway).
 
 ## Setup
 
-The provider is available in the `@ai-sdk/openai-compatible` module. You can install it with
-
 ```bash
-npm i @ai-sdk/openai-compatible
+npm i ai @ai-sdk/openai-compatible
 ```
 
 ## Skill for Coding Agents
@@ -22,15 +18,7 @@ If you use coding agents such as Claude Code or Cursor, we highly recommend addi
 npx skills add vercel/ai
 ```
 
-## Provider Instance
-
-You can import the provider creation method `createOpenAICompatible` from `@ai-sdk/openai-compatible`:
-
-```ts
-import { createOpenAICompatible } from '@ai-sdk/openai-compatible';
-```
-
-## Example
+## Usage
 
 ```ts
 import { createOpenAICompatible } from '@ai-sdk/openai-compatible';
@@ -46,65 +34,4 @@ const { text } = await generateText({
 });
 ```
 
-### Customizing headers
-
-You can further customize headers if desired. For example, here is an alternate implementation to pass along api key authentication:
-
-```ts
-import { createOpenAICompatible } from '@ai-sdk/openai-compatible';
-import { generateText } from 'ai';
-
-const { text } = await generateText({
-  model: createOpenAICompatible({
-    baseURL: 'https://api.example.com/v1',
-    name: 'example',
-    headers: {
-      Authorization: `Bearer ${process.env.MY_API_KEY}`,
-    },
-  }).chatModel('meta-llama/Llama-3-70b-chat-hf'),
-  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
-});
-```
-
-### Including model ids for auto-completion
-
-```ts
-import { createOpenAICompatible } from '@ai-sdk/openai-compatible';
-import { generateText } from 'ai';
-
-type ExampleChatModelIds =
-  | 'meta-llama/Llama-3-70b-chat-hf'
-  | 'meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo'
-  | (string & {});
-
-type ExampleCompletionModelIds =
-  | 'codellama/CodeLlama-34b-Instruct-hf'
-  | 'Qwen/Qwen2.5-Coder-32B-Instruct'
-  | (string & {});
-
-type ExampleEmbeddingModelIds =
-  | 'BAAI/bge-large-en-v1.5'
-  | 'bert-base-uncased'
-  | (string & {});
-
-const model = createOpenAICompatible<
-  ExampleChatModelIds,
-  ExampleCompletionModelIds,
-  ExampleEmbeddingModelIds
->({
-  baseURL: 'https://api.example.com/v1',
-  name: 'example',
-  apiKey: process.env.MY_API_KEY,
-});
-
-// Subsequent calls to e.g. `model.chatModel` will auto-complete the model id
-// from the list of `ExampleChatModelIds` while still allowing free-form
-// strings as well.
-
-const { text } = await generateText({
-  model: model.chatModel('meta-llama/Llama-3-70b-chat-hf'),
-  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
-});
-```
-
-For more examples, see the [OpenAI Compatible Providers](https://ai-sdk.dev/providers/openai-compatible-providers) documentation.
+See the [OpenAI Compatible Provider documentation](https://ai-sdk.dev/providers/openai-compatible-providers) for more information.

package/dist/index.js

@@ -1458,7 +1458,7 @@ async function fileToBlob(file) {
 }
 //#endregion
 //#region src/version.ts
-const VERSION = "3.0.76";
+const VERSION = "3.0.78";
 //#endregion
 //#region src/openai-compatible-provider.ts
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/openai-compatible",
-  "version": "3.0.76",
+  "version": "3.0.78",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -35,8 +35,8 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "4.0.32",
-    "@ai-sdk/provider-utils": "5.0.66"
+    "@ai-sdk/provider": "4.0.34",
+    "@ai-sdk/provider-utils": "5.0.68"
   },
   "devDependencies": {
     "@ai-sdk/test-server": "2.0.4",