A RAG-based company information retrieval system
Project description
I'll update the README.md to better reflect your project's current state and functionality. Here's an improved version:
# StartGarlic
A RAG-based contextual advertisement system that provides intelligent ad matching based on natural language queries.
## Installation
```bash
pip install startgarlic
Quick Start
from startgarlic import Garlic
# Initialize the system with your API key
api_key = "your_api_key_here"
garlic = Garlic(api_key)
# Find a relevant advertisement based on a query
ad_data = garlic.find_advertisement("I am interested in quantum computing in finance")
print(ad_data)
Features
- Contextual ad matching using RAG (Retrieval-Augmented Generation)
- Semantic search using sentence transformers
- Real-time bidding and auction system
- User context awareness
- Analytics and performance tracking
- Easy API integration
API Usage
Match Endpoint
import requests
response = requests.post(
"http://localhost:8001/api/match",
json={
"query": "I am interested in quantum computing in finance",
"user_id": "optional_user_id",
"context": {}
},
headers={
"Authorization": "Bearer your_api_key_here"
}
)
print(response.json())
Response Format
{
"company": "Example Company",
"product_name": "AI Assistant Pro",
"product_url": "https://example.com/products/ai-assistant",
"tracking_url": "https://example.com/track/ai-assistant?ref=chat"
}
Requirements
- Python >= 3.7
- FastAPI >= 0.68.0
- pandas >= 1.3.0
- sentence-transformers >= 2.0.0
- numpy >= 1.19.0
- supabase >= 0.0.1
Authors
- Bogdan Ciolac (bogdan@startgarlic.com)
- May Elshater (may@startgarlic.com)
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
startgarlic-0.1.22.tar.gz
(17.4 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file startgarlic-0.1.22.tar.gz.
File metadata
- Download URL: startgarlic-0.1.22.tar.gz
- Upload date:
- Size: 17.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b85a2e8261fef90a6012689acccd1c20c05e6cac8d39e95dcbe7b40101d153c4
|
|
| MD5 |
2060951c35f5e84c0ba81a49a75e4a9d
|
|
| BLAKE2b-256 |
d315807b7f078e28bb0df9fa6166ceeaeba220d51f67b0db3dd8d4254811eaed
|
File details
Details for the file startgarlic-0.1.22-py3-none-any.whl.
File metadata
- Download URL: startgarlic-0.1.22-py3-none-any.whl
- Upload date:
- Size: 20.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1207a21c572496da64af454a069ddbb2686a74c3541e4f11d086736e1d5a58e8
|
|
| MD5 |
92e1af05a49d9d1207c2ad515fe570e6
|
|
| BLAKE2b-256 |
f05e0e27c5c38ceb4b66af808d6b33c22bd304123448ea2083ebcfbf54a1ceab
|