Whatever message this page gives is out now! Go check it out!
Topic | Beginners | Experienced developers |
Client creation | VectorStore() with no arguments uses an in-memory store for local tests. | VectorStore({ ... }) plus server aliases (Administrator, CFSetup) for production credentials. |
Items | Each row has text (required in the usual path); embedding is optional if an embedding model is configured. | If embedding is supplied, it overrides model output; align dimension, metricType, and indexType with your provider and model. |
Search | Pass text to search; tune topK and minScore. | Pass vector directly when you already have embeddings; use filter with MongoDB-style operators ($eq, $in, $gte, $or, and so on). |
Operations | add, addAll, search, delete, deleteAll; collections can be listed or removed. | Large payloads may require batching. Use addAll() and control the batch size by passing an array with the required number of items. Be mindful of provider message size limits. Note: The VectorStore API does not expose a batchSize configuration. Developers control batching by chunking items and passing them to addAll() in appropriately sized arrays. |
Embeddings | Supported providers include all_minlm(in memory onnx), Ollama, OpenAI, Azure OpenAI, Mistral, and Gemini per product documentation. | Configure timeouts, retries, batchSize, and logging on the embedding side to match SLAs. |