Knowledge basePro
Build and probe a search index for an assistant: documents go through four ingest stages with live counts, then a test query returns scored passages, highlights what matched and shows what a reranker would change.
oxyn add knowledge-baseSupport knowledge base
2 of 4 indexed · 134 chunks
- PDFBilling handbook.pdf18 pages · 96 chunksParseChunkEmbedIndexIndexed
- Plans and seats7 pages · 38 chunksParseChunkEmbedIndexIndexed
- Admin FAQ11 pages · 0 chunksParseChunkEmbedIndexParse · 0%
- help.northwind.app24 pages · 0 chunksParseChunkEmbedIndexParse · 19%
The preview stays free for everyone. Pro opens the code of every Pro component, screen, agent-app template, block and kit, plus the Pro CLI.
Rendered from Rust at build time · goes live when visible
When to use
- A retrieval knowledge base in one card: watch sources ingest, then test a question and see which chunks come back and why.
When not to use
- Sit in on a crew of agents mid-run: use Live Session instead.
- One overview for a whole fleet: use Fleet overview instead.
- The fleet overview laid out against time: use Fleet timeline instead.
Installation
Knowledge base is part of Oxyn Pro; the preview is free. Pro items install with the oxyn CLI once your licence is signed in; until then Pro members copy the code from this page.
oxyn add knowledge-baseUsage
The preview is free. Pro opens the code of every Pro component, screen and template.
Examples
Sources
Documents mid-ingest, one stuck at the embedding stage.
Support knowledge base
2 of 4 indexed · 134 chunks
- PDFBilling handbook.pdf18 pages · 96 chunksParseChunkEmbedIndexIndexed
- Plans and seats7 pages · 38 chunksParseChunkEmbedIndexIndexed
- Admin FAQ11 pages · 0 chunksParseChunkEmbedIndexParse · 0%
- help.northwind.app24 pages · 0 chunksParseChunkEmbedIndexParse · 19%
Code Pro
The preview is free. Pro opens the code of every Pro component, screen and template.
Refunds
Test retrieval on a refund question (Oxyn extra).
Support knowledge base
4 of 4 indexed · 306 chunks
Code Pro
The preview is free. Pro opens the code of every Pro component, screen and template.
Reranked
The same results reranked (Oxyn extra).
Support knowledge base
4 of 4 indexed · 306 chunks
Code Pro
The preview is free. Pro opens the code of every Pro component, screen and template.
API reference
KnowledgeBase
| Prop | Type | Default | Description |
|---|---|---|---|
nowrequired | ClockMs | — | Host clock. |
ask | Option<usize> | Default::default() | Start in Test retrieval with this suggestion asked (0–2). |
settled | bool | Default::default() | Start with every source indexed (no ingestion or failure). |
rerank | bool | Default::default() | Rerank on at the start. |
title | String | "Support knowledge base" | Heading. |
Read from the Rust signature and doc comments.
Keyboard interactions
| Key | Action |
|---|---|
| ←or→ | Switch between the documents and the query tester |
| Enter | Query field: search; passage: show its neighbours |
| Esc | Empty the query |
Accessibility
- Every ingest row is a progressbar that names its stage, e.g. Embed, step 3 of 4.
- Passages are buttons that speak score and movement after reranking; hits use mark.
- Progress, errors and query results share one polite announcer.
From the spec
Each pipeline is a progressbar whose value text names the step; results are buttons with aria-expanded named with score and rank change; matched words are mark elements; ingestion, failures and searches are announced. Every action returns the line the polite live region announces. The focus outline shows only for keyboard focus.
Motion & interaction
Each pipeline segment fills in turn while chunks climb; reranking reorders the same results in place and marks how far each moved; matching words are highlighted.
Timing
Everything on screen is derived from the host clock now (no timers in the block), so playback, tests and the GPUI view agree.
| Transition | Duration | Easing |
|---|---|---|
| Pipeline step | 1300 ms | linear |
| Retry | resumes at embed | — |
Reduced motion: shimmer, pulses and slides stop; every state keeps its words and icons.
Responsive behaviour
- Single column at every width; under 560 px the stage bar sits beneath the document name without labels.
Edge cases (spec)
One column from 760 px down to 320 px; below 560 px the pipeline goes under each source and its step labels drop; below 440 px the summary hides and the question field takes the full width. Layout follows the block's own width (container queries), never the viewport. Checked at 1440, 768 and 390 px in light and dark with no text overlap. Chrome is monochrome grey; colour is semantic only (success, warning, danger, info) plus data series and the official coloured brand and model marks.
Notes for AI
- Import
KnowledgeBasefromoxyn_dioxusand includeSTATUS_INDICATOR_CSSplus the token stylesheet once. - A GPUI version exists:
BlocksViewinoxyn_gpui. - Props to set first:
now. - It reads a clock (
now) for live timers; pass one clock for the whole page rather than one per component. - Keep its states and timings as they ship; restyle it through the CSS variables rather than by hand.