Skip to content

Frontend_Runtime_Guide.md

Latest commit

 

History

History
67 lines (57 loc) · 2.63 KB

Frontend_Runtime_Guide.md

File metadata and controls

67 lines (57 loc) · 2.63 KB
Raw

Institutional Frontend Runtime Guide

1. Goal

Define how the Streamlit frontend executes, renders, and audits multi-agent query runs while staying consistent with backend observability contracts.

2. Architecture

flowchart TD
    A[User Query in Streamlit] --> B[Frontend Controller]
    B --> C[run_router_nodes_stream]
    C --> D[progressive render layers]
    D --> E[final dashboard render]
    C --> F[trace event capture]
    F --> G[write_frontend_query_bundle]
    G --> H[query_audit_trail append]
Loading

3. Code Strategy and Workflow

  • Stream node-level events to surface intermediate retrieval and reasoning context.
  • Render phase outputs before full graph completion to reduce perceived latency.
  • Write trace, summary, and final-state artifacts for every query (including failure paths).
  • Keep frontend event schema aligned with backend router_e2e contracts.

4. Output Data Schema and Path

Artifact Schema Core Fields Path
session chat state in-memory UI state user message, assistant response Streamlit session state
streamed node events trace event row node, event, elapsed_s, route, delta_keys Frontend/app.py runtime
frontend trace *_trace.jsonl _meta + event rows logs/frontend_query/<YYYY-MM-DD>/
frontend final state *_final_state.json merged graph state snapshot logs/frontend_query/<YYYY-MM-DD>/
frontend summary *_summary.json outcome, confidence, nodes, artifacts logs/frontend_query/<YYYY-MM-DD>/
frontend index trail query_audit_trail.jsonl query metadata + artifact links logs/frontend_query/<YYYY-MM-DD>/query_audit_trail.jsonl

5. How to Test

streamlit run Frontend/app.py
python -m Scripts query "Today GLD IV skew and geopolitical risk context?"

Validation checklist:

  • progressive rendering appears before final report;
  • three frontend bundle files are created per query;
  • index trail points to valid trace/final_state/summary paths.

6. Dependence Files and One-Line Command

Inputs

  • Frontend/app.py
  • Frontend/pipeline.py
  • Frontend/renderers.py
  • Frontend/audit.py
  • Frontend/contracts.py

Outputs

  • analyst-facing progressive dashboard;
  • frontend query bundle for replay and post-mortem.

Related Docs

pip install -r requirements.txt