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.30.tar.gz (444.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.30-cp314-cp314t-win_amd64.whl (19.4 MB view details)

Uploaded CPython 3.14tWindows x86-64

cocoindex-0.3.30-cp314-cp314t-manylinux_2_28_x86_64.whl (18.9 MB view details)

Uploaded CPython 3.14tmanylinux: glibc 2.28+ x86-64

cocoindex-0.3.30-cp314-cp314t-manylinux_2_28_aarch64.whl (18.2 MB view details)

Uploaded CPython 3.14tmanylinux: glibc 2.28+ ARM64

cocoindex-0.3.30-cp314-cp314t-macosx_11_0_arm64.whl (17.7 MB view details)

Uploaded CPython 3.14tmacOS 11.0+ ARM64

cocoindex-0.3.30-cp311-abi3-win_amd64.whl (19.5 MB view details)

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.3.30-cp311-abi3-manylinux_2_28_x86_64.whl (18.9 MB view details)

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

cocoindex-0.3.30-cp311-abi3-manylinux_2_28_aarch64.whl (18.2 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.3.30-cp311-abi3-macosx_11_0_arm64.whl (17.7 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.3.30-cp311-abi3-macosx_10_12_x86_64.whl (18.4 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for cocoindex-0.3.30.tar.gz
Algorithm Hash digest
SHA256 1ea801143c8bc08e43ae38a465ffd4dd5826afaa8c10c83a2baaac4d0416477b
MD5 78990274cd357f9d3cd1ff9db0721eff
BLAKE2b-256 acaa17dd31617513022b06d6cc88e32298fa4900cfdb8c3162cb7c200dda97e2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.30-cp314-cp314t-win_amd64.whl
Algorithm Hash digest
SHA256 a4f2939f9687481bfcc8cedbc466ba0f23a28c0bba92b6fad06cf11f91762720
MD5 faf662c68efe65c6299cf2e39a31aca8
BLAKE2b-256 cf31efdfce1ba006437e99be3cc3d1928d684feafa89b728d429b6524c3a0d78

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.30-cp314-cp314t-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 089001be6256b2bd86cac835c67c33d47988d71e957c977e95eef0a0d8e9301c
MD5 5afdb4d51e0b1574ed5a4066cc24cc51
BLAKE2b-256 1be9878318cf0e378edde6eb9ea56e496cccecba3e8764aade57082309587737

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.30-cp314-cp314t-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 b4f0137d9d4f1885b6d219412e18a361645d44c350580e2c1eac2854eb95a9a8
MD5 c0e194a34ae98c9103948600bb23e9c4
BLAKE2b-256 a55c0e10327db7c6d39e236dfd763f3a7ef2eae8882904b1187bf5dc0c474e7e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.30-cp314-cp314t-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 006e9c136f1370fb7c6e85820684527a00247bbf54af237b97f453156cace066
MD5 47a7afc72738725791a123976a1e7aa2
BLAKE2b-256 936400be49f2d0c7a6bff2b023789e816b2a81e670dddf3c99fec39069703df2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.30-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 02a8cf73dbcdf2d005c21cb3425911cfd4a36870660e5309344d55207688cd93
MD5 07f040f1a11753165a85195c32480ead
BLAKE2b-256 ec3094a0b632e7ef0512e4f8f41abeb85f0601735236e0b3ac7f38ac5a91e0b0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.30-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 771c8b6bbc71b3e167054c2e1d6209814b174da743e6867dbce060699bbd74e7
MD5 8e163d3256e250b2f34ec1614569ce35
BLAKE2b-256 20f4b937a1fd83e47196ff8c30f38041807b0056188d640419804b4f916b526f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.30-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 71232e2f9c427e1bd065cfe770086260646688765d5a9c6b13236239d1c667f8
MD5 2c5effb5e5af6c89689ffb4e55444605
BLAKE2b-256 4b493b5563aeef31c4f2991dc6ba1bb9533577e0fcbde757a9f8b1c67c3bcfdc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.30-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 944157e0b7027cf8e27a8ae544f424547da32fa87a7cbb07f320dd5ce9e2fcdc
MD5 a7b3d4959d5875b717b34a58b2396aad
BLAKE2b-256 bc6db94d4a70726283e0cc3dfc422a8f7fedce11b00615311e1d1f79f1de82a4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.30-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 ca39f225e23520afc89e46d775e39c2dd3e3167bc29cb96edc6121c88fb181cd
MD5 169579b4c7884ac08f8ca363338993bd
BLAKE2b-256 62470ff4a9b588363ee3ec92a38c482365be48368ee069c0e16e8b12145d046c

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