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.0.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.0-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vectordbcloud-1.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 3c8528b0ca1ca4617568d72977c5e9abd6972596d1e4f5ceba4c4d1b0728f4bf
MD5 ce8624052f0b66d021acc4c76c099355
BLAKE2b-256 2f99019d05513aacae0de968dba0fdc1b1ec8089c84dd9caa7a947229ffa5685

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vectordbcloud-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.9 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 07591cd049f0287c1f2c4c57c1fb77f7c5f26932aafab4dba9db01b8d77b4436
MD5 1041f09420d88da151c418e70555fe43
BLAKE2b-256 ceb93a602b6593669b3ef75f4b984500bb32590d4550b7d770c5db93a2242a48

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