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

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.10-cp311-abi3-manylinux_2_28_x86_64.whl (16.9 MB view details)

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

cocoindex-0.2.10-cp311-abi3-manylinux_2_28_aarch64.whl (16.3 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.10-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.10.tar.gz.

File metadata

  • Download URL: cocoindex-0.2.10.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.10.tar.gz
Algorithm Hash digest
SHA256 b5df9f7916d0daf6a3441b907311549f474383fb3de1b9fca3990f959d32e3e7
MD5 a878391628ce31c8e60fdd0ab7b647d7
BLAKE2b-256 d57f900233c9bd3e9a6784ac43d958f8e399f22240c560b91d2d6ab3cdbc413e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.10-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 d2554b1e8b067919fd704ce6af6f2cdd5eb298b97f68e25bf50e7a0cedf40e29
MD5 b96fb16b3df1f53350f6f83a75760347
BLAKE2b-256 dd5b7a860c75944a22ac3367c807b7f5e5c7f3beb7c220d033ef3fb7f9afd3b6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.10-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 17a66a4b6e560935fda807659fcba8466bfcbf845f4363542aa93403730e08e1
MD5 fc86dd2a1e3f6d129ff93c8b8d7d924c
BLAKE2b-256 0c1126823a05e72e40872675336dc71f0da8fe98b9b38b8b530a514228112efd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.10-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 b0c25f0e1bb767073b599daa019c3ded384c7e2c0d208aba754231be73767cf9
MD5 8df2cc336a4636a46fb371fbc0a17043
BLAKE2b-256 32f73e6f0cc8c140397f07ed3ca24be2bf03a67e408261be6a8789189a411020

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.10-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b5f2a8c75dc939db977ee41c7b3ce5dd4e067590a72a603e624bb40ca8ca2395
MD5 9a1c39f8c494dff537bcda842a0b468f
BLAKE2b-256 d882d7e904cde5cbd73b6b1b0679d0631fcadc77e98f8ebf5578055d81d81f75

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.10-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 946fdf99a00ee55c9c0a6f25f13b558323814bc3316d1ea04bfb08f6493d0b33
MD5 1b03dcb3e55ccfb977ab6f82732a5736
BLAKE2b-256 65b429fc1acac57bdf2484ca6beca9da08957c567f6a8e76035ccb4e65541acf

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