@ai-sdk/mistral 0.0.0-70e0935a-20260114150030 → 0.0.0-98261322-20260122142521

package/CHANGELOG.md

@@ -1,12 +1,39 @@
 # @ai-sdk/mistral
 
-## 0.0.0-70e0935a-20260114150030
+## 0.0.0-98261322-20260122142521
 
 ### Patch Changes
 
-- Updated dependencies [9fbe723]
-  - @ai-sdk/provider-utils@0.0.0-70e0935a-20260114150030
-  - @ai-sdk/provider@0.0.0-70e0935a-20260114150030
+- 080559b: chore: add docs to package dist
+
+## 3.0.10
+
+### Patch Changes
+
+- 8dc54db: chore: add src folders to package bundle
+
+## 3.0.9
+
+### Patch Changes
+
+- Updated dependencies [5c090e7]
+  - @ai-sdk/provider@3.0.4
+  - @ai-sdk/provider-utils@4.0.8
+
+## 3.0.8
+
+### Patch Changes
+
+- Updated dependencies [46f46e4]
+  - @ai-sdk/provider-utils@4.0.7
+
+## 3.0.7
+
+### Patch Changes
+
+- Updated dependencies [1b11dcb]
+  - @ai-sdk/provider-utils@4.0.6
+  - @ai-sdk/provider@3.0.3
 
 ## 3.0.6
 

package/dist/index.js

@@ -828,7 +828,7 @@ var MistralTextEmbeddingResponseSchema = import_v44.z.object({
 });
 
 // src/version.ts
