packages/ai-mistral
| Name | Last commit message | Last commit date |
|---|---|---|
| .. | ||
README.md
@tanstack/ai-mistral#
Mistral adapter for TanStack AI.
Installation#
npm install @tanstack/ai-mistral
# or
pnpm add @tanstack/ai-mistral
# or
yarn add @tanstack/ai-mistral
Setup#
Get your API key from Mistral Console and set it as an environment variable:
export MISTRAL_API_KEY="..."
Usage#
Text/Chat Adapter#
import { mistralText } from '@tanstack/ai-mistral'
import { generate } from '@tanstack/ai'
const adapter = mistralText('mistral-large-latest')
const result = await generate({
adapter,
model: 'mistral-large-latest',
messages: [
{ role: 'user', content: 'Explain quantum computing in simple terms' },
],
})
console.log(result.text)
With Explicit API Key#
import { createMistralText } from '@tanstack/ai-mistral'
const adapter = createMistralText(
'mistral-large-latest',
process.env.MISTRAL_API_KEY!,
)
Supported Models#
Chat Models#
mistral-large-latest- Frontier flagship model (128k context)mistral-medium-latest- Balanced multimodal model (vision)mistral-small-latest- Fast, affordable multimodal model (vision)ministral-8b-latest- 8B edge modelministral-3b-latest- 3B edge modelcodestral-latest- Code-specialized model (256k context)pixtral-large-latest- Large vision modelpixtral-12b-2409- 12B vision modelmagistral-medium-latest- Reasoning modelmagistral-small-latest- Small reasoning modelopen-mistral-nemo- Open 12B model
See Mistral model comparison for full details.
Features#
- ✅ Streaming chat completions
- ✅ Structured output (JSON Schema)
- ✅ Function/tool calling
- ✅ Reasoning (magistral-_ models — streamed as
REASONING\__events) - ✅ Multimodal input (text + images) — requires a vision-capable model (
pixtral-large-latest,pixtral-12b-2409,mistral-medium-latest, ormistral-small-latest) - ❌ Embeddings (use @mistralai/mistralai directly)
- ❌ Image generation
Tree-Shakeable Adapters#
This package uses tree-shakeable adapters, so you only import what you need:
import { mistralText } from '@tanstack/ai-mistral'
License#
MIT