Cricbot

Aplicativo Cricbot

Visão geral

Cricbot é um aplicativo chatbot projetado para fornecer resultados de críquete ao vivo e lidar com várias intenções do usuário. Ele aproveita os modelos de linguagem OpenAI para entender as dúvidas dos usuários e gerar respostas apropriadas. A aplicação está estruturada para garantir modularidade e facilidade de manutenção.

Estrutura de diretório

 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

Configurar

Pré-requisitos

• Python 3.x
• pip (instalador do pacote Python)

Instalação

1. Clonar o repositório

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

2. Crie um ambiente virtual

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

3. Instalar dependências

   pip install -r requirements.txt

4. Configurar variáveis ​​de ambiente

   Crie um arquivo .env no diretório raiz e adicione sua chave de API OpenAI:

    OPENAI_API_KEY=your_openai_api_key_here
   

Uso

Execute o aplicativo usando o seguinte comando:

python app/main.py

Interaja com o bot digitando suas dúvidas. Digite “exit” para encerrar a sessão.

Componentes

• Constantes : armazena valores constantes usados ​​no aplicativo.
• Modelos : contém modelos de dados como MatchDetails .
• Prompts : armazena modelos de prompt para gerar respostas.
• Serviços : contém a lógica central para identificação de intenção, busca de pontuação ao vivo e geração de resposta.
• Utils : Fornece funções utilitárias para tarefas comuns.
• Chains : gerencia a sequência de operações usando Langchain para gerar respostas.
• Enums : define enumerações usadas no aplicativo.

Atualizações recentes

• Integração Streamlit : O aplicativo agora inclui uma interface Streamlit para uma experiência de usuário mais interativa.
• Tratamento de erros aprimorado : Mecanismos de tratamento de erros aprimorados para melhor confiabilidade.
• Base de código modular : código refatorado para melhorar a legibilidade e a manutenção.
• Integração Langchain : Utilizado Langchain para agilizar a sequência de operações e melhorar a geração de respostas.
• Streaming habilitado : Adicionados recursos de streaming para interação em tempo real.
• Serviço Cricbot obsoleto : substituído por uma abordagem mais modular usando langchains

Melhorias Futuras

• Registro : adicione registro para melhor monitoramento e depuração.
• Teste : implemente testes unitários e de integração para garantir a confiabilidade.
• Interface de usuário avançada : Desenvolva uma GUI para uma experiência de usuário mais interativa.

Contribuindo

Contribuições são bem-vindas! Bifurque o repositório e envie uma solicitação pull para quaisquer melhorias ou correções de bugs.

Licença

Este projeto está licenciado sob a licença MIT.

---

Este README fornece uma visão geral abrangente do aplicativo Cricbot, incluindo instruções de configuração, uso e melhorias futuras. Sinta-se à vontade para modificar o conteúdo para melhor atender às necessidades do seu projeto.