81 lines
2.1 KiB
Markdown
81 lines
2.1 KiB
Markdown
|
# Marketing Assistant AI - Data Directory
|
||
|
|
|
||
|
|
This directory contains the data used by the Marketing Assistant AI system.
|
||
|
|
|
||
|
|
## Structure
|
||
|
|
|
||
|
|
- **past_campaigns/**: Contains JSON files of past marketing campaigns used for training and reference
|
||
|
|
- **user_queries/**: Stores user queries and requests for analytics and model improvement
|
||
|
|
- **style_guidelines/**: Contains brand tone and voice guidelines
|
||
|
|
- **vector_store/**: Generated vector database for content retrieval (created automatically)
|
||
|
|
|
||
|
|
## File Formats
|
||
|
|
|
||
|
|
### Past Campaigns
|
||
|
|
|
||
|
|
Past campaign files are stored as JSON with the following structure:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"content": "The actual marketing content text",
|
||
|
|
"content_type": "email_campaign|social_media|blog_post|etc",
|
||
|
|
"metadata": {
|
||
|
|
"campaign_name": "Name of the campaign",
|
||
|
|
"performance_metrics": {
|
||
|
|
"metric1": value,
|
||
|
|
"metric2": value
|
||
|
|
},
|
||
|
|
"content_type": "Same as above",
|
||
|
|
"added_at": "ISO timestamp",
|
||
|
|
"training_data": true
|
||
|
|
},
|
||
|
|
"document_id": 0,
|
||
|
|
"timestamp": "ISO timestamp"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### User Queries
|
||
|
|
|
||
|
|
User query files store information about requests made to the AI:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"prompt": "The user's prompt text",
|
||
|
|
"parameters": {
|
||
|
|
"content_type": "Type of content requested",
|
||
|
|
"tone": "Requested tone",
|
||
|
|
"length": "Requested length",
|
||
|
|
"include_cta": true|false
|
||
|
|
},
|
||
|
|
"timestamp": "ISO timestamp"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Brand Style Guidelines
|
||
|
|
|
||
|
|
Brand style is stored as a JSON file with the following structure:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"brand_name": "Adriana James",
|
||
|
|
"tone": ["professional", "friendly", "inspirational"],
|
||
|
|
"voice_characteristics": ["clear", "direct", "empowering"],
|
||
|
|
"taboo_words": ["cheap", "discount", "bargain"],
|
||
|
|
"preferred_terms": {
|
||
|
|
"customers": "clients",
|
||
|
|
"products": "solutions"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Adding New Data
|
||
|
|
|
||
|
|
### Adding Past Campaigns
|
||
|
|
|
||
|
|
1. Use the API endpoint `POST /training-data` with the appropriate JSON payload
|
||
|
|
2. Alternatively, add a JSON file to the `past_campaigns` directory following the format above
|
||
|
|
|
||
|
|
### Updating Brand Style
|
||
|
|
|
||
|
|
1. Use the API endpoint `PUT /brand-style` with the updated style guidelines
|
||
|
|
2. The system will automatically update the style file
|