LlamaIndex 生态由一组带命名空间的 Python 包构成。

对用户来说，这意味着 pip install llama-index 会带来一个包含若干核心包的基础组合，额外的集成可以按需再安装。

完整的包清单与可用集成列在集成页面上。

快速上手安装（从 Pip）

想快速开始，可以直接这样安装：

终端窗口

pip install llama-index

这是一个基础包组合，其中包含：

• llama-index-core
• llama-index-llms-openai
• llama-index-embeddings-openai
• llama-index-readers-file

注意：llama-index-core 已经预置了 NLTK 与 tiktoken 文件，以避免运行时的下载和网络请求。

重要：OpenAI 环境配置

默认情况下，文本生成使用 OpenAI 的 gpt-3.5-turbo 模型，检索与嵌入使用 text-embedding-ada-002（新项目我们建议显式传入 model="text-embedding-3-small"）。要使用它们，你必须把 OPENAI_API_KEY 设置为环境变量。你可以登录 OpenAI 账户并创建一个新的 API key 来获取。

提示

你也可以使用众多其他可用的 LLM。根据 LLM 服务商的不同，你可能还需要额外配置一些环境变量与密钥。

去看看我们的 OpenAI 起步示例

自定义安装（从 Pip）

如果你不用 OpenAI，或者想要更精简的安装，可以按需单独安装各个包。

例如，如果使用 Ollama 加 HuggingFace 嵌入的本地方案，安装命令大致是这样：

终端窗口

pip install llama-index-core llama-index-readers-file llama-index-llms-ollama llama-index-embeddings-huggingface

去看看使用本地模型的起步示例

关于使用和配置 LLM 的完整指南在这里。

关于使用和配置嵌入模型的完整指南在这里。

从源码安装

克隆本仓库：git clone https://github.com/run-llama/llama_index.git。然后执行以下步骤：

• 安装 poetry —— 它帮你管理包依赖

• 如果你需要在 Poetry 中运行 shell 命令，但 shell 插件尚未安装，可以运行以下命令添加插件：

  poetry self add poetry-plugin-shell

• poetry shell —— 该命令会创建一个虚拟环境，把安装的包限定在本项目内

• pip install -e llama-index-core —— 安装核心包

• （可选）poetry install --with dev,docs —— 安装多数本地开发所需的依赖

之后，你可以按需通过 pip 安装各种集成。例如：

终端窗口

pip install -e llama-index-integrations/readers/llama-index-readers-file
pip install -e llama-index-integrations/llms/llama-index-llms-ollama