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
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

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.12.tar.gz (375.7 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.12-cp311-abi3-win_amd64.whl (18.1 MB view details)

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.3.12-cp311-abi3-manylinux_2_28_x86_64.whl (17.5 MB view details)

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

cocoindex-0.3.12-cp311-abi3-manylinux_2_28_aarch64.whl (17.0 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.3.12-cp311-abi3-macosx_11_0_arm64.whl (16.6 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.3.12-cp311-abi3-macosx_10_12_x86_64.whl (17.1 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for cocoindex-0.3.12.tar.gz
Algorithm Hash digest
SHA256 147ffc6cdfed4cda55d42e1a86f08d41c0313ef8f2b3b0f5e043505162db809f
MD5 e6fcefd54ba176b528a184a052bb2df9
BLAKE2b-256 a9fb0d6f071f86ad0497e619a208925f4ef0e8590370dbd0003695d5aefbc899

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.12-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 150f68b8528c2a7af430050e29fe5b3add3e8f565d4ab0912616380faea41a5f
MD5 669c7c35ccb03c8ece99c502cb4ef1dc
BLAKE2b-256 f708db4092ba7d0e24ff031d74b026dce0bb8e3546b306b8ad8f58a93ca72f85

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.12-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 3243f3c1442bec00f316371becc4b9636f58da7b5818a117d7e24d088f8b4de9
MD5 8aca91f37ad393e4b8609035490d882d
BLAKE2b-256 abdbcaae944b67e750d8decde48ba7370908e1ece01fbc90da27f99c1af6a86c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.12-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 72371f58a73bc876031584417c5482d9dc64014713c2d75ed1bae5459c5aa2c3
MD5 1e14f62740d6ee478cb213880ef2198e
BLAKE2b-256 a7948b717aefeca0ab09b7cca52bfd27c9351ac7b50f682eef168bd75691cbbe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.12-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1b1250073ee4bf91d743c4c7bbd6c59ff84b7dd549fab672c5742443aa6c82c5
MD5 cced1daea6799e706c391cb6e8f21d26
BLAKE2b-256 71e43d6a6a1aa75b78bd1b37378a1975ad3796f013b15c1ec6aaafaad3a57602

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.12-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 e85b699a10ee2ef477b09895dc6e44df1e1b2ad9f3b2a2d579e21b4dd36304eb
MD5 1f0b7d7f1975a4b26e74da79fa4a3dfe
BLAKE2b-256 63e3548a2bbd00db58bdbf9317e231eacd2efa73bdc0b91299098d258161c7a6

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