Mistral Cookbook

Mistral Cookbook 收录了来自 Mistral 团队、社区以及合作伙伴的示例。如果您有展示 Mistral 模型强大功能的精彩示例，欢迎通过向本仓库提交 PR 的方式分享。

提交指南：

• 文件格式：请以 .md 或 .ipynb 格式提交您的示例。
• 可在 Colab 上运行：如果您分享的是 Notebook 示例，请尽量确保其可以在 Google Colab 上运行。
• 作者信息：请在文件开头注明您的姓名、GitHub 用户名及所属机构。
• 描述：请将您的 Notebook 连同其所属类别和描述一并填写到下表中。
• 文风：请保持中立客观的语气，避免过多营销性质的内容。
• 可复现性：为确保他人能够复现您的工作，请在代码中明确标注所用包的版本。
• 图片大小：如包含图片，请确保每张图片的大小不超过 500KB。
• 版权：请始终尊重版权和知识产权相关法律法规。

免责声明：由社区及合作伙伴贡献的示例并不代表 Mistral 的观点和立场。

内容指南：

• 原创性：您的内容是否具有原创性，并提供了全新的视角？
• 清晰度：内容结构是否清晰，表述是否明确？
• 价值：您的内容对社区是否有实际价值？社区是否需要此类内容？

主要 Notebook 列表

Notebook	类别	描述
quickstart.ipynb	对话、嵌入	使用 Mistral AI API 的基础对话与嵌入快速入门
prompting_capabilities.ipynb	提示工程	编写用于分类、摘要、个性化及评估的提示
basic_RAG.ipynb	RAG	使用 Mistral AI API 从零构建 RAG
embeddings.ipynb	嵌入	使用 Mistral 嵌入 API 进行分类与聚类
function_calling.ipynb	函数调用	使用 Mistral API 进行函数调用
text_to_SQL.ipynb	函数调用	使用 Mistral API 处理多表文本转 SQL 的用例
evaluation.ipynb	评估	使用 Mistral API 评估模型
mistral_finetune_api.ipynb	微调	使用 Mistral 微调 API 对模型进行微调
mistral-search-engine.ipynb	RAG、函数调用	使用 Mistral API、函数调用及 RAG 构建搜索引擎
rag_via_function_calling.ipynb	RAG、函数调用	使用函数调用作为路由，基于多个数据源构建 RAG
prefix_use_cases.ipynb	前缀、提示工程	使用 Mistral 前缀功能的精彩示例
synthetic_data_gen_and_finetune.ipynb	数据生成、微调	简单的数据生成与微调指南
data_generation_refining_news.ipynb	数据生成	通过简单数据生成来优化新闻文章
image_description_extraction_pixtral.ipynb	图像处理、提示工程	使用 Mistral 的 Pixtral 模型提取结构化图像描述，并以 JSON 格式输出
multimodality_meets_function_calling.ipynb	图像处理、函数调用	使用 Mistral 的 Pixtral 模型从图像中提取表格，并用于函数调用
mistral-reference-rag.ipynb	RAG、函数调用、引用	使用 Mistral API 构建引用型 RAG
moderation-explored.ipynb	内容审核	快速探索安全防护机制及 Mistral 的内容审核 API
system-level-guardrails.ipynb	内容审核	如何使用 Mistral API 实现系统级安全防护
document_understanding.ipynb	OCR、函数调用	使用 OCR 进行文档理解与工具应用
batch_ocr.ipynb	OCR、批量处理	使用 OCR 从数据集中提取文本信息
structured_ocr.ipynb	OCR、结构化输出	从文档中提取结构化输出
RAG_evaluation.ipynb	评估、结构化输出、LLM 作为裁判	使用 LLM 作为裁判评估 RAG，并输出结构化结果
product_classification.ipynb	微调、分类器	针对食品分类任务对分类器进行微调
intent_classification.ipynb	微调、分类器	针对意图分类任务对分类器进行微调
moderation_classifier.ipynb	微调、分类器	针对内容审核任务对分类器进行微调
pixtral_finetune_on_satellite_data.ipynb	微调、图像处理、批量处理	对 Pixtral-12B 模型进行卫星图像分类的微调
sts_demo.py	对话、TTS	STT -> LLM -> TTS 演示

