PQAI Index

Service for searching vector indexes.

Indexes are searched by passing in a query vector. A list of most similar vectors present in the index are then found and their labels and similarities (or distances) are returned in the response.

For more detailed information, please refer to PQAI Wiki.

Routes

Method	Endpoint	Comments
GET	/search	Search for similar items using a query vector

How to run?

From command line

1. Clone this repository
2. Create a .env file using /env template and set environment variable values
3. Create a virtual environment and install dependencies: pip install -r requirements.txt
4. Run the service: python3 main.py

As docker container

1. Install Docker in your system.
2. Clone this repository
3. Create a .env file using /env template and set environment variable values
4. Then run the command: sudo docker compose up

License

The project is open-source under the MIT license.

Contribute

We welcome contributions.

To make a contribution, please follow these steps:

1. Fork this repository.
2. Create a new branch with a descriptive name
3. Make the changes you want and add new tests, if needed
4. Make sure all tests are passing
5. Commit your changes
6. Submit a pull request

Support

Please create an issue if you need help.