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.4

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

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.2.4-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.4-cp311-abi3-manylinux_2_28_aarch64.whl (16.1 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.2.4-cp311-abi3-macosx_11_0_arm64.whl (15.8 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.2.4-cp311-abi3-macosx_10_12_x86_64.whl (16.4 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for cocoindex-0.2.4.tar.gz
Algorithm Hash digest
SHA256 5d3e11c262d5fd056768f1a5d38b36716df3dd604981b5e67cb3e4420fca4ad8
MD5 ede3f4bdde69583126c948dff39ed862
BLAKE2b-256 72ee6415f5b9c382a6223a35cbbf4ec1a94027c34c2da0c96345bf2336f4c222

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.4-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 e3159af9a12ac40d79768de5234a66efd4c3e2f18ab17196ebe70215e21872b6
MD5 17b0c6fd86aedcfd9b01e5710c51e8e3
BLAKE2b-256 d3a6a16cabf2975e5d44c18dfb40fb92164bdb35790108528cd508d1ed1a2cb8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.4-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 11a1cd3b937e51bfcf2c7463462010e258d4819b1680fce7d30cdbed6947e827
MD5 37ac1ee14a504f4458c5ae7525da9169
BLAKE2b-256 0b8ec98dcef87d592af8eb60337caab773bb96c09ee0d4614fe33885dec95cad

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.4-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 256995db4d9a0d0461121c526da47512dbc7d3cb338760b2dce951c1e05e4b0f
MD5 ce0a5a3b620778651595ccc87a3e4013
BLAKE2b-256 22336c7b99714a2e6a6c9fddccd6dfe731bfbbe00b76c5dde84a2e19442d74fe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.4-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e07fd10a3d9302cd59ffb9f6f05bf02d0cf260afb9129f4436ef353976dc1fea
MD5 cb1d8050748437544c6ffaf8466ebe36
BLAKE2b-256 d404fe7fe1e803e648c292abdfbb1d4017ba38a69221ddc4ac5a2f7ad0b5caae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.2.4-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 7ee55280caad710d008bf28cc3417b6db8b92ef6579371f8f200483a2b68c9ab
MD5 c6b134ba9749989fc6e52bf28156edda
BLAKE2b-256 667a7974fae524672eaf03d491f32a0da6260fc20b2b7335f290337ee2a14e49

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