Repository files navigation

Part of aProjectText Suite. VecMetaQ (Vector Metadata Query) is a FastAPI web app encapsulating a FAISS vector index for easy management of embeddings and metadata.

• Add Data: Add text, tag, and metadata usingPOST /add_data/.
• Delete Data: Mark data as deleted via tag usingDELETE /delete_data/.
• Search Similar: Search for similar text usingPOST /search_similar/.

Make sure to have docker installed on your system and then simply copy and initialize the .env file and do a docker compose up:

mv .env-example .envdocker compose up

Or to use the GHCR you can (make sure to have the .env file ready):

docker pull ghcr.io/flagro/vecmetaqdocker run -it --env-file .env ghcr.io/flagro/vecmetaq

Accessible by default at127.0.0.1:8000.

🛠️API Endpoints

• Add Data (POST /add_data/): Requirestext,tag,metadata, and credentials.
• Delete Data (DELETE /delete_data/): Needstag and credentials.
• Search Similar (POST /search_similar/): Expectsquery, optionalk (int),distance_threshold (float), and credentials.

Open for collaboration; check theissues page for discussions.