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

Uploaded CPython 3.11+Windows x86-64

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

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.16-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.16.tar.gz.

File metadata

  • Download URL: cocoindex-0.2.16.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.16.tar.gz
Algorithm Hash digest
SHA256 07780a2812c62f153393d360425e44ffb07c7d972d192a76127e1c80ab11e666
MD5 ca4815f539e622e05121ca4ae6dfeda9
BLAKE2b-256 2d4d11ea98f9bf9a7c065d1d6954bea0e0720cc44adcc62700232360d9a44585

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.16-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 7c2ec88ea534cbe2e3cc4d8584242e64193a3544b70b2320284a53d15c358dfb
MD5 8c3571b4b5efd11b1d446fffb01136c7
BLAKE2b-256 043a90568ea7f5d891953ea816f5c3fedcedb8825db69ea019b8562694c01656

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.16-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 b327e195ceb319c41992840a31e83496f8d3a1ab6329a4f67408456d06e34e74
MD5 5a3611a188cb3d02be946a9c5991253c
BLAKE2b-256 fe0249dd206b4903e480d527567a13f19bebbed0986d36b325257de418f92351

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.16-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 9bbbc7bdee17b6eb571695cbc88c6ef83fa3eaa00c5974fd01968cf554258d99
MD5 7f312a660c10ccc4d74f19617b239163
BLAKE2b-256 646dab4671b7aef26bf45afc0f15d4f0bccd655f95c8e7b68d3a76275ddc1336

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.16-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9d79712782e0bfc6cf4f428189dd3525deffbb8a5c9b95b201f98af81c9efebe
MD5 2fe0f0419d955aa6ebb4569962d84a23
BLAKE2b-256 533d05eb31846af68ad4e1a7f6f5f2c2c31763b57ddd3a0f5055e4affba62812

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.16-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 72d0274a02050951569bf508d31bc320997a4b30a3c22357512b394e211f3bf5
MD5 74ce46315ac62e0b1a70c1fda79683ad
BLAKE2b-256 0287c1fdde93caf5b65fc946b14da61b856d4490312b1e132610fd3868f42018

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