LlamaIndex-course 项目启动与配置教程

1. 项目目录结构及介绍

LlamaIndex-course 项目的目录结构如下：

LlamaIndex-course/
├── .gitignore
├── README.md
├── requirements.txt
├── data/
│   └── sample_data.json
├── llm_index/
│   ├── __init__.py
│   ├── index.py
│   ├── query_engine.py
│   └── vector_store.py
├── tests/
│   ├── __init__.py
│   ├── test_index.py
│   └── test_query_engine.py
└── run.py

• .gitignore：指定 Git 忽略的文件和目录。
• README.md：项目的说明文档。
• requirements.txt：项目依赖的 Python 包列表。
• data/：存放项目所需的数据文件，例如样本数据等。
  • sample_data.json：示例数据文件。
• llm_index/：项目的核心代码目录。
  • __init__.py：初始化模块。
  • index.py：索引构建模块。
  • query_engine.py：查询引擎模块。
  • vector_store.py：向量存储模块。
• tests/：单元测试目录。
  • __init__.py：初始化测试模块。
  • test_index.py：索引构建模块的测试用例。
  • test_query_engine.py：查询引擎模块的测试用例。
• run.py：项目启动文件。

2. 项目启动文件介绍

项目的启动文件是 run.py，其主要作用是初始化并运行项目。以下是 run.py 的基本内容：

from llm_index.index import Index
from llm_index.query_engine import QueryEngine
from llm_index.vector_store import VectorStore

def main():
    # 初始化向量存储
    vector_store = VectorStore("data/sample_data.json")
    
    # 初始化索引
    index = Index(vector_store)
    
    # 初始化查询引擎
    query_engine = QueryEngine(index)
    
    # 进行查询
    while True:
        query = input("请输入查询内容（输入'exit'退出）: ")
        if query.lower() == 'exit':
            break
        print("查询结果：", query_engine.query(query))

if __name__ == "__main__":
    main()

3. 项目的配置文件介绍

本项目的主要配置文件是 requirements.txt，它列出了项目运行所需的 Python 包。以下是一个示例的 requirements.txt 文件内容：

numpy
pandas
scikit-learn

确保在开始项目之前，已经安装了这些依赖包。可以使用以下命令安装：

pip install -r requirements.txt

以上即为 LlamaIndex-course 项目的启动与配置教程。按照以上步骤操作，即可成功启动并运行项目。