Commit 432524c
committed
docs(openapi,config): document /v1/answer/pageindex + pageindex block
OpenAPI 3.1 spec for the new endpoint:
- POST /v1/answer/pageindex documented with the
PageIndexAnswerRequest body shape (document_id, query,
optional model, max_hops, max_pages_per_fetch, stream,
reasoning) and PageIndexAnswerResponse (answer,
citations, hops_taken, usage, trace_token, pages_read,
reasoning_trace).
- PageIndexCitation, PageReadEntry, and
PageIndexTraceEntry component schemas describe the
page-grounded citation shape, the per-call navigation
footprint, and per-hop reasoning trace entries.
- The 200 response carries content for BOTH
application/json (non-streaming) and text/event-stream
(when stream:true) with documentation of the SSE event
types: `started`, one event per tool call
(get_document_structure / get_pages / done), and a
terminal `answer` event carrying the full payload.
- 501 covers both "no LLM client" and
"retrieval.pageindex.enabled=false" so operators
looking at the spec see the toggle that disables the
endpoint.
- QueryResponse's strategy enum gains "pageindex" so
/v1/query responses returned by a pageindex-default
deployment validate against the schema.
- ?reasoning=true query parameter is documented as an
alternative to the body's reasoning field.
config.example.yaml:
- retrieval.strategy comment lists every available
strategy with a one-line description of each, so an
operator picking a strategy can see what they're
choosing between without reading code.
- New retrieval.pageindex block with enabled / max_hops /
page_content_limit / model knobs, default values
matching the engine defaults, and a comment block
explaining the three-tool loop, the trace_token /
reasoning_trace / streaming differentiators, and the
graceful-degradation behaviour when no TOC tree is
persisted yet (the synthesised view fallback).1 parent ae4a23a commit 432524c
2 files changed
Lines changed: 393 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
95 | 95 | | |
96 | 96 | | |
97 | 97 | | |
98 | | - | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
99 | 112 | | |
100 | 113 | | |
101 | 114 | | |
| |||
232 | 245 | | |
233 | 246 | | |
234 | 247 | | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
235 | 296 | | |
236 | 297 | | |
237 | 298 | | |
| |||
0 commit comments