Git Product home page Git Product logo

vectorapi's Introduction

VectorAPI

License Build Status Docker API Docs

VectorAPI is a service for managing vector collections and performing vector similarity queries using a PostgreSQL vector database with the pgvector extension. Utilizes fastapi for the HTTP API, pgvector and SQLAlchemy for the vector database side and relies on pytorch for computing embeddings.

Getting started

Existing database

To get started with the VectorAPI, run:

docker run -p 8889:8889 -e DB_URL=postgresql+asyncpg://<user>:<password>@<host>:<port>/<dbname> grafana/vectorapi

New database

You can bring up a postgres database (ankane/pgvector) and vectorapi instance using docker compose:

docker compose up --build

To populate the local DB instance with test data from HuggingFace (see Grafana public datasets) run:

make populate-db

Making requests

See API docs for more details.

Embedding text

curl -X POST "http://localhost:8889/v1/embeddings" \
    -H "Content-Type: application/json" \
    -d '{"input":"I enjoy taking long walks along the beach.", "model":"BAAI/bge-small-en-v1.5"}'

Adding a vector to a collection

  1. Create a collection
curl -X POST "http://localhost:8889/v1/collections/create" \
    -H "Content-Type: application/json" \
    -d '{"collection_name":"my_collection", "dimension":384}'
  1. Add a vector to the collection
curl -X POST "http://localhost:8889/v1/collections/my_collection/upsert" \
    -H "Content-Type: application/json" \
    -d '{"id":"abc1", "metadata":{"key":"value"}, "input":"I enjoy taking long walks along the beach."}'

Vector search

curl -X POST "http://localhost:8889/v1/collections/my_collection/search" \
    -H "Content-Type: application/json" \
    -d '{"input":"beach walks"}'

vectorapi's People

Contributors

edwardcqian avatar ioanarm avatar yoziru avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

vectorapi's Issues

Add Drone CI

For testing and docker build

  • build docker image (done in #9)
  • run unit tests in CI
  • run integration tests in CI (with db)

pgvector improvements

Now

  1. ioanarm

Next

Later

Too many connection error on upsert when initially creating collection

Getting the following error

vectorapi-api-1       | asyncpg.exceptions.TooManyConnectionsError: sorry, too many clients already

When running upserts during collection setup.

reproduce steps:

  1. start vectorapi: make up
  2. run custom initialization script (e.g. make store in llm-experiment-lab)

Searching vector store with text

Similar to /query, except taking in a text input instead of a vector input

Options:

  • A separate endpoint (e.g. /v1/collections/<collection_name>/search) that only takes text input
  • Modify /v1/collections/<collection_name>/query to have flexible input (either text input or vector input)

We should maybe also support a generic search without going to a specific collection first, e.g.

  • /v1/search that takes a collection_name in the input
  • Stretch goal: multiple collection names to search across multiple collections?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.