Troubleshooting
Research Librarian: Troubleshooting and Recovery
Diagnose and recover common Research Librarian failures without losing state.
Research Librarian · Troubleshooting
Site-scoped research guidance that routes questions across knowledge, products, sources, and saved journeys.
Purpose
This guide uses an evidence-first diagnostic sequence for Research Librarian. Preserve state before changing configuration. Determine whether the failure comes from input data, permissions, version identity, browser assets, backend health, schema compatibility, external dependencies, or a product defect.
Prerequisites
- Exact error message and time
- Product, backend, package, and schema versions
- Affected route, feature, record ID, and user role
- A safe backup or export
- The synthetic sample for a reference test
Sample data
This article uses a fictional Resilient Community Retrofit Program. The files contain one demonstration row for every documented feature, so each capability can be tested without private or production data.
Download CSV feature examples · Download JSON workspace example
Preview
| # | Feature | Sample action | Expected result | Classification |
|---|---|---|---|---|
| 1 | Question Intake | ask how a city should compare retrofit options | a normalized research request | synthetic-demo |
| 2 | Scope Gate | keep the request within Sustainable Catalyst research and products | an in-scope route or clear boundary | synthetic-demo |
| 3 | Intent Classification | classify the request as sourcing, calculation, analysis, or decision support | a transparent intent record | synthetic-demo |
| 4 | Knowledge Library Retrieval | retrieve energy-efficiency and decision-method documents | ranked library records | synthetic-demo |
| 5 | Product Routing | route calculation to Workbench and synthesis to Decision Studio | a product sequence with reasons | synthetic-demo |
The downloadable files include all 15 feature rows.
Procedure
- Stop repeated imports, submissions, migrations, or destructive retries.
- Record URL, feature, action, role, versions, browser/runtime, and expected result.
- Run the same feature row in a new synthetic workspace.
- If the sample fails, inspect health, logs, browser console, network response, and validation details.
- If the sample succeeds, compare real input schema, units, permissions, size, source, and status with the sample.
- Check version and schema identity before clearing caches or reinstalling.
- Apply the smallest reversible change.
- Repeat the sample and real workflow, then document the result.
Common problems
| Symptom | Likely cause | Safe response |
|---|---|---|
| Endpoint unavailable | browser cannot reach the routing service | check health, CORS, URL, and cache |
| Zero indexed records | knowledge index is absent or stale | run indexing and verify count |
| Irrelevant route | question is broad or ambiguous | add geography, audience, domain, and desired output |
| Rate limit reached | too many requests were sent | consolidate questions or adjust authorized limits |
Escalation package
- Product and version
- Feature and component
- Exact error text
- Reproduction steps using synthetic data
- Expected and actual result
- Redacted log excerpt without secrets or personal data
- Whether a clean sample reproduces the problem
Expected output
- A reproducible diagnosis or bounded unresolved issue
- Preserved user and system state
- A documented workaround when available
- A support-ready issue summary without private data
Verification
- The synthetic feature succeeds after the fix.
- The original workflow succeeds or remains safely isolated.
- Version and health identity are consistent.
- No duplicates, stale locks, or unintended cache artifacts remain.
- The resolution is reflected in a support article, known issue, or release record when appropriate.
Responsible use
This is a routing and discovery aid, not a general chatbot or final authority; inspect original sources and apply domain judgment.
Never place credentials, API keys, private URLs, personal records, client documents, or confidential logs in a public article or issue.
