@ai-sdk/fireworks 2.0.16 → 2.0.18

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @ai-sdk/fireworks
 
+## 2.0.18
+
+### Patch Changes
+
+- 2b8369d: chore: add docs to package dist
+
+## 2.0.17
+
+### Patch Changes
+
+- 8dc54db: chore: add src folders to package bundle
+- Updated dependencies [8dc54db]
+  - @ai-sdk/openai-compatible@2.0.17
+
 ## 2.0.16
 
 ### Patch Changes

package/dist/index.js

@@ -174,7 +174,7 @@ var import_provider_utils2 = require("@ai-sdk/provider-utils");
 var import_v4 = require("zod/v4");
 
 // src/version.ts
-var VERSION = true ? "2.0.16" : "0.0.0-test";
+var VERSION = true ? "2.0.18" : "0.0.0-test";
 
 // src/fireworks-provider.ts
 var fireworksErrorSchema = import_v4.z.object({

package/dist/index.mjs

@@ -159,7 +159,7 @@ import {
 import { z } from "zod/v4";
 
 // src/version.ts
-var VERSION = true ? "2.0.16" : "0.0.0-test";
+var VERSION = true ? "2.0.18" : "0.0.0-test";
 
 // src/fireworks-provider.ts
 var fireworksErrorSchema = z.object({

package/docs/26-fireworks.mdx

@@ -0,0 +1,289 @@
+---
+title: Fireworks
+description: Learn how to use Fireworks models with the AI SDK.
+---
+
+# Fireworks Provider
+
+[Fireworks](https://fireworks.ai/) is a platform for running and testing LLMs through their [API](https://readme.fireworks.ai/).
+
+## Setup
+
+The Fireworks provider is available via the `@ai-sdk/fireworks` module. You can install it with
+
+<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>
+  <Tab>
+    <Snippet text="pnpm add @ai-sdk/fireworks" dark />
+  </Tab>
+  <Tab>
+    <Snippet text="npm install @ai-sdk/fireworks" dark />
+  </Tab>
+  <Tab>
+    <Snippet text="yarn add @ai-sdk/fireworks" dark />
+  </Tab>
+
+  <Tab>
+    <Snippet text="bun add @ai-sdk/fireworks" dark />
+  </Tab>
+</Tabs>
+
+## Provider Instance
+
+You can import the default provider instance `fireworks` from `@ai-sdk/fireworks`:
+
+```ts
+import { fireworks } from '@ai-sdk/fireworks';
+```
+
+If you need a customized setup, you can import `createFireworks` from `@ai-sdk/fireworks`
+and create a provider instance with your settings:
+
+```ts
+import { createFireworks } from '@ai-sdk/fireworks';
+
+const fireworks = createFireworks({
+  apiKey: process.env.FIREWORKS_API_KEY ?? '',
+});
+```
+
+You can use the following optional settings to customize the Fireworks provider instance:
+
+- **baseURL** _string_
+
+  Use a different URL prefix for API calls, e.g. to use proxy servers.
+  The default prefix is `https://api.fireworks.ai/inference/v1`.
+
+- **apiKey** _string_
+
+  API key that is being sent using the `Authorization` header. It defaults to
+  the `FIREWORKS_API_KEY` environment variable.
+
+- **headers** _Record&lt;string,string&gt;_
+
+  Custom headers to include in the requests.
+
+- **fetch** _(input: RequestInfo, init?: RequestInit) => Promise&lt;Response&gt;_
+
+  Custom [fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch) implementation.
+
+## Language Models
+
+You can create [Fireworks models](https://fireworks.ai/models) using a provider instance.
+The first argument is the model id, e.g. `accounts/fireworks/models/firefunction-v1`:
+
+```ts
+const model = fireworks('accounts/fireworks/models/firefunction-v1');
+```
+
+### Reasoning Models
+
+Fireworks exposes the thinking of `deepseek-r1` in the generated text using the `<think>` tag.
+You can use the `extractReasoningMiddleware` to extract this reasoning and expose it as a `reasoning` property on the result:
+
+```ts
+import { fireworks } from '@ai-sdk/fireworks';
+import { wrapLanguageModel, extractReasoningMiddleware } from 'ai';
+
+const enhancedModel = wrapLanguageModel({
+  model: fireworks('accounts/fireworks/models/deepseek-r1'),
+  middleware: extractReasoningMiddleware({ tagName: 'think' }),
+});
+```
+
+You can then use that enhanced model in functions like `generateText` and `streamText`.
+
+### Example
+
+You can use Fireworks language models to generate text with the `generateText` function:
+
+```ts
+import { fireworks } from '@ai-sdk/fireworks';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: fireworks('accounts/fireworks/models/firefunction-v1'),
+  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
+});
+```
+
+Fireworks language models can also be used in the `streamText` function
+(see [AI SDK Core](/docs/ai-sdk-core)).
+
+### Completion Models
+
+You can create models that call the Fireworks completions API using the `.completion()` factory method:
+
+```ts
+const model = fireworks.completion('accounts/fireworks/models/firefunction-v1');
+```
+
+### Model Capabilities
+
+| Model                                                      | Image Input         | Object Generation   | Tool Usage          | Tool Streaming      |
+| ---------------------------------------------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
+| `accounts/fireworks/models/firefunction-v1`                | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `accounts/fireworks/models/deepseek-r1`                    | <Cross size={18} /> | <Check size={18} /> | <Cross size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/deepseek-v3`                    | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/llama-v3p1-405b-instruct`       | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `accounts/fireworks/models/llama-v3p1-8b-instruct`         | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/llama-v3p2-3b-instruct`         | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/llama-v3p3-70b-instruct`        | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/mixtral-8x7b-instruct`          | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/mixtral-8x7b-instruct-hf`       | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/mixtral-8x22b-instruct`         | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/qwen2p5-coder-32b-instruct`     | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/qwen2p5-72b-instruct`           | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/qwen-qwq-32b-preview`           | <Cross size={18} /> | <Check size={18} /> | <Cross size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/qwen2-vl-72b-instruct`          | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/llama-v3p2-11b-vision-instruct` | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/qwq-32b`                        | <Cross size={18} /> | <Check size={18} /> | <Cross size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/yi-large`                       | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/kimi-k2-instruct`               | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+
+<Note>
+  The table above lists popular models. Please see the [Fireworks models
+  page](https://fireworks.ai/models) for a full list of available models.
+</Note>
+
+## Embedding Models
+
+You can create models that call the Fireworks embeddings API using the `.embedding()` factory method:
+
+```ts
+const model = fireworks.embedding('nomic-ai/nomic-embed-text-v1.5');
+```
+
+You can use Fireworks embedding models to generate embeddings with the `embed` function:
+
+```ts
+import { fireworks } from '@ai-sdk/fireworks';
+import { embed } from 'ai';
+
+const { embedding } = await embed({
+  model: fireworks.embedding('nomic-ai/nomic-embed-text-v1.5'),
+  value: 'sunny day at the beach',
+});
+```
+
+### Model Capabilities
+
+| Model                            | Dimensions | Max Tokens |
+| -------------------------------- | ---------- | ---------- |
+| `nomic-ai/nomic-embed-text-v1.5` | 768        | 8192       |
+
+<Note>
+  For more embedding models, see the [Fireworks models
+  page](https://fireworks.ai/models) for a full list of available models.
+</Note>
+
+## Image Models
+
+You can create Fireworks image models using the `.image()` factory method.
+For more on image generation with the AI SDK see [generateImage()](/docs/reference/ai-sdk-core/generate-image).
+
+```ts
+import { fireworks } from '@ai-sdk/fireworks';
+import { generateImage } from 'ai';
+
+const { image } = await generateImage({
+  model: fireworks.image('accounts/fireworks/models/flux-1-dev-fp8'),
+  prompt: 'A futuristic cityscape at sunset',
+  aspectRatio: '16:9',
+});
+```
+
+<Note>
+  Model support for `size` and `aspectRatio` parameters varies. See the [Model
+  Capabilities](#model-capabilities-1) section below for supported dimensions,
+  or check the model's documentation on [Fireworks models
+  page](https://fireworks.ai/models) for more details.
+</Note>
+
+### Image Editing
+
+Fireworks supports image editing through FLUX Kontext models (`flux-kontext-pro` and `flux-kontext-max`). Pass input images via `prompt.images` to transform or edit existing images.
+
+<Note>
+  Fireworks Kontext models do not support explicit masks. Editing is
+  prompt-driven — describe what you want to change in the text prompt.
+</Note>
+
+#### Basic Image Editing
+
+Transform an existing image using text prompts:
+
+```ts
+const imageBuffer = readFileSync('./input-image.png');
+
+const { images } = await generateImage({
+  model: fireworks.image('accounts/fireworks/models/flux-kontext-pro'),
+  prompt: {
+    text: 'Turn the cat into a golden retriever dog',
+    images: [imageBuffer],
+  },
+  providerOptions: {
+    fireworks: {
+      output_format: 'jpeg',
+    },
+  },
+});
+```
+
+#### Style Transfer
+
+Apply artistic styles to an image:
+
+```ts
+const imageBuffer = readFileSync('./input-image.png');
+
+const { images } = await generateImage({
+  model: fireworks.image('accounts/fireworks/models/flux-kontext-pro'),
+  prompt: {
+    text: 'Transform this into a watercolor painting style',
+    images: [imageBuffer],
+  },
+  aspectRatio: '1:1',
+});
+```
+
+<Note>
+  Input images can be provided as `Buffer`, `ArrayBuffer`, `Uint8Array`, or
+  base64-encoded strings. Fireworks only supports a single input image per
+  request.
+</Note>
+
+### Model Capabilities
+
+For all models supporting aspect ratios, the following aspect ratios are supported:
+
+`1:1 (default), 2:3, 3:2, 4:5, 5:4, 16:9, 9:16, 9:21, 21:9`
+
+For all models supporting size, the following sizes are supported:
+
+`640 x 1536, 768 x 1344, 832 x 1216, 896 x 1152, 1024x1024 (default), 1152 x 896, 1216 x 832, 1344 x 768, 1536 x 640`
+
+| Model                                                        | Dimensions Specification | Image Editing       |
+| ------------------------------------------------------------ | ------------------------ | ------------------- |
+| `accounts/fireworks/models/flux-kontext-pro`                 | Aspect Ratio             | <Check size={18} /> |
+| `accounts/fireworks/models/flux-kontext-max`                 | Aspect Ratio             | <Check size={18} /> |
+| `accounts/fireworks/models/flux-1-dev-fp8`                   | Aspect Ratio             | <Cross size={18} /> |
+| `accounts/fireworks/models/flux-1-schnell-fp8`               | Aspect Ratio             | <Cross size={18} /> |
+| `accounts/fireworks/models/playground-v2-5-1024px-aesthetic` | Size                     | <Cross size={18} /> |
+| `accounts/fireworks/models/japanese-stable-diffusion-xl`     | Size                     | <Cross size={18} /> |
+| `accounts/fireworks/models/playground-v2-1024px-aesthetic`   | Size                     | <Cross size={18} /> |
+| `accounts/fireworks/models/SSD-1B`                           | Size                     | <Cross size={18} /> |
+| `accounts/fireworks/models/stable-diffusion-xl-1024-v1-0`    | Size                     | <Cross size={18} /> |
+
+For more details, see the [Fireworks models page](https://fireworks.ai/models).
+
+#### Stability AI Models
+
+Fireworks also presents several Stability AI models backed by Stability AI API
+keys and endpoint. The AI SDK Fireworks provider does not currently include
+support for these models:
+
+| Model ID                               |
+| -------------------------------------- |
+| `accounts/stability/models/sd3-turbo`  |
+| `accounts/stability/models/sd3-medium` |
+| `accounts/stability/models/sd3`        |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/fireworks",
-  "version": "2.0.16",
+  "version": "2.0.18",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -8,9 +8,14 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist/**/*",
+    "docs/**/*",
+    "src",
     "CHANGELOG.md",
     "README.md"
   ],
+  "directories": {
+    "doc": "./docs"
+  },
   "exports": {
     "./package.json": "./package.json",
     ".": {
@@ -20,7 +25,7 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/openai-compatible": "2.0.16",
+    "@ai-sdk/openai-compatible": "2.0.17",
     "@ai-sdk/provider": "3.0.4",
     "@ai-sdk/provider-utils": "4.0.8"
   },
@@ -29,7 +34,7 @@
     "tsup": "^8",
     "typescript": "5.8.3",
     "zod": "3.25.76",
-    "@ai-sdk/test-server": "1.0.1",
+    "@ai-sdk/test-server": "1.0.2",
     "@vercel/ai-tsconfig": "0.0.0"
   },
   "peerDependencies": {
@@ -55,7 +60,7 @@
   "scripts": {
     "build": "pnpm clean && tsup --tsconfig tsconfig.build.json",
     "build:watch": "pnpm clean && tsup --watch",
-    "clean": "del-cli dist *.tsbuildinfo",
+    "clean": "del-cli dist docs *.tsbuildinfo",
     "lint": "eslint \"./**/*.ts*\"",
     "type-check": "tsc --build",
     "prettier-check": "prettier --check \"./**/*.ts*\"",

package/src/fireworks-chat-options.ts

@@ -0,0 +1,20 @@
+// https://docs.fireworks.ai/docs/serverless-models#chat-models
+// Below is just a subset of the available models.
+export type FireworksChatModelId =
+  | 'accounts/fireworks/models/deepseek-v3'
+  | 'accounts/fireworks/models/llama-v3p3-70b-instruct'
+  | 'accounts/fireworks/models/llama-v3p2-3b-instruct'
+  | 'accounts/fireworks/models/llama-v3p1-405b-instruct'
+  | 'accounts/fireworks/models/llama-v3p1-8b-instruct'
+  | 'accounts/fireworks/models/mixtral-8x7b-instruct'
+  | 'accounts/fireworks/models/mixtral-8x22b-instruct'
+  | 'accounts/fireworks/models/mixtral-8x7b-instruct-hf'
+  | 'accounts/fireworks/models/qwen2p5-coder-32b-instruct'
+  | 'accounts/fireworks/models/qwen2p5-72b-instruct'
+  | 'accounts/fireworks/models/qwen-qwq-32b-preview'
+  | 'accounts/fireworks/models/qwen2-vl-72b-instruct'
+  | 'accounts/fireworks/models/llama-v3p2-11b-vision-instruct'
+  | 'accounts/fireworks/models/qwq-32b'
+  | 'accounts/fireworks/models/yi-large'
+  | 'accounts/fireworks/models/kimi-k2-instruct'
+  | (string & {});

package/src/fireworks-completion-options.ts

@@ -0,0 +1,5 @@
+// Below is just a subset of the available models.
+export type FireworksCompletionModelId =
+  | 'accounts/fireworks/models/llama-v3-8b-instruct'
+  | 'accounts/fireworks/models/llama-v2-34b-code'
+  | (string & {});

package/src/fireworks-embedding-options.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod/v4';
+
+// Below is just a subset of the available models.
+export type FireworksEmbeddingModelId =
+  | 'nomic-ai/nomic-embed-text-v1.5'
+  | (string & {});
+
+export const fireworksEmbeddingProviderOptions = z.object({});
+
+export type FireworksEmbeddingProviderOptions = z.infer<
+  typeof fireworksEmbeddingProviderOptions
+>;