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
PDF Elements Embedding Extract text and images from PDFs; embed text with SentenceTransformers and images with CLIP; store in Qdrant for multimodal 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.21.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.21-cp311-abi3-win_amd64.whl (16.8 MB view details)

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.21-cp311-abi3-manylinux_2_28_x86_64.whl (16.6 MB view details)

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

cocoindex-0.2.21-cp311-abi3-manylinux_2_28_aarch64.whl (15.7 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.2.21-cp311-abi3-macosx_11_0_arm64.whl (15.6 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.21-cp311-abi3-macosx_10_12_x86_64.whl (16.2 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: cocoindex-0.2.21.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.21.tar.gz
Algorithm Hash digest
SHA256 7ef09883072a86b44731dcebc47717381804529cb0f85c93e14c740301aef6c0
MD5 d54a6e52d302b9f4a29c39ceea3890f4
BLAKE2b-256 f7ddf1b4116b3876ab024e42ef614cb4a61cb3d85be7ee47f583b8ffc8bf0c61

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.21-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 87620ccd48487ed2a0ce4a38a5a58aeaa3c8c280763fdc4bdab48de7d359670a
MD5 95c3711ecc631022732bd32457763dcc
BLAKE2b-256 261238a0b80723d841b6e83884e9d79fa0617e5de5f447c61b01d2f7011640b6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.21-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 76f442c9ccccd8517132eefdef4afe28af3397281c5c9be7f685b63be864d105
MD5 51d4c4a18e80c19281bcd29659ef7f69
BLAKE2b-256 aaef8e870d800ca393367aadbdc725ed6a15a9852e0c8b0443880aa35dbf8e4b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.21-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 516225bc96a3e25e3bf8972f14a06b3d9fe15abb63ccfa224c2c27d83a95089d
MD5 50820885cfe4ad696dd7cf64895c772b
BLAKE2b-256 1e45ec951fe1325aa16814c04b6beccd0a6fed9e25911bb8351593a9f4b729e5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.21-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9c7674dbcf5e3c91e61bf71ee4b3eaea9c1dafe0d8417d6268b534896b2f77e4
MD5 eeef3183814c84ddf662785cb854680d
BLAKE2b-256 7f88e1c4766411ea3adfd532aa4f4f053d30e49ce359ae520db3fbf06d12e41c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.21-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 cc41c1cb37c71854d5db31ea62c61d4d253fa37984fe5f536e24a1863cda4578
MD5 3872f931b7ea81b782b4c9a8087d5ae6
BLAKE2b-256 2262f34e2832fdfd4d3b7f331e527b0337a0dd62f8dc8ac1718ad6f7489fac03

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