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

Uploaded CPython 3.14tWindows x86-64

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

Uploaded CPython 3.14tmanylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.14tmacOS 11.0+ ARM64

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

Uploaded CPython 3.11+Windows x86-64

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

Uploaded CPython 3.11+macOS 11.0+ ARM64

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

Uploaded CPython 3.11+macOS 10.12+ x86-64

cocoindex-0.3.35-cp310-cp310-manylinux_2_28_x86_64.whl (19.2 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.28+ x86-64

cocoindex-0.3.35-cp310-cp310-manylinux_2_28_aarch64.whl (18.5 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.28+ ARM64

File details

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

File metadata

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

File hashes

Hashes for cocoindex-0.3.35.tar.gz
Algorithm Hash digest
SHA256 884b5400adf6beab951a505b5ca3e8ca961222bc3a6eb4cd4c8d0b44e81ee7fe
MD5 0a7c0576d7b32e7b98cab2e043fc49ba
BLAKE2b-256 b57d393f1818805cd905ff36fcae39bc8d0ed92e8118602084d1f2cc05aefa05

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.35-cp314-cp314t-win_amd64.whl
Algorithm Hash digest
SHA256 810c1a63cee27d30501262f36d4f512a2b3ed39c94f53253570b02c0a2d98cb4
MD5 13387a59ea88bd6a647adef9c923ad85
BLAKE2b-256 843fb122d0b14c4307033766bf6e315b94859819e5074843c5c04f90eb7e9ff6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.35-cp314-cp314t-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 6aba689c02a53516fbbe302291948b59aa36f24fad5eb1d0f79d00fc5850cbd4
MD5 24a640250cca200cb45d58d22394e2c0
BLAKE2b-256 c8feffec80778f3abad7a905f67495c00f60b72719963184634acb9fbeaaf339

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.35-cp314-cp314t-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 7bb2bf440ff695c9c5c6685b24727300f54f73da2c94ebed00ed184f26b82bc5
MD5 159acf4d4a478428c448055265ab77a2
BLAKE2b-256 54aea0879d157429e0a52d2004a4f83421d089b3553fc5bf0c6704c1b32ca6b3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.35-cp314-cp314t-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3ddda1cf3996e7df98c76ffac593b041be59303daf96b13a039e9ce51db732e0
MD5 4bb47e5e9d26239960bf48bc6d1088ed
BLAKE2b-256 fd3520a73687c06e4d682e05538b96ab4fe3a6b2b334b9b24716468718c56a0d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.35-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 5973527c9991af6ddf24a9fd68cfc121c0adffcb58f997b317c68a0c9bb945ff
MD5 5a8910d4a5f55b4259258fec6d78a34e
BLAKE2b-256 614b620860c851a8ddbc6f977d37806f9d6d8ef51b0679b735fc2fcb35ac8910

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.35-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 8067c15c2fc0e5c556a98943882ae58e2b66a4da91f2427e81dae4c067a6fa06
MD5 8ba2ca77f9e263bb8f2f4500f990ce34
BLAKE2b-256 071f8821748001bb7b0c4987b9f40186c6206a0ae4d60f1bb68bd0718f7f1be2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.35-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 e593a8ec3de3bc0fd3fd7c9f98396d937922a3778834fb38058a766beae361f0
MD5 012dac700bbaec0bf6187c8cca130444
BLAKE2b-256 3a3515069ca8ce7e66f5192aa6ffc2ddb3694721c4196190e8c059e3899f26b9

See more details on using hashes here.

File details

Details for the file cocoindex-0.3.35-cp310-cp310-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for cocoindex-0.3.35-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 ce1ef4a72d7ca3ac151a3119c497268ff07a24c361a5dff8e65eb3f7c81b9328
MD5 2798d976423c7191e165b7e44f36ec3b
BLAKE2b-256 9328fc4537ef9c01ef8b3c2d178eb477c9677d06a923ebcdb7d89ec39949989b

See more details on using hashes here.

File details

Details for the file cocoindex-0.3.35-cp310-cp310-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for cocoindex-0.3.35-cp310-cp310-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 a25a790894b9e806fb6b48f0337a6ebe9754881cba5fef5bab1ce09865cd6671
MD5 7961734be7f098c8ac0aaa26eaf6e3ce
BLAKE2b-256 288bc430aa34aa9db53e72fddfc4e1907e948f9c28d9cabd78b9725100bd227d

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