Cricbot

Приложение Cricbot

Обзор

Cricbot — это приложение-чат-бот, предназначенное для предоставления результатов в крикете в режиме реального времени и обработки различных намерений пользователей. Он использует языковые модели OpenAI для понимания запросов пользователей и генерации соответствующих ответов. Приложение структурировано таким образом, чтобы обеспечить модульность и простоту обслуживания.

Структура каталогов

 Cricbot/
├── app/
│   ├── src/
│   │    ├── constants/
│   │    │   ├── __init__.py
│   │    │   └── constants.py
│   │    ├── models/
│   │    │   ├── __init__.py
│   │    │   └── match_details.py
│   │    ├── prompts/
│   │    │   ├── all_live_matches_response_prompt.txt
│   │    │   ├── fallback_response_prompt.txt
│   │    │   ├── intent_identifier_prompt.txt
│   │    │   └── live_score_response_prompt.txt
│   │    ├── services/
│   │    │   ├── __init__.py
│   │    │   ├── intent_identifier_service.py
│   │    │   ├── intent_handler_service.py
│   │    │   ├── live_score_service.py
│   │    │   └── response_generator_service.py
│   │    ├── utils/
│   │    │   ├── __init__.py
│   │    │   └── common_util.py
│   │    ├── chains/
│   │    │   ├── __init__.py
│   │    │   └── cricbot_chain.py
│   │    ├── enums/
│   │    │   ├── __init__.py
│   │    │   └── intents.py
│   ├── main.py
│   └── cricbot_app.py
├── .env
├── .gitignore
├── README.md
└── requirements.txt

Настраивать

Предварительные условия

• Питон 3.x
• pip (установщик пакетов Python)

Установка

1. Клонировать репозиторий

   git clone https://github.com/mohitbansal964/Cricbot.git
   cd Cricbot

2. Создайте виртуальную среду

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

3. Установить зависимости

   pip install -r requirements.txt

4. Настройка переменных среды

   Создайте файл .env в корневом каталоге и добавьте свой ключ API OpenAI:

    OPENAI_API_KEY=your_openai_api_key_here
   

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

Запустите приложение с помощью следующей команды:

python app/main.py

Взаимодействуйте с ботом, вводя свои запросы. Введите «exit», чтобы завершить сеанс.

Компоненты

• Константы : хранит постоянные значения, используемые в приложении.
• Models : Содержит модели данных, такие как MatchDetails .
• Подсказки : хранит шаблоны подсказок для генерации ответов.
• Службы : содержит основную логику для идентификации намерений, получения текущих результатов и генерации ответов.
• Утилиты : предоставляет служебные функции для выполнения общих задач.
• Цепочки : управляет последовательностью операций с использованием Langchain для генерации ответов.
• Перечисления : определяет перечисления, используемые в приложении.

Недавние обновления

• Интеграция Streamlit : приложение теперь включает интерфейс Streamlit для более интерактивного взаимодействия с пользователем.
• Улучшенная обработка ошибок : улучшенные механизмы обработки ошибок для повышения надежности.
• Модульная кодовая база : рефакторинг кода для повышения читаемости и удобства обслуживания.
• Интеграция Langchain : использование Langchain для оптимизации последовательности операций и улучшения генерации ответов.
• Потоковая передача включена : добавлены возможности потоковой передачи для взаимодействия в реальном времени.
• Устаревшая служба Cricbot : заменена более модульным подходом с использованием langchains.

Будущие улучшения

• Ведение журнала : добавьте ведение журнала для лучшего мониторинга и отладки.
• Тестирование : реализация модульных и интеграционных тестов для обеспечения надежности.
• Расширенный пользовательский интерфейс : разработайте графический интерфейс для более интерактивного взаимодействия с пользователем.

Содействие

Вклады приветствуются! Пожалуйста, создайте репозиторий и отправьте запрос на внесение изменений или исправлений ошибок.

Лицензия

Этот проект лицензируется по лицензии MIT.

---

Этот README предоставляет полный обзор приложения Cricbot, включая инструкции по настройке, использованию и будущим улучшениям. Не стесняйтесь изменять содержимое, чтобы оно лучше соответствовало потребностям вашего проекта.