Skip to main content

No project description provided

Project description

QAI-Server

QAI-Server is a Docker-based application designed to be a web interface for other projects inside of QRev.

Features

  • Dockerized application for consistency and portability
  • Campaign management
  • Provides RESTful API endpoints for various tasks

Requirements

  • Python 3.11
  • Docker
  • Poetry

Getting Started

Clone the Repository

git clone https://github.com/qrev-ai/qrev.git

Go to the project folder

cd qrev/ai/projects/server

Build and Run with Docker

Ensure that Docker is installed and running. Then, use the provided Makefile to build and run the project:

  1. Build the Docker Image

    make build
    
  2. Run the Application

    make up
    

    The application should be running on http://localhost:8081.

Run Unit Tests

Run the project's unit tests using the Makefile:

make test

Makefile Commands

  • make test: Run all unit tests.
  • make .build: Build the project using Poetry.
  • make publish: Publish the project after building it.
  • make heartbeat: Check if the server is alive.
  • make loglevel: Set the server's log level.
  • make list_collections: List all collections from the Chroma API.
  • make campaign: Send a campaign query to the server.

AWS Commands

  • make authenticate: Authenticate to the AWS ECR.
  • make deploy_service: Deploy the service to an AWS ECS cluster.

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

qai_server-0.5.3.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

qai_server-0.5.3-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file qai_server-0.5.3.tar.gz.

File metadata

  • Download URL: qai_server-0.5.3.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.9 Darwin/23.0.0

File hashes

Hashes for qai_server-0.5.3.tar.gz
Algorithm Hash digest
SHA256 306c9fb2e9725a9d92e44385459b2982944f3c9864a6659fe6fd9d56f2a85d09
MD5 a96f3169ac29f437b74e5ea33da27a1a
BLAKE2b-256 7133452a72b7bb4dfa0508c2cd4e009be5354de149c990e6780f4c857bbbb2bd

See more details on using hashes here.

File details

Details for the file qai_server-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: qai_server-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.9 Darwin/23.0.0

File hashes

Hashes for qai_server-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 71eb2bda92feb1754233eb97bf0e50d5bb267e48fbf8133c67b9dc3b328ff15f
MD5 958a55b169a45af27039bcf23d071139
BLAKE2b-256 629127a1805d2279c1337299a65fdf649b42576cd8cf9f9142ab6fc98549b02e

See more details on using hashes here.

Supported by

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