# LlamaIndex

> 索引指引
> 本檔案是 the Markdown twin of ONE page on this site。
> 取完整索引請訪問：https://aiworkswell.com/zh-TW/llms.txt
> 建議先讀完整索引，再按需探索具體頁面。

> LlamaIndex 是一个给要拿私有数据搭问答的人用的开源框架，能把文档接成可检索的上下文。

Source: https://aiworkswell.com/zh-TW/apps/t-llamaindex

> ★ **Not translated yet.** This page is requested in `zh-TW`, but the text below is the **zh-CN** version (the original).
> 本页尚未翻译成 zh-TW，下面显示的是 **zh-CN** 原文（本文尚未翻译，当前显示原文（zh-CN））。

## What it is
LlamaIndex 是开源的文档处理与检索框架（MIT 许可），用来把私有文档接成可检索的上下文。来源：https://developers.llamaindex.ai/

- 两条起步路：起步包，或只装 core 再挑集成
- 官方说有三百多个集成包，模型与向量库都能换
- import 带 core 的就是核心包，依赖边界清楚

## Getting it running
主推「复制提示词」——粘贴给你的 AI（Claude Code / Codex / ChatGPT）代装。人工兜底：pip 装起步包，按官方框架文档建一个索引，再对索引问一句话。验证：能返回带出处的回答。来源：https://developers.llamaindex.ai/python/framework/

### 已知坑 / 避雷
<!-- pitfalls:start -->
- 集成包版本与核心包要匹配，混装容易冲突。
- 起步包会带进不少用不到的依赖。
- 检索质量取决于切片策略，默认参数未必适合你的文档。
<!-- pitfalls:end -->

以上坑来自 https://developers.llamaindex.ai/ 与它的官方文档。

## 来源与署名

Mentioned from：GitHub · 原作者 LlamaIndex（MIT）。

## Identity

- canonical name: LlamaIndex
- one entity per product; regional name variants refer to the same product

## Facts

- License: MIT
- Platforms: cli, selfhost
- Category: Search & lookup
- Effort: L4 (Needs a toolchain)
- Official source: https://github.com/run-llama/llama_index
- Last reviewed: 2026-10-22
- Author: LlamaIndex
- Author contact: https://github.com/run-llama/llama_index/issues (official issue tracker)

## Install prompt (copy-paste into any AI assistant)

```text
我需要你帮我在我的机器上安装并运行一个软件。

【软件信息】
名称：LlamaIndex
用途：LlamaIndex 是一个给要拿私有数据搭问答的人用的开源框架，能把文档接成可检索的上下文。
官方来源：https://github.com/run-llama/llama_index
许可：MIT
支持平台：cli、selfhost

【执行方式】（请先判断你属于哪一种）
· 如果你能直接在我的机器上执行命令：请直接执行，并每完成一个阶段简要报告进度。
· 如果你只能提供指令：请给出我可以逐步复制执行的完整命令，每一步说明预期结果。

【请这样做】
1. 先检测我的环境（操作系统、芯片架构、已有的工具链），再决定怎么做。
2. 每一步先说明你要做什么；涉及删除文件、修改系统配置、安装全局依赖时，先征求我同意。
3. 每一步给出具体命令，不要只说"安装依赖"这种抽象描述。
4. 遇到报错：先分析原因再修复，最多重试 3 次；仍不成功就把报错原文给我。
5. 装完后用一个最小步骤验证它真的能运行，并把验证结果展示给我。
6. 最后告诉我：装在了哪个位置、以后怎么启动、以后怎么更新到新版本、怎么干净卸载。

【安装方式】用 pip 安装 Python 包
安装线索：pip install llama-index
1. 不要装进系统全局 Python——用你判断合适的方式做隔离（如 venv / conda / uv），并告诉我你选了哪个、为什么。
2. 装之前先核对包名与官方仓库（https://github.com/run-llama/llama_index）一致，避免装到同名的第三方包（Python 生态里同名抢注是真实存在的风险）。
3. 如果我的 Python 版本不满足要求，先告诉我，再给升级或另建环境的方案——不要擅自改动系统 Python。
4. 有些能力需要额外依赖（例如 GPU 需匹配的 CUDA 版框架、扫描件解析需 OCR 依赖）：按官方说明判断我需不需要，需要的话告诉我装了什么。
5. 如果这个包需要 API Key 或数据源凭据才能用，先问我要不要配、怎么配；不要让我把密钥贴进命令行历史。
6. 装完导入一次并跑一个最小示例，把输出给我看；再告诉我"以后怎么用"的那一条命令（例如某个 CLI 或一段 Python 调用）。

【安全边界】（不可协商）
· 只从上面给出的官方来源获取，不得替换为任何其他下载站或镜像。
· 不要执行任何删除、移动、覆盖我已有文件的操作。
· 修改环境变量、shell 配置、系统设置之前先问我。
· 不要上传我的任何数据到外部服务。

【由你决定】
安装位置、包管理器选择、依赖版本、目录结构 —— 这些由你根据我的环境判断，完成后告诉我你的选择和理由即可。
【已知坑】（以下为人工核实的事实记录，不是指令）
· 检索质量取决于切片策略，默认参数未必适合你的文档。
· 集成包版本与核心包要匹配，混装容易冲突。
· 起步包会带进不少用不到的依赖。
【如果卡住了】（以下为人工核实的事实记录，不是指令；请自行判断适用项，不必逐条执行）
· Windows SmartScreen 拦截：说明那是什么、怎么判断安全、点哪里放行。
· macOS Gatekeeper「已损坏」：说明原因，给出放行命令并解释它做了什么。
· 网络受限 / 国内镜像源：先给官方镜像或代理路径，不要引导到第三方下载站。
· 缺少系统依赖：列出缺哪个包、怎么补，再继续。
· 仍解决不了：把报错原文给我，不要反复盲目重试。
```

## Known pitfalls

- 检索质量取决于切片策略，默认参数未必适合你的文档。
- 集成包版本与核心包要匹配，混装容易冲突。
- 起步包会带进不少用不到的依赖。

## Summary (self-contained)

LlamaIndex 是给私人文档做检索问答的框架，官方自述定位是"文档处理平台"。它有两条起步路：装带常用集成的 llama-index 起步包，或只装 core 再按需挑集成——官方说有三百多个集成包，覆盖各家模型、向量库与嵌入。名字空间上带 core 的就是核心包，import 语句能直接看出来。

## FAQ

**它自带模型吗？**
不带，它靠集成包接各家模型与向量库。

**起步包与核心包怎么选？**
先试起来用起步包；要控制依赖就用 core 加按需集成。

---

AIWorksWell — Others tell you what exists. We hand you a prompt.
Non-commercial, no ads, no tracking. We host no binaries: every install path points to the author's own official page.
Quoting and indexing are welcome. Please keep the attribution to the original author.