@ai-sdk/mistral 0.0.0-85f9a635-20240518005312 → 0.0.0-98261322-20260122142521

package/README.md

@@ -1,7 +1,6 @@
-# Vercel AI SDK - Mistral Provider
+# AI SDK - Mistral Provider
 
-The [Mistral](https://mistral.ai/) provider for the [Vercel AI SDK](https://sdk.vercel.ai/docs) contains language model support for the Mistral chat API.
-It creates language model objects that can be used with the `generateText`, `streamText`, `generateObject`, and `streamObject` AI functions.
+The **[Mistral provider](https://ai-sdk.dev/providers/ai-sdk-providers/mistral)** for the [AI SDK](https://ai-sdk.dev/docs) contains language model support for the Mistral chat API.
 
 ## Setup
 
@@ -19,55 +18,18 @@ You can import the default provider instance `mistral` from `@ai-sdk/mistral`:
 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:
+## Example
 
 ```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 send using the `Authorization` header.
-  It defaults to the `MISTRAL_API_KEY` environment variable.
-
-- **headers** _Record<string,string>_
-
-  Custom headers to include in the requests.
-
-## Models
-
-You can create models that call the [Mistral chat API](https://docs.mistral.ai/api/#operation/createChatCompletion) using 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-core/settings).
-You can pass them as an options argument:
+import { mistral } from '@ai-sdk/mistral';
+import { generateText } from 'ai';
 
-```ts
-const model = mistral('mistral-large-latest', {
-  safePrompt: true, // optional safety prompt injection
+const { text } = await generateText({
+  model: mistral('mistral-large-latest'),
+  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
 });
 ```
 
-The following optional settings are available for Mistral models:
-
-- **safePrompt** _boolean_
-
-  Whether to inject a safety prompt before all conversations.
+## Documentation
 
-  Defaults to `false`.
+Please check out the **[Mistral provider](https://ai-sdk.dev/providers/ai-sdk-providers/mistral)** for more information.

package/dist/index.d.mts

@@ -1,73 +1,46 @@
-import { LanguageModelV1, EmbeddingModelV1 } from '@ai-sdk/provider';
+import { ProviderV3, LanguageModelV3, EmbeddingModelV3 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
 
-type MistralChatModelId = 'open-mistral-7b' | 'open-mixtral-8x7b' | 'open-mixtral-8x22b' | 'mistral-small-latest' | 'mistral-medium-latest' | 'mistral-large-latest' | (string & {});
-interface MistralChatSettings {
-    /**
-  Whether to inject a safety prompt before all conversations.
-  
-  Defaults to `false`.
-     */
-    safePrompt?: boolean;
-}
-
-type MistralChatConfig = {
-    provider: string;
-    baseURL: string;
-    headers: () => Record<string, string | undefined>;
-    generateId: () => string;
-};
-declare class MistralChatLanguageModel implements LanguageModelV1 {
-    readonly specificationVersion = "v1";
-    readonly defaultObjectGenerationMode = "json";
-    readonly modelId: MistralChatModelId;
-    readonly settings: MistralChatSettings;
-    private readonly config;
-    constructor(modelId: MistralChatModelId, settings: MistralChatSettings, config: MistralChatConfig);
-    get provider(): string;
-    private getArgs;
-    doGenerate(options: Parameters<LanguageModelV1['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doGenerate']>>>;
-    doStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
-}
+type MistralChatModelId = 'ministral-3b-latest' | 'ministral-8b-latest' | 'mistral-large-latest' | 'mistral-medium-latest' | 'mistral-medium-2508' | 'mistral-medium-2505' | 'mistral-small-latest' | 'pixtral-large-latest' | 'magistral-small-2507' | 'magistral-medium-2507' | 'magistral-small-2506' | 'magistral-medium-2506' | 'pixtral-12b-2409' | 'open-mistral-7b' | 'open-mixtral-8x7b' | 'open-mixtral-8x22b' | (string & {});
+declare const mistralLanguageModelOptions: z.ZodObject<{
+    safePrompt: z.ZodOptional<z.ZodBoolean>;
+    documentImageLimit: z.ZodOptional<z.ZodNumber>;
+    documentPageLimit: z.ZodOptional<z.ZodNumber>;
+    structuredOutputs: z.ZodOptional<z.ZodBoolean>;
+    strictJsonSchema: z.ZodOptional<z.ZodBoolean>;
+    parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+type MistralLanguageModelOptions = z.infer<typeof mistralLanguageModelOptions>;
 
 type MistralEmbeddingModelId = 'mistral-embed' | (string & {});
-interface MistralEmbeddingSettings {
-    /**
-  Override the maximum number of embeddings per call.
-     */
-    maxEmbeddingsPerCall?: number;
-    /**
-  Override the parallelism of embedding calls.
-      */
-    supportsParallelCalls?: boolean;
-}
-
-type MistralEmbeddingConfig = {
-    provider: string;
-    baseURL: string;
-    headers: () => Record<string, string | undefined>;
-};
-declare class MistralEmbeddingModel implements EmbeddingModelV1<string> {
-    readonly specificationVersion = "v1";
-    readonly modelId: MistralEmbeddingModelId;
-    private readonly config;
-    private readonly settings;
-    get provider(): string;
-    get maxEmbeddingsPerCall(): number;
-    get supportsParallelCalls(): boolean;
-    constructor(modelId: MistralEmbeddingModelId, settings: MistralEmbeddingSettings, config: MistralEmbeddingConfig);
-    doEmbed({ values, abortSignal, }: Parameters<EmbeddingModelV1<string>['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV1<string>['doEmbed']>>>;
-}
 
-interface MistralProvider {
-    (modelId: MistralChatModelId, settings?: MistralChatSettings): MistralChatLanguageModel;
+interface MistralProvider extends ProviderV3 {
+    (modelId: MistralChatModelId): LanguageModelV3;
     /**
   Creates a model for text generation.
   */
-    chat(modelId: MistralChatModelId, settings?: MistralChatSettings): MistralChatLanguageModel;
+    languageModel(modelId: MistralChatModelId): LanguageModelV3;
+    /**
+  Creates a model for text generation.
+  */
+    chat(modelId: MistralChatModelId): LanguageModelV3;
+    /**
+     * Creates a model for text embeddings.
+     */
+    embedding(modelId: MistralEmbeddingModelId): EmbeddingModelV3;
+    /**
+     * Creates a model for text embeddings.
+     */
+    embeddingModel: (modelId: MistralEmbeddingModelId) => EmbeddingModelV3;
+    /**
+     * @deprecated Use `embedding` instead.
+     */
+    textEmbedding(modelId: MistralEmbeddingModelId): EmbeddingModelV3;
     /**
-  Creates a model for text embeddings.
+     * @deprecated Use `embeddingModel` instead.
      */
-    embedding(modelId: MistralEmbeddingModelId, settings?: MistralEmbeddingSettings): MistralEmbeddingModel;
+    textEmbeddingModel(modelId: MistralEmbeddingModelId): EmbeddingModelV3;
 }
 interface MistralProviderSettings {
     /**
@@ -76,10 +49,6 @@ interface MistralProviderSettings {
      */
     baseURL?: string;
     /**
-  @deprecated Use `baseURL` instead.
-     */
-    baseUrl?: string;
-    /**
   API key that is being send using the `Authorization` header.
   It defaults to the `MISTRAL_API_KEY` environment variable.
      */
@@ -88,6 +57,11 @@ interface MistralProviderSettings {
   Custom headers to include in the requests.
        */
     headers?: Record<string, string>;
+    /**
+  Custom fetch implementation. You can use it as a middleware to intercept requests,
+  or to provide a custom fetch implementation for e.g. testing.
+      */
+    fetch?: FetchFunction;
     generateId?: () => string;
 }
 /**
@@ -99,23 +73,6 @@ Default Mistral provider instance.
  */
 declare const mistral: MistralProvider;
 
-/**
- * @deprecated Use `createMistral` instead.
- */
-declare class Mistral {
-    /**
-     * Base URL for the Mistral API calls.
-     */
-    readonly baseURL: string;
-    readonly apiKey?: string;
-    readonly headers?: Record<string, string>;
-    private readonly generateId;
-    /**
-     * Creates a new Mistral provider instance.
-     */
-    constructor(options?: MistralProviderSettings);
-    private get baseConfig();
-    chat(modelId: MistralChatModelId, settings?: MistralChatSettings): MistralChatLanguageModel;
-}
+declare const VERSION: string;
 
-export { Mistral, type MistralProvider, type MistralProviderSettings, createMistral, mistral };
+export { type MistralLanguageModelOptions, type MistralProvider, type MistralProviderSettings, VERSION, createMistral, mistral };

package/dist/index.d.ts

@@ -1,73 +1,46 @@
-import { LanguageModelV1, EmbeddingModelV1 } from '@ai-sdk/provider';
+import { ProviderV3, LanguageModelV3, EmbeddingModelV3 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
 
-type MistralChatModelId = 'open-mistral-7b' | 'open-mixtral-8x7b' | 'open-mixtral-8x22b' | 'mistral-small-latest' | 'mistral-medium-latest' | 'mistral-large-latest' | (string & {});
-interface MistralChatSettings {
-    /**
-  Whether to inject a safety prompt before all conversations.
-  
-  Defaults to `false`.
-     */
-    safePrompt?: boolean;
-}
-
-type MistralChatConfig = {
-    provider: string;
-    baseURL: string;
-    headers: () => Record<string, string | undefined>;
-    generateId: () => string;
-};
-declare class MistralChatLanguageModel implements LanguageModelV1 {
-    readonly specificationVersion = "v1";
-    readonly defaultObjectGenerationMode = "json";
-    readonly modelId: MistralChatModelId;
-    readonly settings: MistralChatSettings;
-    private readonly config;
-    constructor(modelId: MistralChatModelId, settings: MistralChatSettings, config: MistralChatConfig);
-    get provider(): string;
-    private getArgs;
-    doGenerate(options: Parameters<LanguageModelV1['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doGenerate']>>>;
-    doStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
-}
+type MistralChatModelId = 'ministral-3b-latest' | 'ministral-8b-latest' | 'mistral-large-latest' | 'mistral-medium-latest' | 'mistral-medium-2508' | 'mistral-medium-2505' | 'mistral-small-latest' | 'pixtral-large-latest' | 'magistral-small-2507' | 'magistral-medium-2507' | 'magistral-small-2506' | 'magistral-medium-2506' | 'pixtral-12b-2409' | 'open-mistral-7b' | 'open-mixtral-8x7b' | 'open-mixtral-8x22b' | (string & {});
+declare const mistralLanguageModelOptions: z.ZodObject<{
+    safePrompt: z.ZodOptional<z.ZodBoolean>;
+    documentImageLimit: z.ZodOptional<z.ZodNumber>;
+    documentPageLimit: z.ZodOptional<z.ZodNumber>;
+    structuredOutputs: z.ZodOptional<z.ZodBoolean>;
+    strictJsonSchema: z.ZodOptional<z.ZodBoolean>;
+    parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+type MistralLanguageModelOptions = z.infer<typeof mistralLanguageModelOptions>;
 
 type MistralEmbeddingModelId = 'mistral-embed' | (string & {});
-interface MistralEmbeddingSettings {
-    /**
-  Override the maximum number of embeddings per call.
-     */
-    maxEmbeddingsPerCall?: number;
-    /**
-  Override the parallelism of embedding calls.
-      */
-    supportsParallelCalls?: boolean;
-}
-
-type MistralEmbeddingConfig = {
-    provider: string;
-    baseURL: string;
-    headers: () => Record<string, string | undefined>;
-};
-declare class MistralEmbeddingModel implements EmbeddingModelV1<string> {
-    readonly specificationVersion = "v1";
-    readonly modelId: MistralEmbeddingModelId;
-    private readonly config;
-    private readonly settings;
-    get provider(): string;
-    get maxEmbeddingsPerCall(): number;
-    get supportsParallelCalls(): boolean;
-    constructor(modelId: MistralEmbeddingModelId, settings: MistralEmbeddingSettings, config: MistralEmbeddingConfig);
-    doEmbed({ values, abortSignal, }: Parameters<EmbeddingModelV1<string>['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV1<string>['doEmbed']>>>;
-}
 
-interface MistralProvider {
-    (modelId: MistralChatModelId, settings?: MistralChatSettings): MistralChatLanguageModel;
+interface MistralProvider extends ProviderV3 {
+    (modelId: MistralChatModelId): LanguageModelV3;
     /**
   Creates a model for text generation.
   */
-    chat(modelId: MistralChatModelId, settings?: MistralChatSettings): MistralChatLanguageModel;
+    languageModel(modelId: MistralChatModelId): LanguageModelV3;
+    /**
+  Creates a model for text generation.
+  */
+    chat(modelId: MistralChatModelId): LanguageModelV3;
+    /**
+     * Creates a model for text embeddings.
+     */
+    embedding(modelId: MistralEmbeddingModelId): EmbeddingModelV3;
+    /**
+     * Creates a model for text embeddings.
+     */
+    embeddingModel: (modelId: MistralEmbeddingModelId) => EmbeddingModelV3;
+    /**
+     * @deprecated Use `embedding` instead.
+     */
+    textEmbedding(modelId: MistralEmbeddingModelId): EmbeddingModelV3;
     /**
-  Creates a model for text embeddings.
+     * @deprecated Use `embeddingModel` instead.
      */
-    embedding(modelId: MistralEmbeddingModelId, settings?: MistralEmbeddingSettings): MistralEmbeddingModel;
+    textEmbeddingModel(modelId: MistralEmbeddingModelId): EmbeddingModelV3;
 }
 interface MistralProviderSettings {
     /**
@@ -76,10 +49,6 @@ interface MistralProviderSettings {
      */
     baseURL?: string;
     /**
-  @deprecated Use `baseURL` instead.
-     */
-    baseUrl?: string;
-    /**
   API key that is being send using the `Authorization` header.
   It defaults to the `MISTRAL_API_KEY` environment variable.
      */
@@ -88,6 +57,11 @@ interface MistralProviderSettings {
   Custom headers to include in the requests.
        */
     headers?: Record<string, string>;
+    /**
+  Custom fetch implementation. You can use it as a middleware to intercept requests,
+  or to provide a custom fetch implementation for e.g. testing.
+      */
+    fetch?: FetchFunction;
     generateId?: () => string;
 }
 /**
@@ -99,23 +73,6 @@ Default Mistral provider instance.
  */
 declare const mistral: MistralProvider;
 
-/**
- * @deprecated Use `createMistral` instead.
- */
-declare class Mistral {
-    /**
-     * Base URL for the Mistral API calls.
-     */
-    readonly baseURL: string;
-    readonly apiKey?: string;
-    readonly headers?: Record<string, string>;
-    private readonly generateId;
-    /**
-     * Creates a new Mistral provider instance.
-     */
-    constructor(options?: MistralProviderSettings);
-    private get baseConfig();
-    chat(modelId: MistralChatModelId, settings?: MistralChatSettings): MistralChatLanguageModel;
-}
+declare const VERSION: string;
 
-export { Mistral, type MistralProvider, type MistralProviderSettings, createMistral, mistral };
+export { type MistralLanguageModelOptions, type MistralProvider, type MistralProviderSettings, VERSION, createMistral, mistral };