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

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.14-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.14-cp311-abi3-manylinux_2_28_aarch64.whl (16.4 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.2.14-cp311-abi3-macosx_11_0_arm64.whl (16.2 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.14-cp311-abi3-macosx_10_12_x86_64.whl (16.8 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: cocoindex-0.2.14.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.14.tar.gz
Algorithm Hash digest
SHA256 6057f359701a404ff191315d8c64cbd58ba5a9a4fbe03c957de3939bb6c5de67
MD5 88bca871e8c862f2c8392da8c0b405aa
BLAKE2b-256 dff0d0a8274e4090f9dffae04f0e9a0ef3494e8f870dc64b04d7ada9092ffb0b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.14-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 6ea8c29c55ff62d54b66910c44205ab4b1b7310f8f4a6a417c2f401986392122
MD5 6d319e57a94494c869d394f9ff4159e9
BLAKE2b-256 7ee8b56e412a374a8806bb45119e3c095c8aaa1995ceca05b9327a33f8f59ff9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.14-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 418836947b18533e96e988a57c38f4323bbadb4fbe6c3dd88a6560dba7f0eec3
MD5 b427123a8fe739d975d4c825fc3c849c
BLAKE2b-256 be4c272c987d7bf5124be5ea60086d351ae56f684daf32d6278505fb16e4f74c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.14-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 d91953de986f660455eaa53b0ff96429165bb0d2bcd99677efc47bb591b64cc6
MD5 71044cc55b9354d183412af83ca05a32
BLAKE2b-256 5bbc0c0eb7bb577291fa776732a7daee6debabce4b94d12549e00611e6cf97ab

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.14-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4729cd4729d435363f11dd2161af4c825f974c04ae991e17f490a850df2c8d1f
MD5 2fab621a6926f817f40b800efdc0adc0
BLAKE2b-256 2e731c62313715c93e901f60880c6fa08dd4993b7b1da0bb62e0f6e332630647

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.14-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 1810caf6e4cf5c0127d1637cb163c0a9f611247a469b42d7daad3c35afb4676f
MD5 7f5abe8345a7082591762682b5bd707d
BLAKE2b-256 5ee2907115af2bcba6ec113b8e551049d0e1ba67f245413fc9c2236ffa2a83a4

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