Jupyter AI

Jupyter AI 目前作为 JupyterLab 组织的一部分正在孵化中。

Jupyter AI 将生成式人工智能与 Jupyter 笔记本连接起来。它提供了一种用户友好且功能强大的方式，让你可以在笔记本中探索生成式 AI 模型，并提升在 JupyterLab 和 Jupyter Notebook 中的工作效率。具体来说，Jupyter AI 提供：

• 一个 %%ai 魔法命令，可将 Jupyter 笔记本变成一个可复现的生成式 AI 实验场。这适用于任何运行 IPython 内核的环境（JupyterLab、Jupyter Notebook、Google Colab、Kaggle、VSCode 等）。
• JupyterLab 中的原生聊天界面，让你可以将生成式 AI 作为对话助手来使用。
• 支持广泛的生成模型提供商，包括 AI21、Anthropic、AWS、Cohere、Gemini、Hugging Face、MistralAI、NVIDIA 和 OpenAI。
• 通过 GPT4All 和 Ollama 提供本地模型支持，让你能够在消费级机器上轻松、私密地使用生成式 AI 模型。

完整文档可在 ReadTheDocs 上查阅。

环境要求

使用 Jupyter AI 需要安装以下软件：

• Python 3.9 - 3.12
• JupyterLab 4 或 Notebook 7

此外，你还需要至少能访问一个模型提供商。

[!重要]
JupyterLab 3 已于 2024 年 5 月 15 日结束维护。因此，我们将不会向支持 JupyterLab 3 的 v1 分支回溯移植新功能。关键问题的修复仍将持续回溯移植至 2024 年 12 月 31 日。如果你仍在使用 JupyterLab 3，我们强烈建议你尽快升级到 JupyterLab 4。更多信息，请参阅 Jupyter 博客上的 JupyterLab 3 维护结束公告。

在笔记本中设置模型提供商

要在笔记本中使用任何 AI 模型提供商，你需要相应的凭证，例如 API 密钥。

请从模型提供商的平台获取必要的凭证（如 API 密钥）。

你可以在笔记本的代码单元格中设置密钥，也可以使用环境变量。在代码单元格中，你可以按如下方式设置凭证，而不会在笔记本中暴露你的密钥：

# 注意：请将 'PROVIDER_API_KEY' 替换为凭证键的名称，
# 并使用下面所示的代码在提示时输入 API 密钥。

import getpass

# 输入你的密钥
key = getpass.getpass('请输入你的 PROVIDER API 密钥：')

# 设置环境变量，不显示完整的密钥
os.environ['PROVIDER_API_KEY'] = key

:::{note}
:name: using-env-key
你也可以直接使用 %env 魔法命令设置这些密钥，但密钥值可能会在单元格输出中回显。如果你倾向于使用 %env，请确保不要与你不信任的人共享笔记本，因为这可能会泄露你的 API 密钥。

%env PROVIDER_API_KEY=YOUR_API_KEY_HERE

:::

有关每个模型提供商的更具体说明，请参阅模型提供商文档。

安装

以下是安装和使用过程的简化概述。有关安装和使用 Jupyter AI 的详细信息，请参阅我们的官方文档。

我们提供 3 种不同的方式来安装 Jupyter AI。你可以阅读每个部分，选择最适合你的安装方法。

1. 通过 pip 快速安装（推荐）
2. 通过 pip 最小化安装
3. 通过 conda 最小化安装

通过 pip 快速安装（推荐）

如果你想同时安装 %%ai 魔法命令和 JupyterLab 扩展，可以运行：

$ pip install jupyter-ai[all]

然后，重启 JupyterLab。这将安装所有可选依赖项，从而提供对 jupyter-ai 当前支持的所有模型的访问权限。

如果你不使用 JupyterLab，只想安装 Jupyter AI 的 %%ai 魔法命令，可以运行：

$ pip install jupyter-ai-magics[all]

jupyter-ai 依赖于 jupyter-ai-magics，因此安装 jupyter-ai 会自动安装 jupyter-ai-magics。

通过 pip 最小化安装

Jupyter AI 中的大多数模型提供商都需要在可用之前安装特定的依赖项，这些称为提供商依赖项。提供商依赖项对 Jupyter AI 是可选的，这意味着 Jupyter AI 可以在安装或不安装任何提供商依赖项的情况下安装。如果某个提供商所需的依赖项未安装，其模型将不会出现在允许你选择语言模型的用户界面中。

要通过 pip 执行不包含任何提供商依赖项的最小化安装，请在包名中省略 [all] 可选依赖组：

pip install jupyter-ai

通过有选择地安装提供商依赖项，你可以控制 Jupyter AI 环境中可用的模型。

例如，要安装仅支持 Anthropic 模型的 Jupyter AI，请运行：

pip install jupyter-ai langchain-anthropic

有关模型提供商及其所需依赖项的更多信息，请参阅模型提供商表格。

通过 conda 最小化安装

作为使用 pip 的替代方案，你可以使用 Conda 从 conda-forge 频道安装 jupyter-ai：

$ conda install conda-forge::jupyter-ai

Jupyter AI 中的大多数模型提供商都需要在可用之前安装特定的提供商依赖项。从 Conda Forge 安装 jupyter-ai 时不会安装这些提供商依赖项，需要时请单独安装。

例如，要安装仅支持 OpenAI 模型的 Jupyter AI，请运行：

conda install conda-forge::jupyter-ai conda-forge::langchain-openai

有关模型提供商及其所需依赖项的更多信息，请参阅模型提供商表格。

%%ai 魔法命令

%%ai 魔法命令适用于任何运行 IPython 内核的环境，包括 JupyterLab、Jupyter Notebook、Google Colab 和 Visual Studio Code。

安装 %%ai 魔法命令后，你可以在任何笔记本或 IPython shell 中通过运行以下命令启用它：

%load_ext jupyter_ai_magics

或：

%load_ext jupyter_ai

下面的截图来自本包 examples/ 目录中的笔记本。

然后，你可以使用 %%ai 魔法命令来指定模型和自然语言提示：

Jupyter AI 还可以生成 HTML 和数学公式，以作为单元格输出进行渲染。

Jupyter AI 可以插值 IPython 表达式，允许你运行包含变量值的提示。

JupyterLab 扩展

Jupyter AI 的 JupyterLab 扩展提供了一个原生 UI，允许多个用户与 Jupyter AI 对话助手聊天。如果你已安装 JupyterLab，那么在安装 jupyter_ai 包时，此扩展应该会被安装并激活。

使用

有关安装和使用 Jupyter AI 的帮助，请参阅我们在 ReadTheDocs 上的用户文档。

贡献

如果你想为 Jupyter AI 做贡献，请参阅我们在 ReadTheDocs 上的贡献者文档。