Jupyter AI 项目全面使用指南：从安装到模型应用

Jupyter AI 项目全面使用指南：从安装到模型应用

jupyter-ai A generative AI extension for JupyterLab 项目地址: https://gitcode.com/gh_mirrors/ju/jupyter-ai

项目概述

Jupyter AI 是一个将人工智能能力深度集成到 Jupyter 环境的扩展项目，它为用户提供了两大核心功能：交互式聊天界面和 AI 魔术命令（magics）。该项目基于 Python 生态构建，支持多种主流 AI 模型提供商，让数据科学家和开发者能够在熟悉的 Jupyter 环境中直接调用强大的 AI 能力。

环境准备

系统要求

Jupyter AI 支持 Windows、macOS 和 Linux 系统，Python 版本要求为 3.9 至 3.12。对于仍在使用 Python 3.8 的用户，可以选择安装 Jupyter AI v2.29.1 或更低版本。

环境配置建议

强烈建议使用 Conda 创建独立环境以避免依赖冲突：

conda create -n jupyter-ai python=3.12 jupyterlab
conda activate jupyter-ai

安装指南

推荐安装方式（完整功能）

使用 pip 安装完整版（包含所有模型支持）：

pip install 'jupyter-ai[all]'

最小化安装

如果只需要基础功能，可以仅安装核心包：

pip install jupyter-ai

然后根据需要单独安装模型提供商的依赖包，例如仅安装 Anthropic 模型支持：

pip install langchain-anthropic

Conda 安装方式

通过 conda-forge 渠道安装：

conda install conda-forge::jupyter-ai

模型提供商支持

Jupyter AI 支持众多主流 AI 模型提供商，每种模型都需要特定的 API 密钥和 Python 包：

| 提供商 | 所需环境变量 | Python 包 | |--------------|--------------------|------------------------| | OpenAI | OPENAI_API_KEY | langchain-openai | | Anthropic | ANTHROPIC_API_KEY | langchain-anthropic | | Google Gemini| GOOGLE_API_KEY | langchain-google-genai | | Hugging Face | HUGGINGFACEHUB_API_TOKEN | huggingface_hub |

费用提示：使用第三方模型可能会产生费用，请在使用前了解各提供商的定价政策。

核心功能详解

1. 聊天界面使用

启动 JupyterLab 后，点击左侧边栏的聊天图标即可打开交互界面。首次使用时需要：

1. 选择语言模型和嵌入模型
2. 输入对应模型的 API 密钥
3. 开始对话交流

聊天界面支持上下文记忆功能，能够理解连续的对话内容。

自定义聊天界面

通过创建配置文件可以自定义聊天帮助信息：

# config.py
c.AiExtension.help_message_template = """
欢迎使用AI助手！可用命令列表：

{slash_commands_list}
"""

然后使用指定配置启动：

jupyter lab --config=config.py

2. AI 魔术命令

在 Notebook 单元格中使用 %%ai 命令可以直接调用 AI 模型：

%%ai anthropic
请用Python写一个快速排序算法

特殊模型使用说明

Amazon Bedrock 模型

使用 Bedrock 模型需要配置 AWS 认证：

1. 安装必要依赖：langchain-aws
2. 配置 AWS 凭证（通过 boto3）
3. 在 AWS 控制台启用 Bedrock 服务访问

OpenRouter 集成

通过 OpenRouter 可以访问多种兼容 OpenAI API 的模型：

1. 获取 OpenRouter API 密钥
2. 在设置中选择 OpenAI 提供商
3. 使用 OpenRouter 提供的端点地址

最佳实践建议

1. 环境隔离：始终为 Jupyter AI 创建独立环境
2. 密钥管理：不要将 API 密钥提交到版本控制系统
3. 成本控制：监控 API 使用量，设置预算提醒
4. 数据隐私：敏感数据避免通过第三方模型处理
5. 版本兼容：注意 JupyterLab 3 已停止维护，建议升级到 JupyterLab 4

常见问题解决

1. 安装报错：确保使用引号包裹 jupyter-ai[all]
2. 模型不可见：检查是否安装了对应提供商的 Python 包
3. 认证失败：验证 API 密钥和环境变量设置
4. 上下文丢失：聊天仅保留最近两次交换记录

通过本指南，您应该已经掌握了 Jupyter AI 的核心功能和使用方法。这个强大的工具能够显著提升您在 Jupyter 环境中的工作效率，让 AI 能力触手可及。

jupyter-ai A generative AI extension for JupyterLab 项目地址: https://gitcode.com/gh_mirrors/ju/jupyter-ai