@nahisaho/musubix-core 1.0.0

package/dist/explanation/explanation-generator.d.ts

@@ -0,0 +1,228 @@
+/**
+ * Explanation Generator
+ *
+ * Generates human-readable explanations from reasoning chains
+ *
+ * @packageDocumentation
+ * @module explanation/explanation-generator
+ *
+ * @see REQ-EXP-002 - Explanation Generation
+ * @see Article VIII - Transparency Standards
+ */
+import { ReasoningChain } from './reasoning-chain.js';
+/**
+ * Explanation detail level
+ */
+export type ExplanationLevel = 'minimal' | 'summary' | 'detailed' | 'comprehensive';
+/**
+ * Explanation format
+ */
+export type ExplanationFormat = 'text' | 'markdown' | 'html' | 'json';
+/**
+ * Audience type
+ */
+export type AudienceType = 'expert' | 'technical' | 'business' | 'general';
+/**
+ * Explanation section
+ */
+export interface ExplanationSection {
+    /** Section title */
+    title: string;
+    /** Section content */
+    content: string;
+    /** Section level (1-4) */
+    level: number;
+    /** Subsections */
+    subsections?: ExplanationSection[];
+}
+/**
+ * Generated explanation
+ */
+export interface Explanation {
+    /** Explanation ID */
+    id: string;
+    /** Chain ID */
+    chainId: string;
+    /** Title */
+    title: string;
+    /** Executive summary */
+    summary: string;
+    /** Sections */
+    sections: ExplanationSection[];
+    /** Key insights */
+    keyInsights: string[];
+    /** Confidence assessment */
+    confidenceAssessment: string;
+    /** Uncertainties and limitations */
+    uncertainties: string[];
+    /** Format */
+    format: ExplanationFormat;
+    /** Level */
+    level: ExplanationLevel;
+    /** Audience */
+    audience: AudienceType;
+    /** Generated at */
+    generatedAt: Date;
+    /** Metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Explanation generator options
+ */
+export interface ExplanationGeneratorOptions {
+    /** Detail level */
+    level: ExplanationLevel;
+    /** Output format */
+    format: ExplanationFormat;
+    /** Target audience */
+    audience: AudienceType;
+    /** Include evidence */
+    includeEvidence: boolean;
+    /** Include alternatives */
+    includeAlternatives: boolean;
+    /** Include confidence scores */
+    includeConfidenceScores: boolean;
+    /** Include timestamps */
+    includeTimestamps: boolean;
+    /** Maximum sections */
+    maxSections: number;
+    /** Language */
+    language: 'en' | 'ja';
+}
+/**
+ * Default options
+ */
+export declare const DEFAULT_GENERATOR_OPTIONS: ExplanationGeneratorOptions;
+/**
+ * Explanation Generator
+ */
+export declare class ExplanationGenerator {
+    private options;
+    private explanationCounter;
+    constructor(options?: Partial<ExplanationGeneratorOptions>);
+    /**
+     * Generate explanation from reasoning chain
+     */
+    generate(chain: ReasoningChain, options?: Partial<ExplanationGeneratorOptions>): Explanation;
+    /**
+     * Format explanation to string
+     */
+    format(explanation: Explanation): string;
+    /**
+     * Generate explanation and format in one step
+     */
+    explain(chain: ReasoningChain, options?: Partial<ExplanationGeneratorOptions>): string;
+    /**
+     * Generate sections based on reasoning chain
+     */
+    private generateSections;
+    /**
+     * Generate process overview
+     */
+    private generateProcessOverview;
+    /**
+     * Generate reasoning section
+     */
+    private generateReasoningSection;
+    /**
+     * Group steps by type
+     */
+    private groupStepsByType;
+    /**
+     * Format step group
+     */
+    private formatStepGroup;
+    /**
+     * Format step detail
+     */
+    private formatStepDetail;
+    /**
+     * Format minimal reasoning
+     */
+    private formatMinimalReasoning;
+    /**
+     * Format decisions
+     */
+    private formatDecisions;
+    /**
+     * Format evidence
+     */
+    private formatEvidence;
+    /**
+     * Format alternatives
+     */
+    private formatAlternatives;
+    /**
+     * Format conclusion
+     */
+    private formatConclusion;
+    /**
+     * Generate summary
+     */
+    private generateSummary;
+    /**
+     * Generate title
+     */
+    private generateTitle;
+    /**
+     * Extract key insights
+     */
+    private extractKeyInsights;
+    /**
+     * Generate confidence assessment
+     */
+    private generateConfidenceAssessment;
+    /**
+     * Extract uncertainties
+     */
+    private extractUncertainties;
+    /**
+     * Format as text
+     */
+    private formatAsText;
+    /**
+     * Format section as text
+     */
+    private formatSectionAsText;
+    /**
+     * Format as markdown
+     */
+    private formatAsMarkdown;
+    /**
+     * Format section as markdown
+     */
+    private formatSectionAsMarkdown;
+    /**
+     * Format as HTML
+     */
+    private formatAsHtml;
+    /**
+     * Format section as HTML
+     */
+    private formatSectionAsHtml;
+    /**
+     * Escape HTML
+     */
+    private escapeHtml;
+    /**
+     * Format value
+     */
+    private formatValue;
+    /**
+     * Format duration
+     */
+    private formatDuration;
+    /**
+     * Score to level
+     */
+    private scoreToLevel;
+    /**
+     * Generate ID
+     */
+    private generateId;
+}
+/**
+ * Create explanation generator instance
+ */
+export declare function createExplanationGenerator(options?: Partial<ExplanationGeneratorOptions>): ExplanationGenerator;
+//# sourceMappingURL=explanation-generator.d.ts.map

package/dist/explanation/explanation-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"explanation-generator.d.ts","sourceRoot":"","sources":["../../src/explanation/explanation-generator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EACL,cAAc,EAMf,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,eAAe,CAAC;AAEpF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,0BAA0B;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,WAAW,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,qBAAqB;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,eAAe;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe;IACf,QAAQ,EAAE,kBAAkB,EAAE,CAAC;IAC/B,mBAAmB;IACnB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,4BAA4B;IAC5B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oCAAoC;IACpC,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,aAAa;IACb,MAAM,EAAE,iBAAiB,CAAC;IAC1B,YAAY;IACZ,KAAK,EAAE,gBAAgB,CAAC;IACxB,eAAe;IACf,QAAQ,EAAE,YAAY,CAAC;IACvB,mBAAmB;IACnB,WAAW,EAAE,IAAI,CAAC;IAClB,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,mBAAmB;IACnB,KAAK,EAAE,gBAAgB,CAAC;IACxB,oBAAoB;IACpB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,sBAAsB;IACtB,QAAQ,EAAE,YAAY,CAAC;IACvB,uBAAuB;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,2BAA2B;IAC3B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,gCAAgC;IAChC,uBAAuB,EAAE,OAAO,CAAC;IACjC,yBAAyB;IACzB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,uBAAuB;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe;IACf,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,2BAUvC,CAAC;AA8DF;;GAEG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,OAAO,CAA8B;IAC7C,OAAO,CAAC,kBAAkB,CAAK;gBAEnB,OAAO,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC;IAI1D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,GAAG,WAAW;IA2B5F;;OAEG;IACH,MAAM,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM;IAexC;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,GAAG,MAAM;IAKtF;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAoExB;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAqB/B;;OAEG;IACH,OAAO,CAAC,wBAAwB;IA2ChC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAoBxB;;OAEG;IACH,OAAO,CAAC,eAAe;IAgBvB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAsCxB;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAU9B;;OAEG;IACH,OAAO,CAAC,eAAe;IAmBvB;;OAEG;IACH,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAM1B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAaxB;;OAEG;IACH,OAAO,CAAC,eAAe;IAavB;;OAEG;IACH,OAAO,CAAC,aAAa;IAQrB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA6B1B;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAepC;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAsB5B;;OAEG;IACH,OAAO,CAAC,YAAY;IAqBpB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAkB3B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAuBxB;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAiB/B;;OAEG;IACH,OAAO,CAAC,YAAY;IAqDpB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAoB3B;;OAEG;IACH,OAAO,CAAC,UAAU;IASlB;;OAEG;IACH,OAAO,CAAC,WAAW;IAanB;;OAEG;IACH,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,CAAC,YAAY;IAOpB;;OAEG;IACH,OAAO,CAAC,UAAU;CAInB;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,GAC7C,oBAAoB,CAEtB"}