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

Uploaded CPython 3.14tWindows x86-64

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

Uploaded CPython 3.14tmanylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.14tmacOS 11.0+ ARM64

cocoindex-0.3.39-cp311-abi3-win_amd64.whl (19.8 MB view details)

Uploaded CPython 3.11+Windows x86-64

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

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.3.39-cp311-abi3-macosx_10_12_x86_64.whl (18.6 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for cocoindex-0.3.39.tar.gz
Algorithm Hash digest
SHA256 d181455a4b4b630b0647b09a61f338bb1316b4c7c76cd95c06671452900d3d60
MD5 f71f926e7beb763b7e1454640f6da457
BLAKE2b-256 3df186c67264bdac71b01219b0ec794df4d23366830344cf8e71fb69143a53ec

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.39-cp314-cp314t-win_amd64.whl
Algorithm Hash digest
SHA256 7191252d919e2aace0ca22bd06dafda7c5104b6ef996441c34589bc8742fc6e0
MD5 60870d5959f9864dd171617f4ed20ce2
BLAKE2b-256 033d8d7e4796e09a4d0917dfa153c04a15b367c0985d77a9504d1b6a258797d4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.39-cp314-cp314t-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 7fd95977543c2d15f73977131ebeec5d17172a504dc66b39bf552002bc41d1c0
MD5 7030d9e7adaafeafa4508d6b821cae63
BLAKE2b-256 4a57667d66ae8487c782515830456e21702a1949a6488f84cb3eea2ef4c185a9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.39-cp314-cp314t-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 734f8d061ef706e71ff8e8bc967db3417e76fbbf29b04cfee9f0c58c0f1213c4
MD5 c51d313bb0e8889d1ed925f149a0b2b9
BLAKE2b-256 dbaedf4d8b45ab745a7246d222ec96b5562d20fa5e3604a569bb1266ea176fdf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.39-cp314-cp314t-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 fd0478c825811435c82061fa665c123c92030a2ed9175ea37959efe712c0a3d7
MD5 a06fa664848634c1fc1f5eeed8d97e85
BLAKE2b-256 0997f7dc172993f828ad1b58c49506647a89b37d687ec814f5c822ce70828ee1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.39-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 63c2f994d8a88b28ae545c8ceded9a979e807eb92d8146a1119b8001b6db946b
MD5 2cce3899a6bf6ec6dc0ddfbc2dfe70a5
BLAKE2b-256 30282ab9492751ad96ff791718f359e2bd2ec0a3b64dc59113fa350cc0d5b2e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.39-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 8beb4c1b813fed13ca080b1501d216cb3e068052ec6683fb96c5fd942b7eddac
MD5 9b85a961302f9305008f671d87207f89
BLAKE2b-256 98d5c06d4a7e3ec4b5f0927a91d31e1f8a22f9159b9b403ffb2760187e1de174

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.39-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 21919b5f533fb016658513b2a56833bcd5ff79a96f6cc7773023fa3c20adb647
MD5 753f693dfbf67e798d10374c15a473f1
BLAKE2b-256 d6e0bd64490bf65305aa24975fdd0b1bddc09b6318efdf577519c6833b54b2c6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.39-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4f31007dab37832109366aac08c684607de9d3a45d94bb68f43385b3dd3e4e92
MD5 254c39a3715513f563efad7449af0b02
BLAKE2b-256 2f7bc057b9ce5715e2c83386b74a94a08cf2e3173bdc1a5aae7d450754290c02

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.39-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 09590476d9a826d2e1bd8cd31ed5241ee8044deb8e418cc53bc014194511ea39
MD5 8094215642c19492e2ffee84cc77f22a
BLAKE2b-256 eba1c851740b1ab8e5faf9bf82ab8b2d2d6e3628b8d6055b8d1c18d9111e849c

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