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.
Metadata
Release files for startgarlic 0.1.30
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| startgarlic-0.1.30.tar.gz | 18.2 kB | Without provenance | Details for startgarlic-0.1.30.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| startgarlic-0.1.30-py3-none-any.whl | Python 3 | none | any | Details for startgarlic-0.1.30-py3-none-any.whl |
Total release size: 39.5 kB
Release files / startgarlic-0.1.30.tar.gz
| Download URL | startgarlic-0.1.30.tar.gz |
|---|---|
| Size | 18.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
97c1b0509b1b67cf0bf0050b49145d9255d63a21075a1714a26c36400089fa2d
|
|
BLAKE2b-256 checksum How to use checksums |
8b3296690a2e6f2a4c696f6646723d4d5bbc3a46be005d0374960f54b91e96a0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.11
|
Release files / startgarlic-0.1.30-py3-none-any.whl
| Download URL | startgarlic-0.1.30-py3-none-any.whl |
|---|---|
| Size | 21.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2638b110bcb6f13d3aa322bc4e5dac2db2603b5d7fcfb8e48265500ed5d2400f
|
|
BLAKE2b-256 checksum How to use checksums |
d4e2fb12102fa543763eecf5f521f78e1c9344bdb5d9a5f5e0f442ee2378c7d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.11
|
Security for startgarlic 0.1.30
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.