Recipes
Self-contained, runnable Vector scenarios. Every recipe is grounded in real RPCs + the vector template catalog, with troubleshooting tables for what actually goes wrong.
What’s here
| Recipe | Key APIs | When you need it |
|---|---|---|
| Pipeline Collection | AddVectorPipeline · upload object · Search | Drop documents in a bucket → K3 chunks + embeds + indexes via a Scriptum template. The canonical RAG-ingest recipe. |
| External Collection | AddVectorCollection · InsertVectors / UpsertVectors · Search | You compute embeddings yourself (OpenAI, Cohere, custom-tuned model) and want to push them to K3 directly. |
| Multi-collection Search | Search (empty collection_name) · collection_statuses[] | Search across multiple collections in one query. Covers the compatibility group key, observability, and metadata narrowing. |
| Hybrid + Rerank | Search with SEARCH_MODE_HYBRID + rerank: true | Improve precision — dense + BM25 fusion (RRF k=60) then Jina cross-encoder rerank. When each tier helps, latency cost. |
| Multimodal Search | AddVectorPipeline with visual_embedding_index · Search with s3_key | Query by an image / audio / video file. Covers content_type hint, rerank_text for binary queries. |
Conventions used in these recipes
- CLI-first where the CLI supports the action; API for everything else (e.g. hybrid + rerank, multi-collection, multimodal, BYO embeddings — all API-only on the CLI today).
- Endpoint examples use staging
https://k3.dev.dodil.io. Production:https://k3.dodil.io. - Bucket placeholder is
kb-prod; the vector engine is configuredautomode. - Consistent example collections across recipes:
docs— pipeline-mode,text_embedding_indexada— external-mode, OpenAI ada-002 (1536 dims, FLOAT, cosine)product-images— pipeline-mode,visual_embedding_index
Other useful pages
- Quickstart — first collection + first search in 5 minutes
- Core Concepts — Engine, Collection, VectorRecord, search shapes, enums
- API Reference → Search — the deep-dive on the Search RPC (mirror reading for the recipes here)
- VBase — for raw Milvus features K3 doesn’t expose