Skip to main content

With CocoIndex, users declare the transformation, CocoIndex creates & maintains an index, and keeps the derived index up to date based on source update, with minimal computation and changes.

Project description

CocoIndex

Data transformation for AI

GitHub Documentation License PyPI version

PyPI Downloads CI release Discord

cocoindex-io%2Fcocoindex | Trendshift

Ultra performant data transformation framework for AI, with core engine written in Rust. Support incremental processing and data lineage out-of-box. Exceptional developer velocity. Production-ready at day 0.

⭐ Drop a star to help us grow!


CocoIndex Transformation


CocoIndex makes it effortless to transform data with AI, and keep source data and target in sync. Whether you’re building a vector index for RAG, creating knowledge graphs, or performing any custom data transformations — goes beyond SQL.


CocoIndex Features


Exceptional velocity

Just declare transformation in dataflow with ~100 lines of python

# import
data['content'] = flow_builder.add_source(...)

# transform
data['out'] = data['content']
    .transform(...)
    .transform(...)

# collect data
collector.collect(...)

# export to db, vector db, graph db ...
collector.export(...)

CocoIndex follows the idea of Dataflow programming model. Each transformation creates a new field solely based on input fields, without hidden states and value mutation. All data before/after each transformation is observable, with lineage out of the box.

Particularly, developers don't explicitly mutate data by creating, updating and deleting. They just need to define transformation/formula for a set of source data.

Plug-and-Play Building Blocks

Native builtins for different source, targets and transformations. Standardize interface, make it 1-line code switch between different components - as easy as assembling building blocks.

CocoIndex Features

Data Freshness

CocoIndex keep source data and target in sync effortlessly.

Incremental Processing

It has out-of-box support for incremental indexing:

  • minimal recomputation on source or logic change.
  • (re-)processing necessary portions; reuse cache when possible

Quick Start:

If you're new to CocoIndex, we recommend checking out

Setup

  1. Install CocoIndex Python library
pip install -U cocoindex
  1. Install Postgres if you don't have one. CocoIndex uses it for incremental processing.

Define data flow

Follow Quick Start Guide to define your first indexing flow. An example flow looks like:

@cocoindex.flow_def(name="TextEmbedding")
def text_embedding_flow(flow_builder: cocoindex.FlowBuilder, data_scope: cocoindex.DataScope):
    # Add a data source to read files from a directory
    data_scope["documents"] = flow_builder.add_source(cocoindex.sources.LocalFile(path="markdown_files"))

    # Add a collector for data to be exported to the vector index
    doc_embeddings = data_scope.add_collector()

    # Transform data of each document
    with data_scope["documents"].row() as doc:
        # Split the document into chunks, put into `chunks` field
        doc["chunks"] = doc["content"].transform(
            cocoindex.functions.SplitRecursively(),
            language="markdown", chunk_size=2000, chunk_overlap=500)

        # Transform data of each chunk
        with doc["chunks"].row() as chunk:
            # Embed the chunk, put into `embedding` field
            chunk["embedding"] = chunk["text"].transform(
                cocoindex.functions.SentenceTransformerEmbed(
                    model="sentence-transformers/all-MiniLM-L6-v2"))

            # Collect the chunk into the collector.
            doc_embeddings.collect(filename=doc["filename"], location=chunk["location"],
                                   text=chunk["text"], embedding=chunk["embedding"])

    # Export collected data to a vector index.
    doc_embeddings.export(
        "doc_embeddings",
        cocoindex.targets.Postgres(),
        primary_key_fields=["filename", "location"],
        vector_indexes=[
            cocoindex.VectorIndexDef(
                field_name="embedding",
                metric=cocoindex.VectorSimilarityMetric.COSINE_SIMILARITY)])

It defines an index flow like this:

Data Flow

🚀 Examples and demo

Example Description
Text Embedding Index text documents with embeddings for semantic search
Code Embedding Index code embeddings for semantic search
PDF Embedding Parse PDF and index text embeddings for semantic search
Manuals LLM Extraction Extract structured information from a manual using LLM
Amazon S3 Embedding Index text documents from Amazon S3
Azure Blob Storage Embedding Index text documents from Azure Blob Storage
Google Drive Text Embedding Index text documents from Google Drive
Docs to Knowledge Graph Extract relationships from Markdown documents and build a knowledge graph
Embeddings to Qdrant Index documents in a Qdrant collection for semantic search
FastAPI Server with Docker Run the semantic search server in a Dockerized FastAPI setup
Product Recommendation Build real-time product recommendations with LLM and graph database
Image Search with Vision API Generates detailed captions for images using a vision model, embeds them, enables live-updating semantic search via FastAPI and served on a React frontend
Face Recognition Recognize faces in images and build embedding index
Paper Metadata Index papers in PDF files, and build metadata tables for each paper
Multi Format Indexing Build visual document index from PDFs and images with ColPali for semantic search
Custom Output Files Convert markdown files to HTML files and save them to a local directory, using CocoIndex Custom Targets
Patient intake form extraction Use LLM to extract structured data from patient intake forms with different formats

