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
🚀 Tech Stack
- ✅ Connection to the App Server Database: MongoDB.
- ✅ Vector Database: ChromaDB.
- ✅ SQL Relational Database: MySQL, MariaDB, SQLite3, anything that works with SQLAlchemy.
Prerequisites
- All of the above tech stack set up.
Code 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
The config.toml configuration file is placed in your application directory under the name qai. Linux example ~/.config/qai/config.toml. An example config.toml
Run locally
From the server project folder. ai/projects/server
sh scripts/run_server.sh
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 upThe 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.
Metadata
Release files for qai-server 0.5.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| qai_server-0.5.4.1.tar.gz | 8.2 kB | Without provenance | Details for qai_server-0.5.4.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| qai_server-0.5.4.1-py3-none-any.whl | Python 3 | none | any | Details for qai_server-0.5.4.1-py3-none-any.whl |
Total release size: 17.3 kB
Release files / qai_server-0.5.4.1.tar.gz
| Download URL | qai_server-0.5.4.1.tar.gz |
|---|---|
| Size | 8.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f138a8cfa91a80baa280f3050111884d55b26c11ca71831cc122a3d92b1800eb
|
|
BLAKE2b-256 checksum How to use checksums |
a31d6a9153c0d4d5a7154065c665b5a4a28adaa6bdecf9453238ded650a573bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.11.9 Darwin/23.0.0
|
Release files / qai_server-0.5.4.1-py3-none-any.whl
| Download URL | qai_server-0.5.4.1-py3-none-any.whl |
|---|---|
| Size | 9.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bdcd249eb66f4e98d23dcfef1c75a650ff41b6cf60486346078f92b3f87dc14e
|
|
BLAKE2b-256 checksum How to use checksums |
2817494c8e5431aa93557787cd53a79982f6e042cb31e1da56dd7b70655e6015
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.11.9 Darwin/23.0.0
|
Security for qai-server 0.5.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.