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 Link Check prek 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, creating knowledge graphs for context engineering 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.

  2. (Optional) Install Claude Code skill for enhanced development experience. Run these commands in Claude Code:

/plugin marketplace add cocoindex-io/cocoindex-claude
/plugin install cocoindex-skills@cocoindex

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
PDF Elements Embedding Extract text and images from PDFs; embed text with SentenceTransformers and images with CLIP; store in Qdrant for multimodal 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
Meeting Notes to Knowledge Graph Extract structured meeting info from Google Drive and build a knowledge graph
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 Source HackerNews Index HackerNews threads and comments, using CocoIndex Custom Source
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
HackerNews Trending Topics Extract trending topics from HackerNews threads and comments, using CocoIndex Custom Source and LLM
Patient Intake Form Extraction with BAML Extract structured data from patient intake forms using BAML
Patient Intake Form Extraction with DSPy Extract structured data from patient intake forms using DSPy

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.3.37.tar.gz (484.9 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

cocoindex-0.3.37-cp314-cp314t-win_amd64.whl (19.7 MB view details)

Uploaded CPython 3.14tWindows x86-64

cocoindex-0.3.37-cp314-cp314t-manylinux_2_28_x86_64.whl (19.2 MB view details)

Uploaded CPython 3.14tmanylinux: glibc 2.28+ x86-64

cocoindex-0.3.37-cp314-cp314t-manylinux_2_28_aarch64.whl (18.5 MB view details)

Uploaded CPython 3.14tmanylinux: glibc 2.28+ ARM64

cocoindex-0.3.37-cp314-cp314t-macosx_11_0_arm64.whl (17.9 MB view details)

Uploaded CPython 3.14tmacOS 11.0+ ARM64

cocoindex-0.3.37-cp311-abi3-win_amd64.whl (19.7 MB view details)

Uploaded CPython 3.11+Windows x86-64

cocoindex-0.3.37-cp311-abi3-manylinux_2_28_x86_64.whl (19.2 MB view details)

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

cocoindex-0.3.37-cp311-abi3-manylinux_2_28_aarch64.whl (18.5 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

cocoindex-0.3.37-cp311-abi3-macosx_11_0_arm64.whl (18.0 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

cocoindex-0.3.37-cp311-abi3-macosx_10_12_x86_64.whl (18.7 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: cocoindex-0.3.37.tar.gz
  • Upload date:
  • Size: 484.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: maturin/1.12.6

File hashes

Hashes for cocoindex-0.3.37.tar.gz
Algorithm Hash digest
SHA256 6cc91b77d7546978bc1f93e2c9920650a7f5e1496c88b355b520e96a46c5f87f
MD5 0acef4278ee2f5aac30734de894d50db
BLAKE2b-256 fae8508b6cbf890b97a8e257a49acd16b458f28295af963fee99f00c08536bda

See more details on using hashes here.

File details

Details for the file cocoindex-0.3.37-cp314-cp314t-win_amd64.whl.

File metadata

File hashes

Hashes for cocoindex-0.3.37-cp314-cp314t-win_amd64.whl
Algorithm Hash digest
SHA256 233034922cc7f311caedf09c14f5d06e049ffb68bf52b0879ab150425a985711
MD5 ec963e6678396a9a86e227994432ee9c
BLAKE2b-256 79085defd7c2322f6541e3df882e41051280a063d751be168915868b248042b8

See more details on using hashes here.

File details

Details for the file cocoindex-0.3.37-cp314-cp314t-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for cocoindex-0.3.37-cp314-cp314t-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 c0d55e8cb794da15acc1d6611b8e71100c7856ecaa168d633f0e374dd4c2098e
MD5 09c4f0af69fe3474b147ecce8633f099
BLAKE2b-256 25b54f82b231f8df404f59532fc852b119d54c3a2ae3ca80935cfe1968642cac

See more details on using hashes here.

File details

Details for the file cocoindex-0.3.37-cp314-cp314t-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for cocoindex-0.3.37-cp314-cp314t-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 beafb4677d2049f89b7d0f901d77d7f476dd8f7bed4d801058232b613751ed97
MD5 039b5c977d0180691b8f4f2309ed65a3
BLAKE2b-256 e413e4f76439ccdf7ab0b7018896d45630ec6c221a0d0a1f57cb5e2568084c85

See more details on using hashes here.

File details

Details for the file cocoindex-0.3.37-cp314-cp314t-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for cocoindex-0.3.37-cp314-cp314t-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f0ae51b133460f7158219ad6f49ff8c62d0410e2989e38f92af89e8e66ad077c
MD5 907a353ff073ea92b9fc640b29f078ec
BLAKE2b-256 d814cbd5776ef1ee2d0a7a26ab2eee60b41f5bcca52f0ab3c83714990be168bd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.37-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 c537e4009d129e180b14cf0dcec0d869ad179760e0d94d276b8cdf9b4ef0d1d6
MD5 eb0b1da122ad2d440b2bba7112c1acef
BLAKE2b-256 c8d80feaa411890b45a3b93ccf15f58464e6658bb94ce44bf0a3f2ca3cc3a6af

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.37-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a89c3dfd05fdb1289079922a96042bb70dbbc31a8c03a5f6054f9744d603ed40
MD5 1f445763f88cd254d3825ab2d4f31746
BLAKE2b-256 aa7a794e05854a62ed6c50c897f4cf87d796f0e07032dd11b909d0d7ae8f4984

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.37-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 17f68aa20e124beab485189423ef488830402dc2370ab606b14f1a7e2a97c93f
MD5 de3d3275c6fa7a861ea41bb9fff81341
BLAKE2b-256 36b684527fc2bf3ba850c96eefd87b25e7964ba4d377c4f4d601ebe7a342b4ca

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.37-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 88004b2418ed7eafa6c9968c8fd191426c07d56e4f855a098d8a11cae55d0899
MD5 2f9d21c336338b6c7735c523d8343a8b
BLAKE2b-256 d4f6f78c87c11c4d45f7fe42ea184c047b7cd23a55af412620722cb0782e4f7b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cocoindex-0.3.37-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 052978d727b12178c680edf60f7c4218bdc93430f3923df77112de0631d13ba0
MD5 5811c8716d496e10b248fd8a5cb52e9c
BLAKE2b-256 8256ad3f6d0e492949da898fbfb8c4491770eb19119b67d5092c9c895b544eb7

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