@ai-sdk/mistral 0.0.0-85f9a635-20240518005312

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,73 @@
+# Vercel 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.
+
+## Setup
+
+The Mistral provider is available in the `@ai-sdk/mistral` module. You can install it with
+
+```bash
+npm i @ai-sdk/mistral
+```
+
+## 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 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:
+
+```ts
+const model = mistral('mistral-large-latest', {
+  safePrompt: true, // optional safety prompt injection
+});
+```
+
+The following optional settings are available for Mistral models:
+
+- **safePrompt** _boolean_
+
+  Whether to inject a safety prompt before all conversations.
+
+  Defaults to `false`.

package/dist/index.d.mts

@@ -0,0 +1,121 @@
+import { LanguageModelV1, EmbeddingModelV1 } from '@ai-sdk/provider';
+
+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 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;
+    /**
+  Creates a model for text generation.
+  */
+    chat(modelId: MistralChatModelId, settings?: MistralChatSettings): MistralChatLanguageModel;
+    /**
+  Creates a model for text embeddings.
+     */
+    embedding(modelId: MistralEmbeddingModelId, settings?: MistralEmbeddingSettings): MistralEmbeddingModel;
+}
+interface MistralProviderSettings {
+    /**
+  Use a different URL prefix for API calls, e.g. to use proxy servers.
+  The default prefix is `https://api.mistral.ai/v1`.
+     */
+    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.
+     */
+    apiKey?: string;
+    /**
+  Custom headers to include in the requests.
+       */
+    headers?: Record<string, string>;
+    generateId?: () => string;
+}
+/**
+Create a Mistral AI provider instance.
+ */
+declare function createMistral(options?: MistralProviderSettings): MistralProvider;
+/**
+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;
+}
+
+export { Mistral, type MistralProvider, type MistralProviderSettings, createMistral, mistral };

package/dist/index.d.ts

@@ -0,0 +1,121 @@
+import { LanguageModelV1, EmbeddingModelV1 } from '@ai-sdk/provider';
+
+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 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;
+    /**
+  Creates a model for text generation.
+  */
+    chat(modelId: MistralChatModelId, settings?: MistralChatSettings): MistralChatLanguageModel;
+    /**
+  Creates a model for text embeddings.
+     */
+    embedding(modelId: MistralEmbeddingModelId, settings?: MistralEmbeddingSettings): MistralEmbeddingModel;
+}
+interface MistralProviderSettings {
+    /**
+  Use a different URL prefix for API calls, e.g. to use proxy servers.
+  The default prefix is `https://api.mistral.ai/v1`.
+     */
+    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.
+     */
+    apiKey?: string;
+    /**
+  Custom headers to include in the requests.
+       */
+    headers?: Record<string, string>;
+    generateId?: () => string;
+}
+/**
+Create a Mistral AI provider instance.
+ */
+declare function createMistral(options?: MistralProviderSettings): MistralProvider;
+/**
+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;
+}
+
+export { Mistral, type MistralProvider, type MistralProviderSettings, createMistral, mistral };