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.24.tar.gz (19.2 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.24-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: startgarlic-0.1.24.tar.gz
  • Upload date:
  • Size: 19.2 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.24.tar.gz
Algorithm Hash digest
SHA256 daa39535d0784740b673f43a61da86a10c0aef35d10cb666033af2b01478eb80
MD5 18d46b61d1ca119cbc29a70ece0bc885
BLAKE2b-256 f9926e653a58435bd92e0b1bfcc0d217db9b9cf926cf8d247ed71a70d65c2d86

See more details on using hashes here.

File details

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

File metadata

  • Download URL: startgarlic-0.1.24-py3-none-any.whl
  • Upload date:
  • Size: 22.5 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.24-py3-none-any.whl
Algorithm Hash digest
SHA256 49ebb27bde57ac5648e4968028f8c93e768521b4ab09dcdc657b7505b1a708eb
MD5 3169068a8dc9c7af89159ea34b1e17c0
BLAKE2b-256 f7571b35cda3ece29474ad5b09884425168d06fd7bbfad7c99c4f039a6bf2c1a

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