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

This version

0.2.5

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.5.tar.gz (29.8 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.5-cp311-abi3-win_amd64.whl (16.0 MB view details)

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.5-cp311-abi3-manylinux_2_28_x86_64.whl (16.7 MB view details)

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

cocoindex-0.2.5-cp311-abi3-manylinux_2_28_aarch64.whl (16.1 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.2.5-cp311-abi3-macosx_11_0_arm64.whl (15.9 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.5-cp311-abi3-macosx_10_12_x86_64.whl (16.5 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: cocoindex-0.2.5.tar.gz
  • Upload date:
  • Size: 29.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: maturin/1.9.4

File hashes

Hashes for cocoindex-0.2.5.tar.gz
Algorithm Hash digest
SHA256 d913f78e35c17805e274099d491ded63eae8175c75ea5cb89ab54e4ed27b73eb
MD5 1cb24a7f7929d370aa59e6999f932e06
BLAKE2b-256 f51efe9bf1c40a434e4d1307de019ba7757b5e7db42073ac50d184a9c9fa7afe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.5-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 512ab978ddc595d8b5ab73d621051031bd4c0da2c91a2ad467ce11da5d9ee266
MD5 1968723e549f7b326b8062f9e48a20b3
BLAKE2b-256 ea546877667d6f547a47b78737602be842d1604a49f7c65f3285d01700ce812f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.5-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 5448422778b1600b54d134b2b332f1c2fa0afebc98bdcfe7b72403e5df9fefb5
MD5 7d37b7cfdddaa6fa2e864bec33fb3592
BLAKE2b-256 15899d0c541591463b41e0ee903dd03456e5d9c77007f03bd56c82f3510bf76d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.5-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 803fe45a2d522f12867e42f21edd66d702f8ae399eaed044ee8ad3a66c714fbd
MD5 6bb7d8019ffacd5c66613f00ea44e2d2
BLAKE2b-256 61a4486c30dd7c39cc56ee81ccfa1b06f41eb1f0d978a4bdea8526c983146ac0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.5-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 33162f972f7dd5f74b2194759a9acec486f84b1838b88db4774a208f6d118d3f
MD5 8a82c2d558aec50db81df3e7495396cc
BLAKE2b-256 c941857241fbaa857f080d93ebd6eddb695785f0f78edcd01c03f691090157da

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.5-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 4765413b2365d1785eacf57db30d141ca00824054e8db3aa8e7ac6a217da816d
MD5 939d3652080e2961dd26e32ad3590ac0
BLAKE2b-256 faefe22565dff8d33dba2e2d8dc7bb0936c7f607b8f562f6d9defcaa4bc61569

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