Skip to content

Conversation

@arodage
Copy link
Contributor

@arodage arodage commented Jan 6, 2026

Merge Checklist

All boxes should be checked before merging the PR

  • The changes in the PR have been built and tested
  • Ready to merge

Description

This PR adds an Architecture Decision Record (ADR) proposing a Template-Enriched RAG architecture for AI-powered OS image template generation.

Summary:
The design embeds semantic metadata directly within template files, enabling self-describing templates that can be effectively indexed and retrieved using natural language queries. Users can interact conversationally to generate and iteratively refine templates through natural language.

Key Features:

  • Self-Describing Templates: Embedded metadata (useCase, description, keywords, capabilities) for semantic matching
  • Single Search Path: One semantic search with hybrid scoring (semantic 70% + keyword 20% + package 10%)
  • Query Classification: Adapts scoring weights based on query type (semantic, package-explicit, refinement, negation)
  • Embedding Cache: Content-hash based caching for fast startup
  • Conversational Refinement: Multi-turn interaction for iterative template modifications
  • Future Agentic Capabilities: Planned auto-validation, package verification, and self-correction

Document Structure:

  1. Context and Problem Statement
  2. Recommendation with Core Design Principles
  3. Template Metadata Schema
  4. High-Level Architecture (with Mermaid diagrams)
  5. Design Details (Query Classification, Hybrid Scoring, Caching)
  6. Conversational Interaction Flow
  7. Lightweight Agentic Capabilities (Future Enhancement)
  8. Alternatives Considered
  9. Implementation Phases (1-5)
  10. Configuration Reference
  11. Evaluation Criteria and Success Metrics

Any Newly Introduced Dependencies

None. This is a documentation-only change (ADR proposal).

How Has This Been Tested?

  • Markdown formatting verified
  • Mermaid diagrams render correctly
  • Document structure follows ADR template conventions

This ADR proposes a Template-Enriched RAG architecture for AI-powered
OS image template generation. Key features include:

- Self-describing templates with embedded metadata for semantic matching
- Single search path with hybrid scoring (semantic + keyword + package)
- Embedding cache strategy for fast startup
- Conversational interaction for iterative template refinement
- Query classification with adaptive scoring weights
- Future agentic capabilities for auto-validation and self-correction

The design enables natural language template generation grounded in
real, working examples while maintaining simplicity and extensibility.

Technical Area: AI/ML, Template Generation
Status: Proposed
Copilot AI review requested due to automatic review settings January 6, 2026 00:42
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

The initial commit had empty content. This commit adds the full ADR document with:
- Problem statement and context
- Template metadata schema
- High-level architecture with Mermaid diagrams
- Query classification and hybrid scoring
- Embedding cache strategy
- Conversational interaction flow
- Agentic capabilities (future enhancement)
- Implementation phases and configuration
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants