Skip to content

安装与配置#

LlamaIndex 生态系统采用命名空间化的 Python 包集合进行结构化设计。

这意味着用户通过 pip install llama-index 安装时将获得核心基础包，其他集成组件可按需额外安装。

完整包列表及可用集成组件可在 LlamaHub 查看。

通过 Pip 快速安装#

快速开始可通过以下命令安装：

pip install llama-index

此基础安装包包含以下组件： - llama-index-core - llama-index-llms-openai - llama-index-embeddings-openai - llama-index-program-openai - llama-index-question-gen-openai - llama-index-agent-openai - llama-index-readers-file - llama-index-multi-modal-llms-openai

注意： LlamaIndex 可能会下载并存储各依赖包（NLTK、HuggingFace等）的本地文件。可通过环境变量 "LLAMA_INDEX_CACHE_DIR" 指定存储路径。

重要：OpenAI 环境配置#

默认使用 OpenAI 的 gpt-3.5-turbo 模型进行文本生成，text-embedding-ada-002 模型进行检索和嵌入。使用前需设置 OPENAI_API_KEY 环境变量。 可通过登录 OpenAI 账户并创建新 API 密钥获取。

Tip

也可选用其他多种可用的大语言模型。根据所选模型提供商，可能需要配置额外的环境密钥和令牌。

查看 OpenAI 入门示例

通过 Pip 自定义安装#

若不使用 OpenAI 或需要选择性安装，可按需单独安装组件包。

例如，使用 Ollama 和 HuggingFace 嵌入的本地配置安装命令如下：

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

查看本地模型入门示例

完整的大语言模型使用配置指南参见此处。

完整的嵌入模型使用配置指南参见此处。

从源码安装#

克隆代码仓库：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