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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vectordbcloud-1.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 2ccbd41e9d0b825eb477f085f51fcad1f9445b0ebb81198709cc15b4c0923a51
MD5 d2ecee809e94d51144d20e2ed10d7248
BLAKE2b-256 fac044f9b42cf4ab447e0a9d46cd661de91e47ebcfe794d855cab19edb4ccdf9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vectordbcloud-1.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 83bfca838528d93b683b954b96e27f18d646d16051e238c1db980f037db738e7
MD5 64836aa7d32969197925dbe67d0554c7
BLAKE2b-256 5b7ef7dd7b791f1ade5c8de446d2e54a2113ae24b4ed859103acea71927290cc

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