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 파일을 만들고 OpenAI API 키를 추가합니다.

    OPENAI_API_KEY=your_openai_api_key_here
   

용법

다음 명령을 사용하여 애플리케이션을 실행합니다.

python app/main.py

쿼리를 입력하여 봇과 상호작용하세요. 세션을 종료하려면 "exit"를 입력하세요.

구성요소

• 상수 : 애플리케이션 전체에서 사용되는 상수 값을 저장합니다.
• 모델 : MatchDetails 와 같은 데이터 모델을 포함합니다.
• 프롬프트 : 응답 생성을 위한 프롬프트 템플릿을 저장합니다.
• 서비스 : 의도 식별, 실시간 점수 가져오기 및 응답 생성을 위한 핵심 논리가 포함되어 있습니다.
• Utils : 일반적인 작업에 대한 유틸리티 기능을 제공합니다.
• 체인 : 응답 생성을 위해 Langchain을 사용하여 작업 순서를 관리합니다.
• Enums : 애플리케이션 전체에서 사용되는 열거형을 정의합니다.

최근 업데이트

• Streamlit 통합 : 이제 애플리케이션에는 보다 대화형 사용자 경험을 위한 Streamlit 인터페이스가 포함됩니다.
• 향상된 오류 처리 : 더 나은 안정성을 위해 오류 처리 메커니즘이 개선되었습니다.
• 모듈형 코드베이스 : 가독성과 유지 관리성을 향상시키기 위해 코드를 리팩터링했습니다.
• Langchain 통합 : Langchain을 활용하여 작업 순서를 간소화하고 응답 생성을 개선합니다.
• 스트리밍 활성화됨 : 실시간 상호 작용을 위한 스트리밍 기능이 추가되었습니다.
• 더 이상 사용되지 않는 Cricbot 서비스 : 랭체인을 사용하는 보다 모듈화된 접근 방식으로 대체되었습니다.

향후 개선 사항

• 로깅 : 더 나은 모니터링 및 디버깅을 위해 로깅을 추가합니다.
• 테스트 : 신뢰성을 보장하기 위해 단위 및 통합 테스트를 구현합니다.
• 고급 사용자 인터페이스 : 보다 대화형 사용자 경험을 위한 GUI를 개발합니다.

기여

기여를 환영합니다! 저장소를 포크하고 개선 사항이나 버그 수정에 대한 풀 요청을 제출하세요.

특허

이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여됩니다.

---

이 README는 설정 지침, 사용법 및 향후 개선 사항을 포함하여 Cricbot 애플리케이션에 대한 포괄적인 개요를 제공합니다. 프로젝트 요구 사항에 더 적합하도록 콘텐츠를 자유롭게 수정하세요.