Skip to main content

Official Python SDK for VectorDBCloud API

Project description

VectorDBCloud Python SDK

Official Python SDK for VectorDBCloud API.

Installation

pip install vectordbcloud

Quick Start

from vectordbcloud import VectorDBCloud

# Initialize client
client = VectorDBCloud(
    api_key="your-api-key",
    base_url="https://api.vectordbcloud.com/prod"  # Optional, defaults to production
)

# Check API health
health = client.health()
print(health)

# Generate embeddings
embedding = client.generate_embedding("Hello, world!")
print(embedding)

# Search vectors
results = client.search_vector(
    vector=[0.1, 0.2, 0.3, 0.4, 0.5],
    limit=10
)
print(results)

# Connect to vector databases
weaviate_config = {
    "url": "http://localhost:8080",
    "api_key": "your-weaviate-key"
}
connection = client.connect_weaviate(weaviate_config)

API Reference

Core Methods

  • health() - Check API health
  • version() - Get API version

Authentication

  • login(email, password) - User login
  • logout() - User logout

Vector Search

  • search_vector(vector, limit, filters) - Vector similarity search
  • search_semantic(text, limit, filters) - Semantic text search

AI Methods

  • generate_embedding(text) - Generate text embeddings
  • generate_text(prompt, **kwargs) - Generate text with AI

Billing

  • get_usage() - Get usage statistics
  • get_invoices() - Get billing invoices

Vector Database Connections

  • connect_weaviate(config) - Connect to Weaviate
  • connect_pinecone(config) - Connect to Pinecone
  • connect_chroma(config) - Connect to ChromaDB
  • connect_qdrant(config) - Connect to Qdrant
  • connect_milvus(config) - Connect to Milvus

Configuration

client = VectorDBCloud(
    api_key="your-api-key",
    base_url="https://api.vectordbcloud.com/prod",
    timeout=30
)

Error Handling

from vectordbcloud import VectorDBCloud, AuthenticationError, APIError

try:
    client = VectorDBCloud(api_key="invalid-key")
    result = client.health()
except AuthenticationError:
    print("Invalid API key")
except APIError as e:
    print(f"API error: {e}")

Version

Current version: 1.1.0

License

MIT License

Support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vectordbcloud-1.1.3.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vectordbcloud-1.1.3-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file vectordbcloud-1.1.3.tar.gz.

File metadata

  • Download URL: vectordbcloud-1.1.3.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vectordbcloud-1.1.3.tar.gz
Algorithm Hash digest
SHA256 149a74e6f66d7bb5038ef7cbfd08c101439e82fed60326ec8be89a0081057a65
MD5 bf4d706f7aed6abb213a98538467d386
BLAKE2b-256 6ee0516c63be91fcfb8587a48e04e73f1732674261fa411dbfae952a622369ab

See more details on using hashes here.

File details

Details for the file vectordbcloud-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: vectordbcloud-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vectordbcloud-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1193d3c1384f7597b54a4ffb874f4b542a375f2169863284b2b392368313b4ff
MD5 1e22405ca40a3aa813b324ce050ba4ca
BLAKE2b-256 0e9693706ec69457ab31adc3880d97a6584a693f6acbe197c4e396fa1c630ff3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page