第三方工具

工具	类别	提供方
adaptive_rag_mistral.ipynb	RAG	Langchain
Adaptive_RAG.ipynb	RAG	LLamaIndex
Agents_Tools.ipynb	代理	LLamaIndex
arize_phoenix_tracing.ipynb	跟踪数据	Arize Phoenix
arize_phoenix_evaluate_rag.ipynb	评估	Arize Phoenix
azure_ai_search_rag.ipynb	RAG, 嵌入	Azure
CAMEL 图谱 RAG with Mistral 模型	多智能体、工具、数据生成	CAMEL-AI.org
CAMEL 角色扮演爬虫	多智能体、工具、数据生成	CAMEL-AI.org
Chainlit - Mistral 推理.ipynb	UI 聊天、工具调用	Chainlit
chroma_mistral_embed_fn.ipynb	嵌入、向量数据库	Chroma
corrective_rag_mistral.ipynb	RAG	Langchain
distilabel 合成 DPO 数据集.ipynb	合成数据	Argilla
E2B 代码解释器 SDK with Codestral	工具、代理	E2B
function_calling_local.ipynb	工具调用	Ollama
Gradio 集成 - PDF 聊天	UI 聊天、演示、RAG	Gradio
haystack_chat_with_docs.ipynb	RAG、嵌入	Haystack
Indexify 集成 - PDF 实体抽取	实体抽取、PDF	Indexify
Indexify 集成 - PDF 总结	总结、PDF	Indexify
langgraph_code_assistant_mistral.ipynb	代码	Langchain
langgraph_crag_mistral.ipynb	RAG	Langchain
langtrace_mistral.ipynb	OTEL 可观测性	Langtrace
llamaindex_agentic_rag.ipynb	RAG、代理	LLamaIndex
llamaindex_arxiv_agentic_rag.ipynb	RAG、代理、Arxiv 摘要	LLamaIndex
llamaindex_mistralai_finetuning.ipynb	微调	LLamaIndex
llamaindex_mistral_multi_modal.ipynb	多模态 LLM - Pixtral	LLamaIndex
Maxim AI - 可观测性	可观测性、评估	Maxim AI
Microsoft Autogen - 调用 pgsql 数据库函数	工具调用、代理、RAG	Ms Autogen
Mesop 集成 - PDF 聊天	UI 聊天、演示、RAG	Mesop
使用 OpenTelemetry 监控 Mistral AI	AI 可观测性	OpenLIT
neon_text_to_sql.ipynb	代码	Neon
ollama_mistral_llamaindex.ipynb	RAG	LLamaIndex
Ollama 聚会演示	演示	Ollama
开源 LLM 工程	LLM 可观测性	Langfuse
Panel 集成 - PDF 聊天	UI 聊天、演示、RAG	Panel
phospho 集成	评估、分析	phospho
pinecone_rag.ipynb	RAG	Pinecone
RAG.ipynb	RAG	LLamaIndex
RouterQueryEngine.ipynb	代理	LLamaIndex
self_rag_mistral.ipynb	RAG	Langchain
Solara 集成 - PDF 聊天	UI 聊天、演示、RAG	Solara
Streamlit 集成 - PDF 聊天	UI 聊天、演示、RAG	Streamlit
Neo4j RAG	RAG	Neo4j
SubQuestionQueryEngine.ipynb	代理	LLamaIndex
LLM 判官：检测语言模型中的幻觉	微调、评估	Weights & Biases
x mistral: X-CMD 中的 CLI & TUI APP 模块	CLI、TUI APP、聊天	x-cmd
增量式提示工程与模型比较	提示工程、评估	Pixeltable
使用 Pydantic AI 和 Mistral AI 构建银行客服代理	代理	Pydantic
Mistral 与 MLflow 跟踪	跟踪、可观测性	MLflow
Mistral OCR with Gradio	OCR	Gradio
prompt_optimization.ipynb)	提示工程	在无监督的情况下优化提示

