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
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 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.19.tar.gz (30.0 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.19-cp311-abi3-win_amd64.whl (16.7 MB view details)

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.19-cp311-abi3-manylinux_2_28_x86_64.whl (17.4 MB view details)

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

cocoindex-0.2.19-cp311-abi3-manylinux_2_28_aarch64.whl (16.8 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.19-cp311-abi3-macosx_10_12_x86_64.whl (17.2 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for cocoindex-0.2.19.tar.gz
Algorithm Hash digest
SHA256 49e3a713b83676f9b7d080db32b94202d1d36ca2321117eb55d144af4bdc273c
MD5 e7225f6bea574a4ff0f761cef603dab0
BLAKE2b-256 089591b58cbbd6ad89f6cc6c06b636afb4ab37b429f2cb679716a8b8ed10f09c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.19-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 c8fbaa263760b1bf4aad9905ffca09fdad73e85233d590f4dde61fddab414254
MD5 28b9c41367509df75b85e1ed3540bc75
BLAKE2b-256 b469a59044a9dfd74080eea8698e3a34ba5bcc8ca25c9a84657d90fcd6ea1230

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.19-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 65dc2919952bbc716f654805384af0b5a9160670ee4cb42a48d1bbe4bc4cc250
MD5 f263a8846fd5c71fee12df3cef246d5b
BLAKE2b-256 fa6a1b4754a5267475c02d11c70393eb3a037bdd43c630325c232be95ce38714

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.19-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 2570bb09b50e36a30d62bd808671e1ea2eb4783aa165938c943c5d834f3308ef
MD5 83eef0c9c65ffb3789d77f6cc3d142d4
BLAKE2b-256 db95801a4f5dbceaa48283ec53f0f2e929c21d0fb65d4e44e4d017a465554984

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.19-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 50d2a1762110c33caa988090c099ed2cb8e2c880010f2030ab1fb93ec07746e4
MD5 d84bb4a39e247f1c70e587986159aaa4
BLAKE2b-256 23fca9628165ce55b707e8fe27e2efa7953fad5a61eab4e33e393ba4c5ed57fa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.19-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 00c3b71128647fd3ba5a40902807518025e5eade67077b3c2676425578817518
MD5 f30f9b2cc1dbccb4bc4b12f6495c69b5
BLAKE2b-256 83eb971d9a3b50c1fccf2061f6388e46459d140c47be12b09c5c8eee3de9b29e

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