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.2.tar.gz (5.1 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.2-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vectordbcloud-1.1.2.tar.gz
  • Upload date:
  • Size: 5.1 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.2.tar.gz
Algorithm Hash digest
SHA256 9bda6298b3ef74cebed45adc5e9b86ae803bfac123632fc72c152f17d92319db
MD5 d62c4fe98d815945f85a9da982094672
BLAKE2b-256 e1fc09a2762de476c40c5209ac2d624538790dc1981313c49eda4ed5590432fa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vectordbcloud-1.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 feac31148145d0e4ad6011914f2b675add515e8dc347fb172fd93152d58fdaf6
MD5 4a849fde282d7aefb052bd1b5c02f432
BLAKE2b-256 31f38b2f7227138dcca92eb6232d00fd5b4be3d883e483a9dddcfc7bbff56304

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