Skip to main content

Type-safe Python ORM for AWS S3 Vectors - build RAG applications within minutes and 90% cost savings.

Project description

Documentation Status https://github.com/MacHu-GWU/s3vectorm-project/actions/workflows/main.yml/badge.svg https://codecov.io/gh/MacHu-GWU/s3vectorm-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/s3vectorm.svg https://img.shields.io/pypi/l/s3vectorm.svg https://img.shields.io/pypi/pyversions/s3vectorm.svg https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to s3vectorm Documentation

https://s3vectorm.readthedocs.io/en/latest/_static/s3vectorm-logo.png

s3vectorm is a Python ORM-style library that provides a type-safe, intuitive interface for managing vector data in AWS S3 Vectors service. Built on top of Pydantic, it combines the power of AWS’s cost-effective vector storage with the reliability of runtime type validation and the familiarity of ORM-like data manipulation.

Why S3 Vectors + s3vectorm?

AWS S3 Vectors offers up to 90% cost reduction compared to traditional vector databases, making it an ideal choice for startups and cost-conscious organizations building RAG (Retrieval-Augmented Generation) applications. However, working directly with the AWS SDK can be verbose and error-prone. s3vectorm bridges this gap by providing a clean, Pythonic API that makes vector operations as simple as working with traditional database models.

Type-Safe Vector Models

Define your vector data structures using familiar Pydantic syntax with automatic validation:

from s3vectorm import Vector
from pydantic import Field

class DocumentChunk(Vector):
    document_id: str = Field(description="Source document ID")
    chunk_seq: int = Field(description="Chunk sequence number")
    title: str = Field(description="Document title")
    category: str = Field(description="Document category")
    owner_id: str = Field(description="Document owner")

Intuitive Query Builder

Build complex metadata queries using a SQLAlchemy-inspired syntax:

from s3vectorm import BaseMetadata, MetaKey

class DocumentMeta(BaseMetadata):
    document_id = MetaKey()
    category = MetaKey()
    owner_id = MetaKey()

# Build queries naturally
filter_query = (
    DocumentMeta.category.eq("research") &
    DocumentMeta.owner_id.in_(["alice", "bob"])
)

Ready for Production RAG

With s3vectorm, you can build sophisticated RAG applications in minutes, not days. The library handles the complexities of AWS S3 Vectors operations while providing the type safety and developer experience you expect from modern Python libraries. Whether you’re prototyping your first vector search feature or scaling to millions of embeddings, s3vectorm provides the foundation for reliable, cost-effective vector operations.

Install

s3vectorm is released on PyPI, so all you need is to:

$ pip install s3vectorm

To upgrade to latest version:

$ pip install --upgrade s3vectorm

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

s3vectorm-0.1.1.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

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

s3vectorm-0.1.1-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

Details for the file s3vectorm-0.1.1.tar.gz.

File metadata

  • Download URL: s3vectorm-0.1.1.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for s3vectorm-0.1.1.tar.gz
Algorithm Hash digest
SHA256 92d295b75c5a124fab19bcef8903ea2495f05b89e12ea216e7246a2f53a843c2
MD5 a8e07febe99f9feeead78387eacbe0e7
BLAKE2b-256 ae6dbb6da2430b1863c1fcb260ef3f9c72ef495995e9dcaddb70331f37624a27

See more details on using hashes here.

File details

Details for the file s3vectorm-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: s3vectorm-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 20.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for s3vectorm-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 44b92d1c4e72829f0a08dbfcdd805d3df337166bb8c244b096889f6efc932b20
MD5 0ce3023bcb6a50c2bfc86d1992878f4a
BLAKE2b-256 31abcef9467ffeb04590eb4fac1f49ae96436c44f09590e30174b0888df096ee

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