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

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.20-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.20-cp311-abi3-manylinux_2_28_aarch64.whl (16.8 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.20-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.20.tar.gz.

File metadata

  • Download URL: cocoindex-0.2.20.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.20.tar.gz
Algorithm Hash digest
SHA256 f78dae4fa502d14baa95bfef012e3c590eaa7c99be95dd785ce8cac8c9c6346a
MD5 4e8325179d44cbe0aa80788c0a68c66f
BLAKE2b-256 62e65cbc4e3193353799e32bf4fd65f305e9c8e0d66f6f61f665ef22a0608f53

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.20-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 277969b415a80333846f79ebc7d2ccd0a354fe6c86b80407ed2b9c969ca7b60f
MD5 abe0316b2634675378a3e13239f58da8
BLAKE2b-256 3617365f22c670c49c5cd30e150325d37f1fce61798ff6a3fc7dfaa5e25ffcea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.20-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a3ea79023dc6c3d585e0caa4d2f40665b20407b39c1c005a2c47a316e59225f8
MD5 d5419b2b801ca010aee9d82d61e10eea
BLAKE2b-256 c9496cea89db2fc1568e9f21c08b3df2a0bae1e2a07a45a3975a0caadc9cef4d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.20-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 e18f289f6b0cf7fdf96eada04180765edd52e808793e85828953528a27695e87
MD5 a9193b1579e5ade950f895deb22aded8
BLAKE2b-256 a0256622e786ee3fabb3b742c9e763966e85018e7dce97a92c51363e5fc88179

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.20-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 5fbf1c4aa707b80c4b23d506b3148bd394d5dc63774884ea76bba933cd6c2164
MD5 7bcc13c7a6c5e9cf5b38578fd89956c8
BLAKE2b-256 08e13dd0482d1e7c4a5c820e96a0b3b675fde207c56dce92f4a9e778bc806c3a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.20-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 891bd8957a2d0744604b4ee6ec897c0414e36a75777576f386d1d434346f7726
MD5 0456399aa25b20480a6c5549f453b06f
BLAKE2b-256 ed5a92b7617a2d0fed402b534991ba5e7d87aa9cb35bc2486e5852f7c0f475a0

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