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

设置

先决条件

• Python 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文件并添加您的 OpenAI API 密钥：

    OPENAI_API_KEY=your_openai_api_key_here
   

用法

使用以下命令运行应用程序：

python app/main.py

通过输入您的查询与机器人进行交互。键入“exit”以终止会话。

成分

• 常量：存储在应用程序中使用的常量值。
• 模型：包含数据模型，例如MatchDetails 。
• 提示：存储用于生成响应的提示模板。
• 服务：包含意图识别、实时比分获取和响应生成的核心逻辑。
• Utils ：为常见任务提供实用函数。
• Chains ：使用 Langchain 管理操作序列以生成响应。
• Enums ：定义在应用程序中使用的枚举。

最近更新

• Streamlit 集成：该应用程序现在包含 Streamlit 界面，以提供更具交互性的用户体验。
• 增强的错误处理：改进的错误处理机制以提高可靠性。
• 模块化代码库：重构代码以增强可读性和可维护性。
• Langchain 集成：利用 Langchain 简化操作顺序并改进响应生成。
• 启用流媒体：添加了实时交互的流媒体功能。
• 已弃用的 Cricbot 服务：替换为使用 langchains 的更加模块化的方法

未来的增强功能

• 日志记录：添加日志记录以更好地监控和调试。
• 测试：实施单元和集成测试以确保可靠性。
• 高级用户界面：开发 GUI 以提供更具交互性的用户体验。

贡献

欢迎贡献！请分叉存储库并提交请求以获取任何增强功能或错误修复。

执照

该项目已获得 MIT 许可证的许可。

---

本自述文件提供了 Cricbot 应用程序的全面概述，包括设置说明、用法和未来的增强功能。请随意修改内容以更好地满足您的项目需求。