Skip to main content

ANN-search

Search for nearest vectors to specified vector. Instead of specifying vector: <array> you can search for similar documents directly by setting id: <document_id> instead

Request Body
ids string[]

Get documents close to the specified document. Provide either ids or vectors

vectors array[]

Get documents close to the vector. The length of the vector must be equal to the dimension specified in the index

max_neighbors number — REQUIRED

Possible values: 1 ≤ value

Maximal number of neighbors to include in response

field_name string — REQUIRED

Possible values: 3 ≤ length ≤ 20, Value must match regular expression ^[a-z0-9_-]{3,20}$

This parameter specifies the index to perform the query in

Responses
200

Insertion successful

Schema
object[]
data array[] — REQUIRED
default

error

Schema
error string — REQUIRED