Skip to content

Add required packages table to README Installation section #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add required packages table to README Installation section #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a54c6b7
Initial plan for issue
Copilot Jun 6, 2025
a50c04f
Add required packages table to README Installation section
Copilot Jun 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,28 @@ A Streamlit-based intelligent chat application that integrates Azure OpenAI and
```

2. **Install dependencies**

### Required Packages

| Package | Purpose | Usage in Application |
|---------|---------|---------------------|
| streamlit | Web framework | Main application interface and UI components |
| streamlit-chat | Chat interface | Chat message display and conversation UI |
| streamlit-option-menu | Navigation menu | Main navigation menu between app sections |
| openai | OpenAI API client | Azure OpenAI integration for chat and embeddings |
| langchain | LLM framework | Document processing, Q&A chains, and embeddings |
| faiss-cpu | Vector similarity search | Similarity search for document retrieval |
| transformers | NLP models | Tokenization for text processing |
| pandas | Data manipulation | Data handling and processing |
| numpy | Numerical operations | Array operations and mathematical functions |
| requests | HTTP client | API calls to Azure services |

Install all dependencies at once:
```bash
pip install -r requirements.txt
```

Or install individually:
```bash
pip install streamlit
pip install streamlit-chat
Expand Down