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.28.tar.gz (19.1 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.28-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: startgarlic-0.1.28.tar.gz
  • Upload date:
  • Size: 19.1 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.28.tar.gz
Algorithm Hash digest
SHA256 0fcdb29fddedf04fcdec831ede2346cbd0d195232c80bb1534fc31a09fb85025
MD5 0d2e904e21b9de37ec0d70b513b04e3f
BLAKE2b-256 00adffceef6b00769a67507e94c7452f986fc47514976a4d1c1b4a0d132ed88e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: startgarlic-0.1.28-py3-none-any.whl
  • Upload date:
  • Size: 22.4 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.28-py3-none-any.whl
Algorithm Hash digest
SHA256 f5ede92cb8e1f9e83447592d5526a506546970ab7275c63bd1ffec481ae38b9d
MD5 3713ab903125ddb5b85dff5bdbb92976
BLAKE2b-256 fdd5b421a751e58c59f9b84868dd4f86e34976982dd1410b86fc58cf72341e65

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