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

Uploaded CPython 3.14tWindows x86-64

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

Uploaded CPython 3.14tmanylinux: glibc 2.28+ ARM64

cocoindex-0.3.33-cp314-cp314t-macosx_11_0_arm64.whl (18.0 MB view details)

Uploaded CPython 3.14tmacOS 11.0+ ARM64

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

Uploaded CPython 3.11+Windows x86-64

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

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.3.33-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.33.tar.gz.

File metadata

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

File hashes

Hashes for cocoindex-0.3.33.tar.gz
Algorithm Hash digest
SHA256 da9afe94d2ddbbd51bfc027f55bf8dd7ddc2c2bcb469b3028a0f3cf0d94cb2c0
MD5 a971eaba295b048d8bee5faf2acbd0ae
BLAKE2b-256 485d5bbf14f58931e916887f3f95b825f826b593533b4669da15c1c229f06a06

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.33-cp314-cp314t-win_amd64.whl
Algorithm Hash digest
SHA256 a8b08f1fb28353519eaeee8fd522b51bfd1f9dff0dd223c17f81f32d7a9e8002
MD5 c0971ef3914f36327afd403c4aebb3fd
BLAKE2b-256 b97e29dfcef6963e3c32cd6d6d213096731bd97139f32b660dd609c48591a469

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.33-cp314-cp314t-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 1d0a237f22b680b8e325fd3697a64c938c88edfa1ea54d3e34d010b53c3f2482
MD5 65138dde6d4958dc72520dd7ac607ebd
BLAKE2b-256 4df1ca8e74b166da1dc6e9b0464e88325288ae9befea7b4c2881fa298cda2c18

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.33-cp314-cp314t-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 3e5496dfab6e3a7fa7b68e8d0ff4bf102bd7842f9c10c278793be895b98423aa
MD5 02af0adf6b2147b28c85e4d740486d12
BLAKE2b-256 9356f507bba387aacbce20c4d0530b3378387044f810280dbd696597c73c3147

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.33-cp314-cp314t-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4affb73feb0335427bebe4f5d723045aceba6aa6b426ba289a1150c173ae9ef1
MD5 1dc0e3ba47fdaa12e6cdfb9709594e4a
BLAKE2b-256 080a73e1c988f97a50e82c69da1a25d2baa1f157a3cc05bb5a3b7a4eac4a77d2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.33-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 4d05b0fa8c1e819eef9976df1b49a78f6219177f12f491cd6745c2e8a7befd94
MD5 93c924ef83dc4bbb7ac8ce9d6077f132
BLAKE2b-256 de4e9f599705fa6a2438e841ea73c58724d8b7461d7db567651aa977fd89ba30

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.33-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 87e9553e6090b16bea9805f0d337c700d9959cc86452ec87ed673806afc6ae0d
MD5 3e7c8037cad818e3e4d1d022a4ec4061
BLAKE2b-256 0bff8e99f0556488434a8c97344dfb376d625632450d04135825a81aa65c4917

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.33-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 982cc3a47cdf53b2bc95c86abbbd6fabda385e55a5e482329ab3a1be1c1a1e9e
MD5 f167bb0c223293c75f0089b3d3583e6c
BLAKE2b-256 1e2bfa68a8c26b74a15d34d85a2974d425286aaaece4558502f8bcc13e12a2cf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.33-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d238b261195538fac467ca3d9ae47c74f915129fe9c5f6684b55039bd08f89a2
MD5 fa0f4bf343d2d4d4b366f997421b8d9a
BLAKE2b-256 174fb060da5cee4a67462c480c8d0d84385507e9a61c8b8180f54592c2a887a6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.33-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 a2e23beb18316b63a0148e2fcd9a8f76350f50e85f937d7bf1d9faecbef079a0
MD5 bf48ddcfc10f9c0dbe7a7139a7d37ec8
BLAKE2b-256 bfe5ec9715cbd9a98983721d22918562be8088c0ecc0277bad8247353dde709a

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