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

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.13-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.13-cp311-abi3-manylinux_2_28_aarch64.whl (16.3 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

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

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.13-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.13.tar.gz.

File metadata

  • Download URL: cocoindex-0.2.13.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.13.tar.gz
Algorithm Hash digest
SHA256 b18a6f6b4b8855e01e66ca9e31f9ccd6aa41beaca7cd47c97053f8b1497abc12
MD5 fd789d875327350a0cecc0230a1da632
BLAKE2b-256 e43ffded9c6cb1c754c2b01c4357628d0ebd099dbe3ef88c6dbe3014c8909f6e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.13-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 628cd05d91839a239511f52745e2e2a138f5024a6124b58df6d7279234a9bdd9
MD5 e25a6d16f0d945eb7c8a3fb336988a63
BLAKE2b-256 eb9da3c52742f2acd19335447a00201c7b923dfd90bbce02d1086c2efe7e1d3b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.13-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 108612903be1c45807e98b333c098016b5a53a4bf46a7035a1065d3c0bb346c1
MD5 115829845a699c47a4d9c070beb4dbfa
BLAKE2b-256 880b25e9e48781cf203f62e054ada755c55f3e0ca76378cccf1090ec12a32082

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.13-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 34fc22e9799d721ffedfad81a6963a4911fd4d6cb223f75eda20c2bbd2ea471d
MD5 e902a3b52c3db4937962e3a5419b236f
BLAKE2b-256 7cf79ee77d17e84924c0f1530ee850951f75b99ddad7514c47324197d2444b87

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.13-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e3e03a838a4d1d4132175f5029821bda2bc2e221b0292535b4f278f07eeb5783
MD5 0d06969c50bbd5cc26cf29246f4ce602
BLAKE2b-256 8c548b44b85a33ba8b60a9f37ce7c9547d04b6a7671198f8772860ce66030d3b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.13-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 9a3191d3d816e176c81fdfe8f66a9df2ddbcb9f1ee1ea92f9eb9c7450940bee4
MD5 a961ffcc61e8b7aa9a39b60a3496089a
BLAKE2b-256 14243819311c07808ffc7e55f7d83b18c4b2ed6a952ebc0dacb2b9a44b4d70d9

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