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

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.9-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.9-cp311-abi3-manylinux_2_28_aarch64.whl (16.2 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.2.9-cp311-abi3-macosx_11_0_arm64.whl (16.0 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.9-cp311-abi3-macosx_10_12_x86_64.whl (16.6 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: cocoindex-0.2.9.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.9.tar.gz
Algorithm Hash digest
SHA256 6bdedba4b6560a35a9e2d73ba39654331f2c6bc5365e9228603e60cf14067afe
MD5 0f7086296d08599bee4f13ecf38e080d
BLAKE2b-256 f2b2e1e4d948ad01b870481fae5db4b7d8b86f9d988bd109fb6ae887f926f51b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.9-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 e588125f26f8ac42e5375b3da4cca8388244bf35d4a14aeadf76a001f6a43cd9
MD5 0c45674c08bd0fdf29f4dec12347491c
BLAKE2b-256 418fbdb50c176d77e77fc87fb981ba2ddf32be63b8e3c2fae6b06d44ad76bfd2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.9-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 72b3c2bf06ba88761f589b579cbab218f45e054857f2253eb8f9414db34c9926
MD5 d89e3a16592c8dab2915b5da13d18ce0
BLAKE2b-256 a42010313ec6a6ecac544cb1d66e722c5ceb7dbb2c8eca81296a6ee0a4ac882e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.9-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 e740cb82f840178ca04243f1af7d53ce3fc28b9828de4a412b92a5fd79a66372
MD5 a9392e00417ade4248f3bb3d26168838
BLAKE2b-256 c5e2b4203346d57e6f3c99bf8d507f500feac1c97122121c976aa8fedb647792

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.9-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ef5248ff85eaf238ce3b864c031c768aaf003483fbb2d73c60162a1fedc91fe3
MD5 298ea5410db6c5811a759705efb79362
BLAKE2b-256 b85d0f7d81705fe3a3fc9f503250fb7c86eadacca1807f0e26cf0ab0ea2d7053

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.9-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 946966018e450604dea0d86f478a54c022bd5a0c6136b848534a2d9d60e71ec2
MD5 1e64567b55b3fc0051faac631581cdea
BLAKE2b-256 f4b5a2d659202771c0261dfa99d5ec5a444d1f29c1c1101a5dab73f8b35a8c33

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