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 Link Check prek 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, creating knowledge graphs for context engineering 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.

  2. (Optional) Install Claude Code skill for enhanced development experience. Run these commands in Claude Code:

/plugin marketplace add cocoindex-io/cocoindex-claude
/plugin install cocoindex-skills@cocoindex

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
PDF Elements Embedding Extract text and images from PDFs; embed text with SentenceTransformers and images with CLIP; store in Qdrant for multimodal 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
Meeting Notes to Knowledge Graph Extract structured meeting info from Google Drive and build a knowledge graph
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
Embeddings to LanceDB Index documents in a LanceDB 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 Source HackerNews Index HackerNews threads and comments, using CocoIndex Custom Source
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
HackerNews Trending Topics Extract trending topics from HackerNews threads and comments, using CocoIndex Custom Source and LLM
Patient Intake Form Extraction with BAML Extract structured data from patient intake forms using BAML
Patient Intake Form Extraction with DSPy Extract structured data from patient intake forms using DSPy

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.3.32.tar.gz (478.8 kB view details)

Uploaded Source

Built Distributions

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

cocoindex-0.3.32-cp314-cp314t-win_amd64.whl (19.7 MB view details)

Uploaded CPython 3.14tWindows x86-64

cocoindex-0.3.32-cp314-cp314t-manylinux_2_28_x86_64.whl (19.2 MB view details)

Uploaded CPython 3.14tmanylinux: glibc 2.28+ x86-64

cocoindex-0.3.32-cp314-cp314t-manylinux_2_28_aarch64.whl (18.5 MB view details)

Uploaded CPython 3.14tmanylinux: glibc 2.28+ ARM64

cocoindex-0.3.32-cp314-cp314t-macosx_11_0_arm64.whl (17.9 MB view details)

Uploaded CPython 3.14tmacOS 11.0+ ARM64

cocoindex-0.3.32-cp311-abi3-win_amd64.whl (19.7 MB view details)

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.3.32-cp311-abi3-manylinux_2_28_x86_64.whl (19.2 MB view details)

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

cocoindex-0.3.32-cp311-abi3-manylinux_2_28_aarch64.whl (18.5 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.3.32-cp311-abi3-macosx_11_0_arm64.whl (18.0 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.3.32-cp311-abi3-macosx_10_12_x86_64.whl (18.7 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: cocoindex-0.3.32.tar.gz
  • Upload date:
  • Size: 478.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: maturin/1.12.2

File hashes

Hashes for cocoindex-0.3.32.tar.gz
Algorithm Hash digest
SHA256 93a97304830a1c02e3f6212e7eeccfeff28a0ecc18ebb5ad2a832cfba669cf08
MD5 c2db4acfa4b9cc930bc547c8861a3672
BLAKE2b-256 fa241ee0737e011391f0cc46ef38df4967cf414ce39f146b9732dd74e4dfcc4c

See more details on using hashes here.

File details

Details for the file cocoindex-0.3.32-cp314-cp314t-win_amd64.whl.

File metadata

File hashes

Hashes for cocoindex-0.3.32-cp314-cp314t-win_amd64.whl
Algorithm Hash digest
SHA256 7e13441bf1820ccac7ee4c22dd1f9eb55055c41f453bf49353cf04b920b2e7c6
MD5 bb0371b7e887713379ca7642af4a15bd
BLAKE2b-256 8a816e098aee721857d0b6b73738274ffbad454f74c176a84a62ed1fd21ce392

See more details on using hashes here.

File details

Details for the file cocoindex-0.3.32-cp314-cp314t-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for cocoindex-0.3.32-cp314-cp314t-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 8bf7ca6aa489193a4049046299704598f8c45b5158eef0502d1f0baa2cbb8602
MD5 c7871e486c31d7656afe4658928bfd8a
BLAKE2b-256 435a1eba30c76454028aa35f515b5893e61601ad053c1eff7b22e25556de512d

See more details on using hashes here.

File details

Details for the file cocoindex-0.3.32-cp314-cp314t-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for cocoindex-0.3.32-cp314-cp314t-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 f0919d4cc796c1bc7865a73c45eaecd19ca2344bd9487228eac1e1e0e256391a
MD5 a8f56e2bedc4766d9a685a85b1438042
BLAKE2b-256 e0bf729f143d4b0463267a70f9cad2a412313bffa0640e803b70821b17d0b3d3

See more details on using hashes here.

File details

Details for the file cocoindex-0.3.32-cp314-cp314t-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for cocoindex-0.3.32-cp314-cp314t-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a23142e9e583bd41c6bffe9db9e0f1be54159020e7b876414110c12f2dc99805
MD5 047c7db7ab7dadbba5198663202cf2f4
BLAKE2b-256 3d50852fb33b93bb88d59fc9b68d59666cca9ac9d1bb19818ba1c6cf6bf91fb0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.32-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 a9d8cbae8483ea99c8437440c54bdb3e37c36526aa532614199bc5503049f794
MD5 2dc98cad5a556ce8f1f9971efb8a207e
BLAKE2b-256 237ffca958fb397306c0888c4affdb58a2b6d54b4f40f98d43d35387d0884962

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.32-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 12eb68b5560afcb5b0173c7d02216b4d92fbf9c61a98b3cebe846c29e48589d1
MD5 9fa092b43b263594d939a011698ce2cc
BLAKE2b-256 47d9b3f0306d164b392e757749947f4f2fa504a6f5e0248bbbba982d10674d9e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.32-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 10cbd9892ed563c629c086753e377f04692c91d44abc0a751e83aeeea47a2f0c
MD5 6d59d41665188482ec7ad9d6a535134e
BLAKE2b-256 5a5e464ab897c0994780ace07d574e0b95ee87268dabbb5c176fa014b5e11064

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.32-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e1c1be6faa302799fa0c844b45abdf75874cdd429b6c51770b480ce9bef0afae
MD5 e2e41654f9183724da35b0a5def40e73
BLAKE2b-256 c2a03306fd36c565f49391efa62389a67c9a9208d1fddcff87d15ed53f12128d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.32-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 02185439b1819862872272ba9afc0e7a02c7ffcf21f2f33d2a4f3a37c5c144bf
MD5 9361597b69e5f86f28c88f4234fc67fd
BLAKE2b-256 2d3b928bb04ced0fa436e265c6852fc855e4169ed839aaad063439b8429c212c

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