Technical Reference
Research Librarian: Technical Reference and Integrations
Review the technical, data, lifecycle, validation, and integration contract for Research Librarian.
Research Librarian · Technical Reference
Site-scoped research guidance that routes questions across knowledge, products, sources, and saved journeys.
Purpose
This reference summarizes the functional contract, record expectations, lifecycle, validation, export, compatibility, integration, privacy, and release-review requirements for Research Librarian.
Prerequisites
- Current release notes and repository documentation
- A test environment
- A backup and rollback plan
- Access to product health or package checks
- The synthetic all-feature sample
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.
Technical contract
Canonical identity
| Field | Value |
|---|---|
| Product slug | research-librarian |
| Product name | Research Librarian |
| Verified version | 7.0.0 |
| Content pack | 1.0.0 |
| Default article state | draft |
| Human review | required |
Functional surface
| Capability | Sample operation | Expected artifact |
|---|---|---|
| Question Intake | ask how a city should compare retrofit options | a normalized research request |
| Scope Gate | keep the request within Sustainable Catalyst research and products | an in-scope route or clear boundary |
| Intent Classification | classify the request as sourcing, calculation, analysis, or decision support | a transparent intent record |
| Knowledge Library Retrieval | retrieve energy-efficiency and decision-method documents | ranked library records |
| Product Routing | route calculation to Workbench and synthesis to Decision Studio | a product sequence with reasons |
| Source Discovery | identify utility, building, climate, and finance source types | a source shortlist with provenance expectations |
| Research Path Assembly | build a six-stage retrofit research path | an ordered journey |
| Follow-up Questions | ask only for geography and decision deadline | a narrower query |
| Evidence Cards | show source, relevance, confidence, and limitations | compact evidence records |
| Citation Handoffs | send selected sources to Knowledge Library or Decision Studio | structured source handoffs |
| Saved Journeys | save the community retrofit journey | persistent route and state |
| Feedback and Ratings | record that the route helped but lacked procurement guidance | a bounded quality signal |
| Index Health | confirm indexed record count and timestamp | a visible index status |
| Endpoint Diagnostics | distinguish UI, network, backend, and index failures | an actionable diagnostic state |
| Human Review Boundary | review suggested citations before relying on them | an advisory route rather than authority |
Core record fields
- Stable record or artifact ID
- Product and schema version
- Created and updated time
- Owner or responsible role
- Lifecycle or review state
- Source and provenance
- Units, period, geography, classification, or audience where applicable
- Validation findings and uncertainty
- Privacy and publication boundary
- Export or handoff integrity metadata
Lifecycle
Use a human-controlled lifecycle such as draft → review → approved/published, with revise, superseded, archived, withdrawn, failed, and recovered states where appropriate. Automated analysis may recommend; it must not silently approve, publish, or create private cases.
Validation
- Required-field and type checks
- Identifier and relationship checks
- Unit, period, geography, method, and classification compatibility
- Product and schema compatibility
- Source, evidence, and provenance completeness
- Permission, privacy, and publication-boundary checks
- Deterministic checksum or fingerprint validation for portable artifacts
Integrations
- Knowledge Library
- Workbench
- Decision Studio
- Site Intelligence
- Research Lab
- Product Support Platform
Send the minimum required fields through a typed contract. Preserve source product, destination, schema, artifact ID, review state, provenance, consent or privacy boundary, and receipt. Private Contact and Engagement records never belong in public support or research artifacts.
Release review
- Confirm interface, service, manifest, package, and schema versions.
- Validate the all-feature sample.
- Run product tests and integrity checks.
- Test one export and each supported handoff category.
- Document breaking changes and migration path.
- Update Last Verified Version before publishing this article.
Expected output
- A complete feature contract
- A validated synthetic export
- A compatibility decision
- A documented integration receipt
- A release-integrity report
Verification
- Product slug, version, schema, and IDs agree.
- Every documented feature maps to an actual interface, command, route, or record.
- The sample files produce the stated artifacts.
- Integrations preserve provenance and privacy.
- Migration, rollback, support, and release documentation are current.
Responsible use
This is a routing and discovery aid, not a general chatbot or final authority; inspect original sources and apply domain judgment.