ai markdown llm retrieval

Query Query на основе тряпки

Этот проект реализует систему запросов документов с AI с использованием моделей Langchain, Chromadb и Openai. Это позволяет пользователям создавать базу данных, доступную для поиска из документов Markdown, и запросить ее с использованием естественного языка.

Функции

• Создание векторной базы данных из документов Markdown
• Оценка затрат на встраивание и запрос
• Поиск сходства в базе данных
• Генерация ответов с AI для запросов пользователей

Архитектурная диаграмма

Требования

• Python 3.7+
• Зависимости, перечисленные в requirements.txt

Установка

1. Клонировать это хранилище
2. Создайте виртуальную среду:

    python -m venv .venv
   source .venv/bin/activate  # On Windows, use `.venvScriptsactivate`
   

3. Установите необходимые пакеты:

    pip install -r requirements.txt
   

4. Установите свой ключ API OpenAI в файле .env :

    OPENAI_API_KEY=your_api_key_here
   

Начиная

Следуйте этим шагам, чтобы быстро настроить и использовать двигатель запроса VectordB-LLM на основе RAG:

1. Создайте базу данных из ваших документов Markdown:

    python create_database.py --data_folder data/go-docs --chroma_db_path chroma_go_docs/
   

   Эта команда будет обрабатывать файлы разметки в каталоге Data/ Go-Docs и создаст векторную базу данных в папке CROMA_GO_DOCS/.

2. Запросите базу данных с помощью вопроса о естественном языке:

    python query_data.py --query_text "Explain goroutines in go in a sentence" --chroma_db_path chroma_go_docs/ --prompt_model gpt-3.5-turbo
   

3. Посмотреть сгенерированный AI ответ:

    Goroutines are lightweight, concurrent functions or methods in Go that run independently, managed by the Go runtime, allowing for efficient parallel execution and easy implementation of concurrent programming patterns.
   

Использование

Для получения более подробных инструкций по использованию см. В следующих разделах:

1. Создайте базу данных

    python create_database.py --data_folder path/to/your/markdown/files --chroma_db_path path/to/save/database
   

2. Запросите базу данных

    python query_data.py --query_text "Your question here" --chroma_db_path path/to/database --prompt_model gpt-3.5-turbo
   

Структура файла

• create_database.py : сценарий создания базы данных
• query_data.py : сценарий запроса базы данных
• estimate_cost.py : модуль оценки затрат
• get_token_count.py : утилита счета токена
• data/ : каталог документов Markdown
• chroma/ : хранение базы данных ChromADB (GITIGNORED)

Примечания

• Использует text-embedding-3-small Openai для встроений и gpt-3.5-turbo для ответов по умолчанию
• Поместите файлы разметки в data/ или укажите пользовательский путь
• База данных ChromADB, хранящаяся в chroma/ (GitIgnored)

Поиск неисправностей

• Обеспечить совместимую версию Python и правильную установку пакета
• Проверьте ключ OpenAI API и учетные кредиты на ошибки API

Лицензия

Этот проект лицензирован в соответствии с условиями лицензии MIT. Для получения дополнительной информации, пожалуйста, обратитесь к файлу лицензии.

Построен с

• Лангхейн
• Chromadb
• Openai
• Тиктокен

По вопросам или вопросам, пожалуйста, откройте проблему в репозитории GitHub.