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
Setting up the .env file and config.toml file
For the .env file you can see the example placed in examples/example.env
Build and Run with Docker
Ensure that Docker is installed and running. Then, use the provided Makefile to build and run the project:
-
Build the Docker Image
make build
-
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.4.tar.gz
(7.6 kB
view hashes)
Built Distribution
Close
Hashes for qai_server-0.5.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a09330e15165fc3f1702967f7215550106db89f0c27a4032561d1f11b699d12 |
|
MD5 | a1e7786ea77987f27fc6dc363f2fe570 |
|
BLAKE2b-256 | 3fd4cc5db0b9f63c4bb9e046dc7c010188ad025c1cf3072e7255942c2d84ab75 |