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.26.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.26-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: startgarlic-0.1.26.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.26.tar.gz
Algorithm Hash digest
SHA256 7ed5ce2f69fa98cd9dfe490914d24bfdb15b982cc89179745861707565680129
MD5 bec6c8669bcdc0f2cbe634d779955dda
BLAKE2b-256 b05f53dc8414a1144bb43e3ca1f69802dd800b239e3cbea8c6394a3bcc581997

See more details on using hashes here.

File details

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

File metadata

  • Download URL: startgarlic-0.1.26-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.26-py3-none-any.whl
Algorithm Hash digest
SHA256 9de162225e0fd86a8dc8250f0c815ff5d8cd2c20ea3952cc1d9fd79b5e6227bc
MD5 6f1cff1c70c353d753a17b484383765b
BLAKE2b-256 8cb3ddf6bded357354ab5eebb4a45a5eb3ac5aac0a88caefc182c73189bc35d1

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