Skip to content

Latest commit

 

History

History
120 lines (85 loc) · 3.27 KB

README.md

File metadata and controls

120 lines (85 loc) · 3.27 KB
Raw

⚡Turbox Vector Database

Turbox implements an in-memory Vector Database API using Node.js and Express. It allows users to store, retrieve, manipulate, and search vectors through various HTTP endpoints.

It is built for blazing fast performance, Turbox provides efficient operations on vectors, ensuring rapid data access and manipulation.

Release Installation

v1.0.0

Download the latest release here.

  • Click on server.exe to download the executable file.
  • When downloaded, run the file. You will see a popup screen stating that the server is running on localhost:3000

image

  • Once the server is running locally, open PowerShell to execute the endpoints

Important

Run the endpoints from the same directory where the server.exe is downloaded.

  • Here are the list of endpoints you can run the VDB on.


This release includes the initial implementation of Turbox Vector Database.

Features:

  • Implemented CRUD operations for vectors.
  • Added sorting, addition, filtering, and advanced search functionalities with fast speed.

Local Installation

To install and run the Turbox Vector Database locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/suhasasumukh/turbox.git
cd turbox

  2. Install dependencies:

    npm install

  3. Start the server:

    npm start

The server will start running at http://localhost:3000.

Note

Turbox is actively maintained. We are committed to continuously improving this Vector Database API to ensure robust functionality and reliability.

Vector endpoints

Add a Vector

$body = @{
    id = "vec1"
    vector = @(1, 2, 3)
} | ConvertTo-Json

Invoke-RestMethod -Method POST -Uri 'http://localhost:3000/vector' -Body $body -ContentType 'application/json'

Retrieve All Vectors

Invoke-RestMethod -Method GET -Uri 'http://localhost:3000/vectors'

Retrieve a Specific Vector by ID

Invoke-RestMethod -Method GET -Uri 'http://localhost:3000/vector/vec1'

Delete a Vector by ID

Invoke-RestMethod -Method DELETE -Uri 'http://localhost:3000/vector/vec1'

Sort Vectors

Invoke-RestMethod -Method GET -Uri 'http://localhost:3000/vectors/sort/id'

Perform Vector Addition

$body = @{
    vector1 = @(1, 2, 3)
    vector2 = @(4, 5, 6)
} | ConvertTo-Json

Invoke-RestMethod -Method POST -Uri 'http://localhost:3000/vector/addition' -Body $body -ContentType 'application/json'

Filter Vectors

$body = @{
    filterCriteria = @{
        maxLength = 5
    }
} | ConvertTo-Json

Invoke-RestMethod -Method POST -Uri 'http://localhost:3000/vectors/filter' -Body $body -ContentType 'application/json'

Advanced Search

Invoke-RestMethod -Method GET -Uri 'http://localhost:3000/vectors/search?id=vec1&minValue=1&maxValue=5'

License

This project is licensed under the MIT License - see the LICENSE file for details.