Skip to main content
The Python SDK provides both synchronous and asynchronous clients for interacting with VectorAI DB. This guide walks you through installing the SDK and verifying your setup.

​
Prerequisites

To use the Python SDK, make sure you have:
  • Python 3.10 or later
  • numpy 2.2 or later
  • grpcio 1.68 or later
  • pydantic 2.10 or later
Run the following command to install the SDK:
Coming soon

​
Install the SDK

Install the VectorAI DB Python SDK using pip.
Coming soon

​
Install with optional dependencies

To install the SDK with additional dependencies for specific use cases, include the relevant extras.
Coming soon

​
Install from source

You can also install the SDK directly from the repository.
Coming soon

​
Verify installation

VectorAI DB Required: To verify your installation, you need a running VectorAI DB instance. Follow the local installation guide to set one up.
Test that the SDK is installed correctly by connecting to the server over gRPC on localhost:50051 and running a health check. 
from actian_vectorai import VectorAIClient

with VectorAIClient("localhost:50051") as client:
    info = client.health_check()
    print(f"Server version: {info['version']}, Uptime: {info['uptime']}")
If the connection is successful, the output displays the server version and uptime. 
Server version: 0.1.0, Uptime: 120s

​
Virtual environments

We recommend installing the SDK inside a virtual environment to avoid dependency conflicts. 
python -m venv .venv
source .venv/bin/activate  # macOS/Linux
.venv\Scripts\activate     # Windows
Then install the SDK inside the activated environment.
Coming soon

​
Troubleshooting

​
Common issues

The following table lists common installation issues and their solutions.
IssueSolution
ModuleNotFoundErrorVerify the SDK is installed in the correct Python environment.
grpc connection errorsConfirm that VectorAI DB is running and accessible on the expected port.
Python version mismatchCheck your version with python --version. The SDK requires Python 3.10 or later.
Permission errors during installUse pip install --user actian-vectorai or install inside a virtual environment.

​
Next steps

Now that the SDK is installed, explore these resources to start building.

Quickstart

Build your first application with the Python SDK

Core Concepts

Learn about collections, vectors, and payloads

Tutorials

Follow step-by-step tutorials