Skip to main content

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

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


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.25.tar.gz (19.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

startgarlic-0.1.25-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

Details for the file startgarlic-0.1.25.tar.gz.

File metadata

  • Download URL: startgarlic-0.1.25.tar.gz
  • Upload date:
  • Size: 19.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.11

File hashes

Hashes for startgarlic-0.1.25.tar.gz
Algorithm Hash digest
SHA256 dfb27091726eb119e592cec8641b6c5c72df6b16f9acc8cb5387c5a797a54403
MD5 c2025095c65934ac13d9979e9fedd6b0
BLAKE2b-256 e205ca3f0122d3e44f994fb52a28fb22d45075ecfd5eb32f87ec8067ee8a4008

See more details on using hashes here.

File details

Details for the file startgarlic-0.1.25-py3-none-any.whl.

File metadata

  • Download URL: startgarlic-0.1.25-py3-none-any.whl
  • Upload date:
  • Size: 22.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.11

File hashes

Hashes for startgarlic-0.1.25-py3-none-any.whl
Algorithm Hash digest
SHA256 4c9da78ba07a5016c8f8f22a880449adf5ba0d56a33c747d2fb78b6ca78cbf57
MD5 0231e7d2cd4bcd9eaf53e4b7317d384a
BLAKE2b-256 2fd222d92f99cabfa3964a882cb80c52a65cb5c49565175fa692759b515ce466

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page