-var VERSION = true ? "0.0.0-70e0935a-20260114150030" : "0.0.0-test";
+var VERSION = true ? "0.0.0-98261322-20260122142521" : "0.0.0-test";
 
 // src/mistral-provider.ts
 function createMistral(options = {}) {

package/dist/index.mjs

@@ -824,7 +824,7 @@ var MistralTextEmbeddingResponseSchema = z4.object({
 });
 
 // src/version.ts
-var VERSION = true ? "0.0.0-70e0935a-20260114150030" : "0.0.0-test";
+var VERSION = true ? "0.0.0-98261322-20260122142521" : "0.0.0-test";
 
 // src/mistral-provider.ts
 function createMistral(options = {}) {

package/docs/20-mistral.mdx

@@ -0,0 +1,327 @@
+---
+title: Mistral AI
+description: Learn how to use Mistral.
+---
+
+# Mistral AI Provider
+
+The [Mistral AI](https://mistral.ai/) provider contains language model support for the Mistral chat API.
+
+## Setup
+
+The Mistral provider is available in the `@ai-sdk/mistral` module. You can install it with
+
+<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>
+  <Tab>
+    <Snippet text="pnpm add @ai-sdk/mistral" dark />
+  </Tab>
+  <Tab>
+    <Snippet text="npm install @ai-sdk/mistral" dark />
+  </Tab>
+  <Tab>
+    <Snippet text="yarn add @ai-sdk/mistral" dark />
+  </Tab>
+
+  <Tab>
+    <Snippet text="bun add @ai-sdk/mistral" dark />
+  </Tab>
+</Tabs>
+
+## Provider Instance
+
+You can import the default provider instance `mistral` from `@ai-sdk/mistral`:
+
+```ts
+import { mistral } from '@ai-sdk/mistral';
+```
+
+If you need a customized setup, you can import `createMistral` from `@ai-sdk/mistral`
+and create a provider instance with your settings:
+
+```ts
+import { createMistral } from '@ai-sdk/mistral';
+
+const mistral = createMistral({
+  // custom settings
+});
+```
+
+You can use the following optional settings to customize the Mistral provider instance:
+
+- **baseURL** _string_
+
+  Use a different URL prefix for API calls, e.g. to use proxy servers.
+  The default prefix is `https://api.mistral.ai/v1`.
+
+- **apiKey** _string_
+
+  API key that is being sent using the `Authorization` header.
+  It defaults to the `MISTRAL_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.
+  Defaults to the global `fetch` function.
+  You can use it as a middleware to intercept requests,
+  or to provide a custom fetch implementation for e.g. testing.
+
+## Language Models
+
+You can create models that call the [Mistral chat API](https://docs.mistral.ai/api/#operation/createChatCompletion) using a provider instance.
+The first argument is the model id, e.g. `mistral-large-latest`.
+Some Mistral chat models support tool calls.
+
+```ts
+const model = mistral('mistral-large-latest');
+```
+
+Mistral chat models also support additional model settings that are not part of the [standard call settings](/docs/ai-sdk-core/settings).
+You can pass them as an options argument and utilize `MistralLanguageModelOptions` for typing:
+
+```ts
+import { mistral, type MistralLanguageModelOptions } from '@ai-sdk/mistral';
+const model = mistral('mistral-large-latest');
+
+await generateText({
+  model,
+  providerOptions: {
+    mistral: {
+      safePrompt: true, // optional safety prompt injection
+      parallelToolCalls: false, // disable parallel tool calls (one tool per response)
+    } satisfies MistralLanguageModelOptions,
+  },
+});
+```
+
+The following optional provider options are available for Mistral models:
+
+- **safePrompt** _boolean_
+
+  Whether to inject a safety prompt before all conversations.
+
+  Defaults to `false`.
+
+- **documentImageLimit** _number_
+
+  Maximum number of images to process in a document.
+
+- **documentPageLimit** _number_
+
+  Maximum number of pages to process in a document.
+
+- **strictJsonSchema** _boolean_
+
+  Whether to use strict JSON schema validation for structured outputs. Only applies when a schema is provided and only sets the [`strict` flag](https://docs.mistral.ai/api/#tag/chat/operation/chat_completion_v1_chat_completions_post) in addition to using [Custom Structured Outputs](https://docs.mistral.ai/capabilities/structured-output/custom_structured_output/), which is used by default if a schema is provided.
+
+  Defaults to `false`.
+
+- **structuredOutputs** _boolean_
+
+  Whether to use [structured outputs](#structured-outputs). When enabled, tool calls and object generation will be strict and follow the provided schema.
+
+  Defaults to `true`.
+
+- **parallelToolCalls** _boolean_
+
+  Whether to enable parallel function calling during tool use. When set to false, the model will use at most one tool per response.
+
+  Defaults to `true`.
+
+### Document OCR
+
+Mistral chat models support document OCR for PDF files.
+You can optionally set image and page limits using the provider options.
+
+```ts
+const result = await generateText({
+  model: mistral('mistral-small-latest'),
+  messages: [
+    {
+      role: 'user',
+      content: [
+        {
+          type: 'text',
+          text: 'What is an embedding model according to this document?',
+        },
+        {
+          type: 'file',
+          data: new URL(
+            'https://github.com/vercel/ai/blob/main/examples/ai-functions/data/ai.pdf?raw=true',
+          ),
+          mediaType: 'application/pdf',
+        },
+      ],
+    },
+  ],
+  // optional settings:
+  providerOptions: {
+    mistral: {
+      documentImageLimit: 8,
+      documentPageLimit: 64,
+    },
+  },
+});
+```
+
+### Reasoning Models
+
+Mistral offers reasoning models that provide step-by-step thinking capabilities:
+
+- **magistral-small-2506**: Smaller reasoning model for efficient step-by-step thinking
+- **magistral-medium-2506**: More powerful reasoning model balancing performance and cost
+
+These models return content that includes `<think>...</think>` tags containing the reasoning process. To properly extract and separate the reasoning from the final answer, use the [extract reasoning middleware](/docs/reference/ai-sdk-core/extract-reasoning-middleware):
+
+```ts
+import { mistral } from '@ai-sdk/mistral';
+import {
+  extractReasoningMiddleware,
+  generateText,
+  wrapLanguageModel,
+} from 'ai';
+
+const result = await generateText({
+  model: wrapLanguageModel({
+    model: mistral('magistral-small-2506'),
+    middleware: extractReasoningMiddleware({
+      tagName: 'think',
+    }),
+  }),
+  prompt: 'What is 15 * 24?',
+});
+
+console.log('REASONING:', result.reasoningText);
+// Output: "Let me calculate this step by step..."
+
+console.log('ANSWER:', result.text);
+// Output: "360"
+```
+
+The middleware automatically parses the `<think>` tags and provides separate `reasoningText` and `text` properties in the result.
+
+### Example
+
+You can use Mistral language models to generate text with the `generateText` function:
+
+```ts
+import { mistral } from '@ai-sdk/mistral';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: mistral('mistral-large-latest'),
+  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
+});
+```
+
+Mistral language models can also be used in the `streamText`, `generateObject`, and `streamObject` functions
+(see [AI SDK Core](/docs/ai-sdk-core)).
+
+#### Structured Outputs
+
+Mistral chat models support structured outputs using JSON Schema. You can use `generateObject` or `streamObject`
+with Zod, Valibot, or raw JSON Schema. The SDK sends your schema via Mistral's `response_format: { type: 'json_schema' }`.
+
+```ts
+import { mistral } from '@ai-sdk/mistral';
+import { generateObject } from 'ai';
+import { z } from 'zod';
+
+const result = await generateObject({
+  model: mistral('mistral-large-latest'),
+  schema: z.object({
+    recipe: z.object({
+      name: z.string(),
+      ingredients: z.array(z.string()),
+      instructions: z.array(z.string()),
+    }),
+  }),
+  prompt: 'Generate a simple pasta recipe.',
+});
+
+console.log(JSON.stringify(result.object, null, 2));
+```
+
+You can enable strict JSON Schema validation using a provider option:
+
+```ts highlight="7-11"
+import { mistral } from '@ai-sdk/mistral';
+import { generateObject } from 'ai';
+import { z } from 'zod';
+
+const result = await generateObject({
+  model: mistral('mistral-large-latest'),
+  providerOptions: {
+    mistral: {
+      strictJsonSchema: true, // reject outputs that don't strictly match the schema
+    },
+  },
+  schema: z.object({
+    title: z.string(),
+    items: z.array(z.object({ id: z.string(), qty: z.number().int().min(1) })),
+  }),
+  prompt: 'Generate a small shopping list.',
+});
+```
+
+<Note>
+  When using structured outputs, the SDK no longer injects an extra "answer with
+  JSON" instruction. It relies on Mistral's native `json_schema`/`json_object`
+  response formats instead. You can customize the schema name/description via
+  the standard structured-output APIs.
+</Note>
+
+### Model Capabilities
+
+| Model                   | Image Input         | Object Generation   | Tool Usage          | Tool Streaming      |
+| ----------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
+| `pixtral-large-latest`  | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `mistral-large-latest`  | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `mistral-medium-latest` | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `mistral-medium-2505`   | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `mistral-small-latest`  | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `magistral-small-2506`  | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `magistral-medium-2506` | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `ministral-3b-latest`   | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `ministral-8b-latest`   | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `pixtral-12b-2409`      | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `open-mistral-7b`       | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `open-mixtral-8x7b`     | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `open-mixtral-8x22b`    | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+
+<Note>
+  The table above lists popular models. Please see the [Mistral
+  docs](https://docs.mistral.ai/getting-started/models/models_overview/) for a
+  full list of available models. The table above lists popular models. You can
+  also pass any available provider model ID as a string if needed.
+</Note>
+
+## Embedding Models
+
+You can create models that call the [Mistral embeddings API](https://docs.mistral.ai/api/#operation/createEmbedding)
+using the `.embedding()` factory method.
+
+```ts
+const model = mistral.embedding('mistral-embed');
+```
+
+You can use Mistral embedding models to generate embeddings with the `embed` function:
+
+```ts
+import { mistral } from '@ai-sdk/mistral';
+import { embed } from 'ai';
+
+const { embedding } = await embed({
+  model: mistral.embedding('mistral-embed'),
+  value: 'sunny day at the beach',
+});
+```
+
+### Model Capabilities
+
+| Model           | Default Dimensions |
+| --------------- | ------------------ |
+| `mistral-embed` | 1024               |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/mistral",
-  "version": "0.0.0-70e0935a-20260114150030",
+  "version": "0.0.0-98261322-20260122142521",
   "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,15 +25,15 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "0.0.0-70e0935a-20260114150030",
-    "@ai-sdk/provider-utils": "0.0.0-70e0935a-20260114150030"
+    "@ai-sdk/provider": "3.0.4",
+    "@ai-sdk/provider-utils": "4.0.8"
   },
   "devDependencies": {
     "@types/node": "20.17.24",
     "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": {
@@ -54,7 +59,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/__fixtures__/mistral-generate-text.1.json

@@ -0,0 +1,22 @@
+{
+  "id": "5319bd0299614c679a0068a4f2c8ffd0",
+  "created": 1769088720,
+  "model": "mistral-small-latest",
+  "usage": {
+    "prompt_tokens": 13,
+    "total_tokens": 447,
+    "completion_tokens": 434
+  },
+  "object": "chat.completion",
+  "choices": [
+    {
+      "index": 0,
+      "finish_reason": "stop",
+      "message": {
+        "role": "assistant",
+        "tool_calls": null,
+        "content": "**Holiday Name: \"World Kindness Day of Sharing\"**\n\n**Date:** The third Saturday in October\n\n**Purpose:** To celebrate and promote acts of kindness, generosity, and connection by sharing something meaningful with others—whether it's time, skills, stories, or physical items.\n\n### **Traditions & Customs:**\n\n1. **\"Share a Skill\" Exchanges:**\n   - People teach others something they're good at—cooking, crafting, gardening, or even life advice—free of charge. Community centers, schools, and online platforms host skill-sharing sessions.\n\n2. **\"Story Swap\" Gatherings:**\n   - Friends and strangers meet in parks, cafes, or virtual spaces to share personal stories, jokes, or wisdom. The goal is to foster empathy and connection through storytelling.\n\n3. **\"Kindness Kits\" for Strangers:**\n   - People assemble small care packages (handwritten notes, snacks, seeds, or handmade crafts) and leave them in public places (libraries, bus stops, parks) for others to find.\n\n4. **\"Pay It Forward\" Chains:**\n   - Individuals perform random acts of kindness (buying coffee for the next person, donating to a cause, or helping a neighbor) and encourage others to do the same.\n\n5. **\"Memory Lane\" Sharing:**\n   - Families and friends gather to share old photos, heirlooms, or family recipes, passing down traditions and creating new ones.\n\n6. **\"Global Kindness Map\":**\n   - An interactive online map where people pin acts of kindness they've done or received, inspiring others to contribute.\n\n**Symbol:** A **hand holding a heart** (representing giving and compassion).\n\n**Food & Drink:** \"Kindness Cookies\" (homemade treats shared with neighbors) and \"Unity Tea\" (a blend of herbs from different cultures, symbolizing harmony).\n\n**Why It's Special:** Unlike commercial holidays, this day focuses on **meaningful human connection**—reminding everyone that kindness is a universal language.\n\nWould you celebrate it? What would you share? 😊"
+      }
+    }
+  ]
+}

package/src/__snapshots__/convert-to-mistral-chat-messages.test.ts.snap

@@ -0,0 +1,57 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`assistant messages > should add prefix true to trailing assistant messages 1`] = `
+[
+  {
+    "content": [
+      {
+        "text": "Hello",
+        "type": "text",
+      },
+    ],
+    "role": "user",
+  },
+  {
+    "content": "Hello!",
+    "prefix": true,
+    "role": "assistant",
+    "tool_calls": undefined,
+  },
+]
+`;
+
+exports[`user messages > should convert messages with PDF file parts using URL 1`] = `
+[
+  {
+    "content": [
+      {
+        "text": "Please analyze this document",
+        "type": "text",
+      },
+      {
+        "document_url": "https://example.com/document.pdf",
+        "type": "document_url",
+      },
+    ],
+    "role": "user",
+  },
+]
+`;
+
+exports[`user messages > should convert messages with image parts 1`] = `
+[
+  {
+    "content": [
+      {
+        "text": "Hello",
+        "type": "text",
+      },
+      {
+        "image_url": "data:image/png;base64,AAECAw==",
+        "type": "image_url",
+      },
+    ],
+    "role": "user",
+  },
+]
+`;

package/src/__snapshots__/mistral-embedding-model.test.ts.snap

@@ -0,0 +1,44 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`doEmbed > should expose the raw response 1`] = `
+{
+  "body": {
+    "data": [
+      {
+        "embedding": [
+          0.1,
+          0.2,
+          0.3,
+          0.4,
+          0.5,
+        ],
+        "index": 0,
+        "object": "embedding",
+      },
+      {
+        "embedding": [
+          0.6,
+          0.7,
+          0.8,
+          0.9,
+          1,
+        ],
+        "index": 1,
+        "object": "embedding",
+      },
+    ],
+    "id": "b322cfc2b9d34e2f8e14fc99874faee5",
+    "model": "mistral-embed",
+    "object": "list",
+    "usage": {
+      "prompt_tokens": 8,
+      "total_tokens": 8,
+    },
+  },
+  "headers": {
+    "content-length": "267",
+    "content-type": "application/json",
+    "test-header": "test-value",
+  },
+}
+`;

package/src/convert-mistral-usage.ts

@@ -0,0 +1,46 @@
+import { LanguageModelV3Usage } from '@ai-sdk/provider';
+
+export type MistralUsage = {
+  prompt_tokens: number;
+  completion_tokens: number;
+  total_tokens: number;
+};
+
+export function convertMistralUsage(
+  usage: MistralUsage | undefined | null,
+): LanguageModelV3Usage {
+  if (usage == null) {
+    return {
+      inputTokens: {
+        total: undefined,
+        noCache: undefined,
+        cacheRead: undefined,
+        cacheWrite: undefined,
+      },
+      outputTokens: {
+        total: undefined,
+        text: undefined,
+        reasoning: undefined,
+      },
+      raw: undefined,
+    };
+  }
+
+  const promptTokens = usage.prompt_tokens;
+  const completionTokens = usage.completion_tokens;
+
+  return {
+    inputTokens: {
+      total: promptTokens,
+      noCache: promptTokens,
+      cacheRead: undefined,
+      cacheWrite: undefined,
+    },
+    outputTokens: {
+      total: completionTokens,
+      text: completionTokens,
+      reasoning: undefined,
+    },
+    raw: usage,
+  };
+}