Mistral Cookbook 快速上手指南

Mistral Cookbook 是由 Mistral 官方及社区贡献的代码示例集合，涵盖了从基础聊天、嵌入（Embeddings）、检索增强生成（RAG）到微调（Fine-tuning）和多模态处理等多种应用场景。本指南将帮助你快速搭建环境并运行示例。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统: Linux, macOS 或 Windows (推荐 WSL2)。
• Python 版本: Python 3.9 或更高版本。
• 账户与密钥: 需要注册 Mistral AI 账号并获取 API Key。
• 运行环境: 大部分示例为 Jupyter Notebook (.ipynb) 格式，推荐使用 Google Colab 直接运行，或在本地安装 Jupyter Lab/Notebook。
• 网络环境: 由于需连接 Mistral API，请确保网络通畅。

安装步骤

1. 克隆仓库

首先，将 Cookbook 仓库克隆到本地：

git clone https://github.com/mistralai/cookbook.git
cd cookbook

2. 创建虚拟环境

建议创建一个独立的虚拟环境以避免依赖冲突：

python -m venv mistral-env
source mistral-env/bin/activate  # Windows 用户请使用: mistral-env\Scripts\activate

3. 安装核心依赖

安装 Mistral AI 官方客户端库及常用数据科学包。大多数 Notebook 示例需要以下基础包：

pip install mistralai jupyter pandas numpy matplotlib

提示: 如果你计划运行特定的第三方集成示例（如 LangChain, LlamaIndex），请进入对应的 third_party/ 目录查看该示例文件夹内的 requirements.txt 进行额外安装。例如：

cd third_party/langchain
pip install -r requirements.txt

4. 配置 API Key

在运行任何代码前，需设置环境变量。

Linux/macOS:

export MISTRAL_API_KEY="your_api_key_here"

Windows (PowerShell):

$env:MISTRAL_API_KEY="your_api_key_here"

或者在 Jupyter Notebook 单元格中直接设置：

import os
os.environ["MISTRAL_API_KEY"] = "your_api_key_here"

基本使用

以下是一个最简单的示例，演示如何调用 Mistral API 进行对话。你可以参考仓库中的 quickstart.ipynb 文件。

1. 启动 Jupyter

在项目根目录下启动 Jupyter：

jupyter notebook

2. 创建测试脚本

新建一个 Notebook 或 Python 文件，输入以下代码：

from mistralai import Mistral

# 初始化客户端
api_key = os.environ.get("MISTRAL_API_KEY")
client = Mistral(api_key=api_key)

# 定义对话内容
messages = [
    {
        "role": "user",
        "content": "请简要介绍 Mistral AI 的特点。"
    }
]

# 调用模型
chat_response = client.chat.complete(
    model="mistral-large-latest",
    messages=messages,
)

# 输出结果
print(chat_response.choices[0].message.content)

3. 探索更多示例

根据需求浏览 mistral/ 目录下的分类示例：

• RAG 应用: 运行 mistral/rag/basic_RAG.ipynb 学习如何构建知识库问答。
• 函数调用: 运行 mistral/function_calling/function_calling.ipynb 体验模型调用外部工具的能力。
• 微调: 运行 mistral/fine_tune/mistral_finetune_api.ipynb 了解如何定制模型。
• 多模态: 运行 mistral/image_understanding/ 下的示例处理图像任务。

对于第三方工具集成（如 LangChain, LlamaIndex），请直接进入 third_party/ 对应文件夹运行相关 Notebook。