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.15.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.15-cp311-abi3-win_amd64.whl (16.3 MB view details)

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.15-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.15-cp311-abi3-manylinux_2_28_aarch64.whl (16.4 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.2.15-cp311-abi3-macosx_11_0_arm64.whl (16.2 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.15-cp311-abi3-macosx_10_12_x86_64.whl (16.8 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: cocoindex-0.2.15.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.15.tar.gz
Algorithm Hash digest
SHA256 d0afd3b7cb1dc5f08b1333c955ee02446be885c327acff3ecb309e463ecc359c
MD5 c4aa23777feaf594143e7dba5c0ea2cd
BLAKE2b-256 3880eef1624ce93c0fd4175554908bd928d128dac0f41f4352926a73257db602

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.15-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 56005aae33dfd4941800f3262d1bf01cad488f56f37add7e2a830ad4ae46b138
MD5 a59ef2b18524e621469430faa50b608b
BLAKE2b-256 2fbc561e1fa2f303684127ef3ab94158c0de12d70e7aa2d2d8eb8e44351bb6eb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.15-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 1172719b4e1da92f12100e8bf3e0376a708cf731d24012437d2a45954adafafa
MD5 af2bfc57521b6ebd23db0f599c6e5658
BLAKE2b-256 eb907e777b6776abaea5952d2cf5c8ac9c84c06fbe9a9a13c887c7589b610b39

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.15-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 8170119c7f840b54486ed3752032bd09377de874502ff7467de89bb5d288d45b
MD5 5cbade9eb79f27bfa2a04a17093ef1db
BLAKE2b-256 03cb031ee02ef436f0da543b9c2f8588bb38b80a61d0153b1e3aeb05de100aaa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.15-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 bd911f97f2cd506108aab5b6a89d0a936c53316428f29b33c5ac60560e6f0e2f
MD5 87a40bcc3ec0972ddc7f070f68de1497
BLAKE2b-256 98c06a1bea57e80c9e1bad509769c3a4680778e6f64a9143f6e33c4a075721ee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.15-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 e9586c06ffdc92ae2cfedf3094fca57c9e31a6d80868055133b943bcec1f5014
MD5 dbc75fa787de93a5cef1b69175704eab
BLAKE2b-256 9a778b86f56c15f9ef2f6fea0df55d594f669dfe260bc85d6dccbdd9fba2dab7

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