Search vectors

from actian_vectorai_client import VectorAIClient import random with VectorAIClient("localhost:6574") as client: # Basic vector search query = [random.gauss(0, 1) for _ in range(64)] results = client.points.search("my_collection", vector=query, limit=5) for r in results: print(f"ID: {r.id}, Score: {r.score:.4f}") print(f"Payload: {r.payload.get('category')}")

{ "usage": { "hardware": null }, "time": 0.0000553, "status": "ok", "result": [ { "id": 1, "version": 0, "score": 1, "payload": null, "vector": null }, { "id": 3, "version": 0, "score": 0.9843740463256836, "payload": null, "vector": null }, { "id": 2, "version": 0, "score": 0.9688639640808105, "payload": null, "vector": null } ] }

Authorizations

Authorization

string

header

required

Admin JWT or access token for authenticating requests to VectorAI DB.

Path Parameters

collection_name

string

required

The name of the collection to search.

Body

application/json

vector

number[]

required

The query vector to search for. The number of dimensions must match the collection's configured vector size.

Example:

[0.1, 0.2, 0.3, 0.4]

limit

integer

default:10

Maximum number of results to return. Defaults to 10.

Example:

5

offset

integer

default:0

Number of results to skip for pagination. Use with limit to page through results.

Example:

0

score_threshold

number

Minimum similarity score for results. Only points with scores at or above this threshold are returned.

Example:

0.7

filter

object

Optional filter to narrow search results based on payload metadata. See the Filters API for syntax.

with_payload

boolean

default:true

Whether to include payload metadata in the response.

Example:

true

with_vector

boolean

default:false

Whether to include vector data in the response. Set to false to reduce response size.

Example:

false

params

object

Advanced search parameters for tuning search quality and performance.

Show child attributes

Response

Search results

usage

object

Show child attributes

time

number<double>

Time spent to process this request, in seconds.

Example:

0.0000553

status

string

Operation status.

Example:

"ok"

result

object[]

Show child attributes

REST API

gRPC API

Authorizations

Path Parameters

Body

Response