EigenDB Documentation
  • Overview
  • What's a vector database?
    • Similarity Search in EigenDB
  • EigenDB's REST API
Powered by GitBook
On this page

EigenDB's REST API

EigenDB provides a robust REST API to perform various actions.

PreviousSimilarity Search in EigenDB

Last updated 6 months ago

  • GETDatabase health check
  • PUTInsert a vector
  • PUTInsert many vectors
  • GETPerform similarity search
  • POSTUpdate persistence time interval
  • POSTUpdate the API port
  • POSTUpdate the API address
  • POSTUpdate the similarity metric
  • POSTUpdate the vector space size
  • POSTUpdate the M parameter
  • POSTUpdate the efConstruction parameter

Database health check

get

Perform a health check on the database.

Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/health'
200
500
{
  "status": "healthy"
}

Database is healthy.

Insert a vector

put

Inserts a vector into the database.

Body
componentsnumber ยท float[]required

Components of vector to be inserted

Responses
text/plain
text/plain
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url '/vector/insert' \
  --header 'Content-Type: application/json' \
  --data '{
    "components": [
      1
    ]
  }'
200
400
Vector successfully inserted.

Vector inserted.

Insert many vectors

put

Insert many vectors at once into the database.

Body
setOfComponentsnumber ยท float[][]required

Array of vectors, each represented by their components (float32[][])

Responses
text/plain
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url '/vector/bulk-insert' \
  --header 'Content-Type: application/json' \
  --data '{
    "setOfComponents": [
      [
        1
      ]
    ]
  }'
200
10/10 vectors successfully inserted.

Vectors inserted.

Perform similarity search

get

Perform similarity search on a query vector.

Body
queryVectorIdnumber ยท intrequired

ID of the query vector

knumber ยท intrequired

K-nearest vectors desired

Responses
text/plain
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/vector/search' \
  --header 'Content-Type: application/json' \
  --data '{
    "queryVectorId": 1,
    "k": 1
  }'
200
[
  4,
  7,
  2,
  8,
  5
]

The k-nearest vectors returned in a array.

Update persistence time interval

post

Modify the time interval at which vectors in memory are persisted on disk.

Body
updatedValueSecsnumber ยท floatrequired

The new time interval in seconds

Responses
text/plain
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/update-config/persistence/time-interval' \
  --header 'Content-Type: application/json' \
  --data '{
    "updatedValueSecs": 1
  }'
200
Time interval updated.

Time interval successfully updated.

Update the API port

post

Update the port on which the API runs (default = 8080). EigenDB must be restarted this to take effect.

Body
updatedPortnumber ยท intrequired

The new port number

Responses
text/plain
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/update-config/api/port' \
  --header 'Content-Type: application/json' \
  --data '{
    "updatedPort": 1
  }'
200
API port updated. Please restart the database for it to take effect.

API port successfully updated.

Update the API address

post

Update the address on which the API runs (default = 0.0.0.0). EigenDB must be restarted this to take effect.

Body
updatedAddressstringrequired

The new API address

Responses
text/plain
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/update-config/api/address' \
  --header 'Content-Type: application/json' \
  --data '{
    "updatedAddress": "text"
  }'
200
API address updated. Please restart the database for it to take effect.

API address successfully updated.

Update the similarity metric

post

Update the similarity metric used in similarity search (default = euclidean). EigenDB must be restarted this to take effect.

Body
updatedMetricstringrequired

The new similarity metric (cosine, euclidean, ip)

Responses
text/plain
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/update-config/hnsw-params/similarity-metric' \
  --header 'Content-Type: application/json' \
  --data '{
    "updatedMetric": "text"
  }'
200
Vector similarity metric updated. Please restart the database for it to take effect.

Similarity metric successfully updated.

Update the vector space size

post

Update the vector storage capacity. EigenDB must be restarted this to take effect.

Body
updatedSizestringrequired

The new vector space size

Responses
text/plain
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/update-config/hnsw-params/vector-space-size' \
  --header 'Content-Type: application/json' \
  --data '{
    "updatedSize": "text"
  }'
200
Vector space size updated. Please restart the database for it to take effect.

Vector space size successfully updated.

Update the M parameter

post

Update M parameter in the HNSW algorithm used for similarity search. EigenDB must be restarted this to take effect.

Body
updatedMstringrequired

The new M parameter

Responses
text/plain
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/update-config/hnsw-params/m' \
  --header 'Content-Type: application/json' \
  --data '{
    "updatedM": "text"
  }'
200
M paramater updated. Please restart the database for it to take effect.

M parameter successfully updated.

Update the efConstruction parameter

post

Update efConstruction parameter in the HNSW algorithm used for similarity search. EigenDB must be restarted this to take effect.

Body
updatedEfConststringrequired

The new efConstruction parameter

Responses
text/plain
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/update-config/hnsw-params/ef-construction' \
  --header 'Content-Type: application/json' \
  --data '{
    "updatedEfConst": "text"
  }'
200
EF Construction paramater updated. Please restart the database for it to take effect.

efConstruction parameter successfully updated.