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 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 for RAG, creating knowledge graphs, 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
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

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.2.22.tar.gz (30.2 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

cocoindex-0.2.22-cp311-abi3-win_amd64.whl (17.0 MB view details)

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.22-cp311-abi3-manylinux_2_28_x86_64.whl (16.8 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ x86-64

cocoindex-0.2.22-cp311-abi3-manylinux_2_28_aarch64.whl (15.9 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.2.22-cp311-abi3-macosx_11_0_arm64.whl (15.8 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.22-cp311-abi3-macosx_10_12_x86_64.whl (16.4 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: cocoindex-0.2.22.tar.gz
  • Upload date:
  • Size: 30.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: maturin/1.9.6

File hashes

Hashes for cocoindex-0.2.22.tar.gz
Algorithm Hash digest
SHA256 6cd08082eab15e5d2d18aa09f91a62fec413d2709c6ad8e3e7cbf22e0ba29eea
MD5 cbc9e4c14ce6ca4fdad8fa49b58b698b
BLAKE2b-256 c16eb196fd681b412f8ddb9adfbbf66c3195109970921afc83a8013bb8a091a4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.22-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 6269c0c9db4bc46d3c0d015d25501679ed6c9c16a4aae9992ca185ef49d87997
MD5 5ce80b6e9554475b76cc5740586a752a
BLAKE2b-256 6667327a2469e2dd26d1b6be19a82dc5e655e521990af87a2aefecd5a3a3b00b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.22-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 7785d33211ce3a229e910a1dae809514697c7d72868b28130e47a55d91f7b935
MD5 5b1b429e1be7cc9df04efb292beb1a18
BLAKE2b-256 75af4b61868150bd3ec44fb6e304266cd39e83fb2b4d848dad5095eef7a50da1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.22-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 cdac973ec14467add881b1b08a3deff2d698f7df03702bebcafba41571867d1c
MD5 54c94af578a0254af21d5cfc77e25525
BLAKE2b-256 19ce91f6e7e1b5ef3fe9472b83f7278d165f83a4e918f0ab642cddff4b3e86a6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.22-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7c7bf762a426ce897d3b2dbd1c2c05a8f779d7924e84054337de88e5e6e7e371
MD5 3757085c3b0d69b9683e3606a8661346
BLAKE2b-256 b8e4c6c07f9176f41a45ad2f5649373aa995a94538d96547232cd9926babb263

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.22-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 0a0ed43a5a766f7612de77bcf3fad0b671a13d527d8916c0fd3228be274330e2
MD5 2898a5a5fc121dd37db213e8c0b102ad
BLAKE2b-256 a3213448e36d7f56c7f0bb24619c9fd1246e13d798aa720503dc1030f9ea5df9

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