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.16.tar.gz
(21.2 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.16.tar.gz.
File metadata
- Download URL: startgarlic-0.1.16.tar.gz
- Upload date:
- Size: 21.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2e824c5597a184c4c9de1da184a56f6bb9fbc57eda379ce73f4bd9df7c022a89
|
|
| MD5 |
45f25e486c80750f3a947b29267d008e
|
|
| BLAKE2b-256 |
4a3313cdcc8ee59b70db4201e9e71c885ffacc94086121e046a72386ba77ac4d
|
File details
Details for the file startgarlic-0.1.16-py3-none-any.whl.
File metadata
- Download URL: startgarlic-0.1.16-py3-none-any.whl
- Upload date:
- Size: 37.4 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 |
e77c1b2b15752751ed087ca93e38d2b7a6f04154a59e3ef0a5f1eeeba53d3569
|
|
| MD5 |
ecff62c775eaea49fa6f98a920030c39
|
|
| BLAKE2b-256 |
e0e0b41b2e9551f2b90bf00be22d3048f09068502b2d6914101aad1ef1dbc098
|