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

This version

0.3.3

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.3.tar.gz (30.4 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.3.3-cp311-abi3-win_amd64.whl (17.2 MB view details)

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.3.3-cp311-abi3-manylinux_2_28_x86_64.whl (16.9 MB view details)

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

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

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.3.3-cp311-abi3-macosx_11_0_arm64.whl (15.9 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.3.3-cp311-abi3-macosx_10_12_x86_64.whl (16.5 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for cocoindex-0.3.3.tar.gz
Algorithm Hash digest
SHA256 db2e7c4a46c807efab63b569e73c0dd451fc312fc031e57f89d5c7313c784b0e
MD5 f245eae0fdfefdb7ab51286367133009
BLAKE2b-256 ca94290d25350bb6f7904b0bc974329d7a425d14bd807c1cc8436c447881d843

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.3-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 a1594083104f69adc2cdd43fbb721a5e35f9f0767773a3055eb4bd43c0e68901
MD5 06f3896346afabfa5c8571f66005b848
BLAKE2b-256 9b831b6cc13affd9681ced2c920f0ed8cc9b7e02c75a50cd0b9bf583ac45c812

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.3-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a8c61106ad710c335541f52da84daa377fdba7772da21d59f3d0880470c13cf3
MD5 5776faf1505c214677837519ea5eaa51
BLAKE2b-256 fec7b356867349a37673b2c816b11e9a6bb253daeb78a137fe623814286aca77

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.3-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 c0172e3ed6f0704896b5eec920d4c9db63edfb818eb1a36e30b750bed403b221
MD5 0f02080a471e78b1b382c15b2291e645
BLAKE2b-256 887dde98775538f87e83e77150907a0ddd171e153040a7f1bf167b001c5770bc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.3-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 8e188d0fc81871a85c5dafb6c9ff48effad884e59356d8f054bfcc74faed24c0
MD5 74c0718ac7de36c4932bf3687b4ab96d
BLAKE2b-256 8e22b9ece108ac12ab956b55208a19daa42f35bb109d8552e9018ed55e1a5b64

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.3-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 27345d7f126d8ad1d97c9bcbf1848f59d4536b39e73c48b441810a4d29c5d48a
MD5 3f240eab9d65ba0826d673a922ffe097
BLAKE2b-256 85562d4a81ec440f80599688093e57291ce5a34ac2a03e5e64b3c18f10a38434

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