Updated Documentation

This commit is contained in:
Michael Ikehi
2025-04-18 20:21:11 +01:00
parent 71ad7b4d26
commit 6d07556b85
3 changed files with 104 additions and 70 deletions
+9 -4
View File
@@ -12,6 +12,9 @@ A comprehensive AI-powered tool designed to streamline the process of ideation,
- **Brand Style Management**: Configure and update brand guidelines through a user-friendly interface
- **Training Data Management**: Add successful marketing content to improve the AI over time
- **Content Performance Analysis**: Get insights into the potential effectiveness of your content
- **History Tracking**: Keep track of all generated content and user interactions
- **Pagination Support**: Efficiently browse through large datasets of historical content
- **Error Handling**: Robust error handling and user feedback systems
## 📋 Project Overview
@@ -23,7 +26,10 @@ The Marketing Assistant AI combines a powerful backend built with FastAPI and a
- **Frontend**: Vanilla HTML, CSS, and JavaScript
- **AI Models**: Cohere's generation and embedding models
- **Vector Database**: FAISS for efficient content similarity search
- **Storage**: Local JSON files for historical marketing data
- **Storage**:
- JSON files for historical marketing data
- SQLite for training data
- FAISS vector store for content similarity search
## 🚀 Getting Started
@@ -66,8 +72,7 @@ API_HOST=localhost
API_PORT=8000
# Database Configuration
VECTOR_DB_PATH=./data/vector_store
HISTORY_DB_PATH=./data/history.db
DATABASE_URL=sqlite:///./data/training_data.db
# Brand Configuration
BRAND_NAME=Adriana James
@@ -244,4 +249,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
---
Made with ❤️ for Adriana James
Made with ❤️ for Adriana James