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

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.11-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.11-cp311-abi3-manylinux_2_28_aarch64.whl (16.3 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.11-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.11.tar.gz.

File metadata

  • Download URL: cocoindex-0.2.11.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.11.tar.gz
Algorithm Hash digest
SHA256 6cb3822c657135f11d03fcf7ec2fde80892e63b6c1dbac6ae908d901b4f1af79
MD5 f4c2af8137a6870b25b131f4444ec661
BLAKE2b-256 ee3dc576a7b581e950663ab75061204eaada53824ef3cc5d509ea08905a768d6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.11-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 7210c7d91bf0e8ed727d99f334f0f564dce0990c33cd4eba5519a52a5936b469
MD5 05874c6bf1c8b3cf9e8907fd707899f0
BLAKE2b-256 23f3e92c7f41c7db3c880d5f27402ded52dabea99003ada58051f00337e1ab33

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.11-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 fbd5a60b46125ddd6872f39d9aab03d047909d38caf8f6f7261826e7a6dd6b4a
MD5 b082fa1d98ad795e22b245c16541b584
BLAKE2b-256 23c55276708cb573251b7d0ec304ce047651a571a2e150535d5ca9bacc08097c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.11-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 bfc41b36fb899ca6d288a6e7afeb1bcc78acc060f7cd322953566c373d18e431
MD5 8e4a0f1966cf8d7d684d479c1b6c40a3
BLAKE2b-256 4bb40d7b3e58c1662fcee21f9490e10e16e57f186adcb6919a32d71ce4427a15

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.11-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 bc25ac9e0f4f8362fedf430982569c274f3b574bdd2cfb23029374f25b96c4ea
MD5 97ede65999d7d6a8f7b9f6b63d0b74a2
BLAKE2b-256 1fbdf39bce0e6fb8035fc4b50a3b8fe6a96e9c1731a568ea26d419638c7fe895

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.11-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 5f427e7d5290985160c6b1554c9c2bb7c789deab3b82f0e2bcf812302751531d
MD5 078257e3cdd8b4f9675a6d2bf0218481
BLAKE2b-256 98857672445eccb603d8ed2c90749a6adec949a46199a45f86a395ae97714617

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