AnnDB
  • About AnnDB
  • Quickstart
  • Datasets
    • Images
    • Semantic Search
    • Question Answering
    • Vector
Powered by GitBook
On this page
  • Create a Dataset
  • Create an API Key
  • Install AnnDB
  • Hello, world!

Quickstart

PreviousAbout AnnDBNextImages

Last updated 4 years ago

Create a Dataset

The first step is to for your data. AnnDB provides multiple dataset types which provide out-of-the-box solutions for image similarity search, text semantic search, question answering, or raw approximate nearest neighbours search in case you want to use your own vector embeddings.

Create an API Key

Install AnnDB

pip install anndb-api
gem install anndb_api

Hello, world!

This example application shows, how easy it is to build an image similarity search service with AnnDB in just a few lines of code.

import anndb_api

# Create a client instance
client = anndb_api.Client('<YOUR_API_KEY')

# Load the dataset
dataset = client.images('<DATASET_NAME>')

# Insert the data
for url in img_urls:
    id = dataset.insert(url, metadata={'src_url': url})
    
# Delete some of it
dataset.delete(id)

# Query top 5 similar images
items = dataset.search_image(img_urls[-1], 5)

# Query top 5 similar images using textual query
items = dataset.search_text('cute puppy', 5)
require 'anndb_api'

# Create a client instance
client = AnndbApi::Client.new("<YOUR_API_KEY")

# Load the dataset
dataset = client.images("<DATASET_NAME>")

img_urls.each do |url|
    id = dataset.insert(url, metadata={ "src_url": url })
end
    
# Delete some of it
dataset.delete(id)

# Query top 5 similar images
items = dataset.search_image(img_urls.last, 5)

# Query top 5 similar images using textual query
items = dataset.search_text("cute puppy", 5)

Next, you will need to to authenticate your client application with the AnnDB API. You can either a universal API key for all datasets, or you can create a dataset-specific API key to limit the access scope.

AnnDB provides client implementations in the following languages: , . Clients allow you to modify and search the data stored in your datasets.

create an API key
Python
Ruby
create a dataset