More coming and stay tuned 👀!

📖 Documentation

For detailed documentation, visit CocoIndex Documentation, including a Quickstart guide.

🤝 Contributing

We love contributions from our community ❤️. For details on contributing or running the project for development, check out our contributing guide.

👥 Community

Welcome with a huge coconut hug 🥥⋆。˚🤗. We are super excited for community contributions of all kinds - whether it's code improvements, documentation updates, issue reports, feature requests, and discussions in our Discord.

Join our community here:

Support us:

We are constantly improving, and more features and examples are coming soon. If you love this project, please drop us a star ⭐ at GitHub repo GitHub to stay tuned and help us grow.

License

CocoIndex is Apache 2.0 licensed.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

cocoindex-0.2.8.tar.gz (29.8 MB view details)

Uploaded Source

Built Distributions

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

cocoindex-0.2.8-cp311-abi3-win_amd64.whl (16.0 MB view details)

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.8-cp311-abi3-manylinux_2_28_x86_64.whl (16.8 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ x86-64

cocoindex-0.2.8-cp311-abi3-manylinux_2_28_aarch64.whl (16.1 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.2.8-cp311-abi3-macosx_11_0_arm64.whl (15.9 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.8-cp311-abi3-macosx_10_12_x86_64.whl (16.5 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

Details for the file cocoindex-0.2.8.tar.gz.

File metadata

  • Download URL: cocoindex-0.2.8.tar.gz
  • Upload date:
  • Size: 29.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: maturin/1.9.4

File hashes

Hashes for cocoindex-0.2.8.tar.gz
Algorithm Hash digest
SHA256 c2bccc398a8c672f956247f9d0f825a1a82fab150367aacf0145504b99228620
MD5 5a43f6448b3630b5864394569b98d573
BLAKE2b-256 d909fb63c0897c4fd6279cf8dc9a0ebf5c150777dde6223eee5b45a82cb421c7

See more details on using hashes here.

File details

Details for the file cocoindex-0.2.8-cp311-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for cocoindex-0.2.8-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 99f80240b263b5b35f18a235b593ad523b7bb7aa56c8808c3069c861ce86bb6e
MD5 6fa71d00b8e583bbbf970569f0a0b0ec
BLAKE2b-256 a9533f4d4e82db06e516bf432da5a97f5ce7226deb42bf888159e08095b1185c

See more details on using hashes here.

File details

Details for the file cocoindex-0.2.8-cp311-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for cocoindex-0.2.8-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 fb6c2dbe91e11f22967b88cec8a8ba5f96bee4ac1577c7929b2bdc11a6b74144
MD5 7c146a0fc708e4dfcfc7adae5110e293
BLAKE2b-256 8d6050ece79cd5365521b3694c0d8a9b7e14a2b3fc32bc8ccf86fc7c05bc7b92

See more details on using hashes here.

File details

Details for the file cocoindex-0.2.8-cp311-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for cocoindex-0.2.8-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 87809f27c32c1efe32b2f5b48bcc0328b67cce7e771064c4944e884de7a4d6b3
MD5 05593e9d7a3ddb7044ad2c4a8f64e3c6
BLAKE2b-256 2d0f7c730be302c55ab9cb144873635262f97b5cf0f0d5aba745f1a4f6fff04a

See more details on using hashes here.

File details

Details for the file cocoindex-0.2.8-cp311-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for cocoindex-0.2.8-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 5a4c9e74d27dd838bb2ad3102ee4e99d4f085b276a4e51d6b395a9f7575691ff
MD5 2335baa98b80dff0be68cc98a06399b5
BLAKE2b-256 adf1fc1e1aee07d6e40eccb535c7e3579b33fb512a8963c5c7f21e46f37e520a

See more details on using hashes here.

File details

Details for the file cocoindex-0.2.8-cp311-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for cocoindex-0.2.8-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 40d4fe4718a9bdd439215c4f73aadac657c3fd901cf2bcb8db134fc8ded1a898
MD5 1ee3cade2ff757598e0efdc8928dd2eb
BLAKE2b-256 138ec5d258580cdb8661bf719c72c838efa8832560e1804263ae63849eecb3a0

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