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.36.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.36-cp314-cp314t-win_amd64.whl (19.7 MB view details)

Uploaded CPython 3.14tWindows x86-64

cocoindex-0.3.36-cp314-cp314t-manylinux_2_28_x86_64.whl (19.1 MB view details)

Uploaded CPython 3.14tmanylinux: glibc 2.28+ x86-64

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

Uploaded CPython 3.14tmanylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.14tmacOS 11.0+ ARM64

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

Uploaded CPython 3.11+Windows x86-64

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

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.3.36-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.36.tar.gz.

File metadata

  • Download URL: cocoindex-0.3.36.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.36.tar.gz
Algorithm Hash digest
SHA256 2dd895e41abcd908038959e7c50905acdbee27279cdb24a2b2fd78e009d25ca5
MD5 600a0996096eebffb605a36f26532582
BLAKE2b-256 1adf800d401b623dfafec83232e3b9d6c2198e44f5f27d2eb1dbe9ec03502478

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.36-cp314-cp314t-win_amd64.whl
Algorithm Hash digest
SHA256 b58a3ffb91f46e944b961b6e32da49d431da4a56791fde3f4ee215022e5a2168
MD5 79b5313d6514b6bb5361020161fa78a4
BLAKE2b-256 9c744348efc06d520214783b9a7f63d5bb38cce40faff6e23ca6200b182925fc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.36-cp314-cp314t-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 03c651d1f0e0814d1ff558f38d89996508c365d5a5fd5109ddecf4cfeed309a1
MD5 36269f2d1ccc0241053b7e785c740ab3
BLAKE2b-256 c942952bea07cb1bddf0bf401ef5dac9629bb130fe5979585f036f95c408b1c1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.36-cp314-cp314t-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 fe0300c3755c07d65a73d1ecb599a29099a1b5f93af4351cb63f614aea241e25
MD5 c33a4b00267b8b594b972003ddd962c4
BLAKE2b-256 fbbdec30ee1c64e159a537752fad0510d23179b67b931a895edbd216905733ff

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.36-cp314-cp314t-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ba41bb975f927f4fe779a423dfc23c6fd35a478d82508a6f77aab54a71da3e3f
MD5 57790a079f76c8e5e74e8f095b06b99d
BLAKE2b-256 52526f4a58a796d02f120e7a1a2b3c7a9887ae9f4520831d338ab6c987a518e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.36-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 089adac8f8527aaeca20633a7a734910fa383761d5e8e823be19b45e8434fbd7
MD5 c5bdbf5430008c681dddceedc65f619c
BLAKE2b-256 ddf99ace15624578515e2eded004e5141d91fc26609e33b0a7bb54c8b2a8f295

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.36-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 e3d00a29649e2e4f13519b59c7fbf9bf30956cd298b532edf9e91d0150730cbc
MD5 099777660b36d0d5f947ae7829cab91e
BLAKE2b-256 2b15d213971a47a83a416fb8771f4bf293c95484904c0c0d8d2aeff7f1781621

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.36-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 2503731cce9a069149a5d417a6a53388d1197973abb01f49535048ca2fe6c8ae
MD5 f0c7b7062baafce20068772f7c6ad46e
BLAKE2b-256 d232fb8ff83f7b5c178f958b98b67a5bf4b3c5d25d5a9b3b57090c360ab64408

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.36-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c23ffcb8b8ff852c2d3cf44853e1b2b15fe6a1aafdf0a11c3f35070d4471c9ca
MD5 363ce8fd1447da2b566799649b5f5cae
BLAKE2b-256 c525537ae22f7a59c76cd11ce946b3a73ae06b30d5123fb7df950bcaf2fcae4c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.36-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 3eed5f626b8353500b0ad3524e59d7e02884ef64094bbd937807d377d6e6d14d
MD5 8f8ca62e64e134c66f29149411b121b9
BLAKE2b-256 ca7b2a433f8de17e4cb06596cb95c59c40d3baa12da73cbdd5802d1be5b5f81b

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