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.34.tar.gz (482.1 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.34-cp314-cp314t-win_amd64.whl (19.7 MB view details)

Uploaded CPython 3.14tWindows x86-64

cocoindex-0.3.34-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.34-cp314-cp314t-manylinux_2_28_aarch64.whl (18.5 MB view details)

Uploaded CPython 3.14tmanylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.14tmacOS 11.0+ ARM64

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

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.3.34-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.34-cp311-abi3-manylinux_2_28_aarch64.whl (18.5 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.3.34-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.34.tar.gz.

File metadata

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

File hashes

Hashes for cocoindex-0.3.34.tar.gz
Algorithm Hash digest
SHA256 76549eb13285c8cf13e7afd745b2c4721245e47c742a210ff9800cc269a1e429
MD5 266b40974ade06d65b88b6886c62ca00
BLAKE2b-256 73875d6270771c36a91ad0b2c77f85143f706a5718ea8b5f6e080b1ff92ca9cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.34-cp314-cp314t-win_amd64.whl
Algorithm Hash digest
SHA256 a27cb7debe3cfd4b0b0e4be7298f91536527a4c9f3b3a863a31fa7bc9011c136
MD5 27a27d07d04814d668d2573dbdb19618
BLAKE2b-256 03db24851ebed18f71a6bf4d15fb5ef566d91c1555faffbe544610bf4868f017

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.34-cp314-cp314t-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 aa7905a0ff02108b358fe1d5419bf03c30e9f431d3fa63a2ec31ea85b1d10c22
MD5 de83303dcb0ccdbc9fbba330c6c9159a
BLAKE2b-256 c0e07ebcb68e8fcda8ace0d0f91d0cdfdd780a4f7e855118a9e7c5116bd8be79

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.34-cp314-cp314t-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 45af300b0e41f3f37f6e96e2bca47fcb9bd168eb5234f594970036b846ddc4f6
MD5 1bfa44702239f0e8812e48613280a293
BLAKE2b-256 32464de64e0c20d3ec0ca9ac27faab1b7c996cc5b085dea2918bdc7bc5b9c91b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.34-cp314-cp314t-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4d3654553336056615fe558a2c5ae0d54ddfbc61b1acfe88f355e1db8cac79e3
MD5 b525cb6d55049c0f8abb6c9fd921cd16
BLAKE2b-256 e8712cda84403a4c8c6ada59b8be9a4a0f12354776aac81008f60af66fd50282

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.34-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 31d9e18060d63753bcb840cb3fffb8775298a1fbe03c611674974f661956d853
MD5 9417ef1a108adba1a4946a7e5631dc7e
BLAKE2b-256 904c335fd76b75161b8858e5ee49685f66d4d1478a185ee85d073542902627b1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.34-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 346fa55c44d2f8a0e55489cdcbf6d93e4dcf8206784a1eb04277f4310c739e70
MD5 55b40ec1952a60b35ee962757996f986
BLAKE2b-256 d918a88207254adf7cb5c72f7559d2052b24eaf28cafd2eb13cb60272e2b8613

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.34-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 f9c9e56eb81cc66bc7fc83808e9d1392dd51fec62cc636f1cdf2546f1653d5ef
MD5 bee025b8235233e47f77893316af9e07
BLAKE2b-256 2c11bd660889a90afd4ec7c0f20d29134bbaaa575c1185c8c89b167b4824941c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.34-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0170d4b3215a916dfd6c09bef563ddba0a9bab35803cfbb3941fcf95f833d10b
MD5 242df0fd4376f919a2bdd559e92491af
BLAKE2b-256 506dc3cf1cbeb6b7f143ce437e51c71f97e8990ea05a4318bc460279558ed368

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.34-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d6a2c2d3c0a37f8057003355e3402e887cd5092d0ed918e6447c02a24fe7d557
MD5 e81b90f063888375016ac21f2cd65327
BLAKE2b-256 d634442eb5fe45e094185644fc945b309ee9b3a2d184b72d2cc26c899548d2d3

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