On this page
Search and answers¶
In an indexed space, open Work, select Search and ask a question whose source you know. With an equipment handbook, ask about an alarm code, then describe the same symptom in your own words.
The right passage is missing. Compare dense and lexical retrieval on the same documents. If wording is the issue, try a query transform.
The right passage ranks too low. Add a reranker.
Search returns the right passage. Enable Generate answers and inspect their sources if you need a generated response, then check what it cites.
Choose a starting point¶
Select a preset in Pipeline. The installed presets and their model
requirements are listed at GET /api/v1/pipeline/presets.
Preset |
Use it for |
|---|---|
|
Dense retrieval that returns passages. No LLM required. |
|
Codes, names and questions about meaning. Combines BM25 and dense retrieval, reranks and generates an answer. Configure an LLM. |
|
Dense retrieval, reranking and answers. Configure an LLM. |
|
Questions worded differently from the documents. The LLM writes a hypothetical passage for dense retrieval, then generates the answer. |
|
Questions over a knowledge graph. Build the graph before comparing its answers with ordinary search. |
GET /api/v1/pipeline/catalog returns the installed node schemas,
including defaults and bounds. Most nodes use
{"node": "<id>", "params": {...}}. Put the fields of Check an answer before publishing it (rubric)
directly in the postgeneration item.
Walk through a question¶
Retrieval can use transformed questions and merge branches before the shared reranker. Reranking and generation receive the original question. Answer checks follow generation. Compare configurations on a fixed set of questions with Evaluate retrieval and answers.
Check a change before applying it¶
Run
POST /api/v1/spaces/{space_id}/config/validateto check the configuration and reindex impact without saving.Send the full pipeline to
PUT /api/v1/spaces/{space_id}/config. Query-only changes can return200. Index rebuilds or document recuts can return202.Poll
GET /api/v1/spaces/{space_id}/config/statusfor derived indexes. If an attached store reportsindexes_attached_storage, check its storage-index state.
See Processing and indexing for the write path and Connections and storage for storage choices.