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.

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

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

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.12-cp311-abi3-manylinux_2_28_x86_64.whl (17.0 MB view details)

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

cocoindex-0.2.12-cp311-abi3-manylinux_2_28_aarch64.whl (16.3 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.2.12-cp311-abi3-macosx_11_0_arm64.whl (16.1 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.12-cp311-abi3-macosx_10_12_x86_64.whl (16.7 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for cocoindex-0.2.12.tar.gz
Algorithm Hash digest
SHA256 6c60de2ad4e9131c3aaddb14e30b7e93c90991d97674839209648391e9d3864d
MD5 706dc75e90016ee105fa76cfa226b4a2
BLAKE2b-256 ce61cab96b74b0896272609c38d16c0fba3771ae98ef0935bef7d0926fae0b3f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.12-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 ba867dd1da0ad3560f2e6af72889af3ddf8046cf2981aad15fae1f70a531191c
MD5 0a4eadea09cfa94bef08abda91fde3c0
BLAKE2b-256 ef0782ed83e8ec5d0929bd1ac1184347f3f1d7c34456a987a6ab04435345c5c1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.12-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 706925ec7563ed405322204412684f0bf547635d08fe2b68afa652dd3ada2144
MD5 6f65c61591ab9e5a51bd7ca6f138c63b
BLAKE2b-256 a6c8d78e5c3016d71bd1b96fff3879ed35c40c77225d95b950cadeed22d4a826

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.12-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 f4db8d39a3abff57f7d15ff510421aada4eab5a9049aebb044adfe28825d8e69
MD5 88f843b513be3b92a7f02020a426a632
BLAKE2b-256 fa26a1ccaa0dbd87a25dcb86645d66cb55d1e85e3ece0b348c869f02fcb62019

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.12-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4e350e4b5a1b9a5055722b2780e7c3f1264e2be539ff0dcdac548aaf9c581232
MD5 b88ce2ff4bbeddc307203f00658e30e8
BLAKE2b-256 99f7088c91119d2efcb17ec2ec2dd737eb2000597314de036f4446a9614ccb38

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.12-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 bc4e8b92a720454c9f93211db694979243c1f61acc0fedaea945a85fd8ba2225
MD5 5ffb06a7772b6fc5fff26138afcf8242
BLAKE2b-256 6b2029f9d97d074667d2cb86e981c3f44a476d911a86ba407bd80b061c10fb43

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