clavix 2.3.0 → 2.4.0

package/dist/core 2/prompt-optimizer.d.ts

@@ -0,0 +1,268 @@
+/**
+ * PromptOptimizer - Analyzes and improves prompts using the CLEAR Framework
+ * CLEAR Framework: Concise, Logical, Explicit, Adaptive, Reflective
+ * Developed by Dr. Leo Lo, University of New Mexico
+ * Reference: https://guides.library.tamucc.edu/prompt-engineering/clear
+ */
+export type OptimizerMode = 'fast' | 'deep';
+export interface PromptAnalysis {
+    gaps: string[];
+    ambiguities: string[];
+    strengths: string[];
+    suggestions: string[];
+}
+export interface ConciseAnalysis {
+    score: number;
+    verbosityCount: number;
+    pleasantriesCount: number;
+    signalToNoiseRatio: number;
+    issues: string[];
+    suggestions: string[];
+}
+export interface LogicAnalysis {
+    score: number;
+    hasCoherentFlow: boolean;
+    sequencingIssues: string[];
+    suggestedOrder: string[];
+    issues: string[];
+    suggestions: string[];
+}
+export interface ExplicitAnalysis {
+    score: number;
+    hasPersona: boolean;
+    hasOutputFormat: boolean;
+    hasToneStyle: boolean;
+    hasSuccessCriteria: boolean;
+    hasExamples: boolean;
+    issues: string[];
+    suggestions: string[];
+}
+export interface AdaptiveAnalysis {
+    score: number;
+    alternativePhrasings: string[];
+    alternativeStructures: Array<{
+        name: string;
+        structure: string;
+        benefits: string;
+    }>;
+    temperatureRecommendation: number;
+    issues: string[];
+    suggestions: string[];
+}
+export interface ReflectiveAnalysis {
+    score: number;
+    validationChecklist: string[];
+    edgeCases: string[];
+    potentialIssues: string[];
+    factCheckingSteps: string[];
+    qualityCriteria: string[];
+    issues: string[];
+    suggestions: string[];
+}
+export interface CLEARResult {
+    conciseness: ConciseAnalysis;
+    logic: LogicAnalysis;
+    explicitness: ExplicitAnalysis;
+    adaptiveness?: AdaptiveAnalysis;
+    reflectiveness?: ReflectiveAnalysis;
+    overallScore: number;
+    improvedPrompt: string;
+    changesSummary: Array<{
+        component: 'C' | 'L' | 'E' | 'A' | 'R';
+        change: string;
+    }>;
+}
+export interface CLEARScore {
+    overall: number;
+    conciseness: number;
+    logic: number;
+    explicitness: number;
+    adaptiveness?: number;
+    reflectiveness?: number;
+    rating: 'excellent' | 'good' | 'needs-improvement' | 'poor';
+}
+export interface TriageResult {
+    needsDeepAnalysis: boolean;
+    reasons: string[];
+}
+export interface QualityAssessment {
+    isAlreadyGood: boolean;
+    criteriaMetCount: number;
+    totalCriteria: number;
+    criteriaResults: {
+        clearGoal: boolean;
+        sufficientContext: boolean;
+        actionableLanguage: boolean;
+        reasonableScope: boolean;
+    };
+}
+export interface ChangesSummary {
+    changes: string[];
+}
+export interface ImprovedPrompt {
+    original: string;
+    analysis: PromptAnalysis;
+    improved: string;
+    changesSummary?: ChangesSummary;
+    triageResult?: TriageResult;
+    qualityAssessment?: QualityAssessment;
+    alternativePhrasings?: string[];
+    edgeCases?: string[];
+    implementationExamples?: {
+        good: string[];
+        bad: string[];
+    };
+    alternativeStructures?: Array<{
+        structure: string;
+        benefits: string;
+    }>;
+    potentialIssues?: string[];
+}
+export declare class PromptOptimizer {
+    /**
+     * Analyze a prompt and identify issues
+     */
+    analyze(prompt: string): PromptAnalysis;
+    /**
+     * Perform smart triage to determine if deep analysis is recommended
+     */
+    performTriage(prompt: string): TriageResult;
+    /**
+     * Assess prompt quality
+     */
+    assessQuality(prompt: string): QualityAssessment;
+    /**
+     * Generate an improved version of the prompt
+     */
+    improve(prompt: string, mode?: OptimizerMode): ImprovedPrompt;
+    /**
+     * Apply CLEAR Framework analysis to a prompt
+     * C = Concise, L = Logical, E = Explicit, A = Adaptive (deep only), R = Reflective (deep only)
+     */
+    applyCLEARFramework(prompt: string, mode?: OptimizerMode): CLEARResult;
+    /**
+     * Analyze Conciseness (C): Brevity and clarity
+     */
+    analyzeConciseness(prompt: string): ConciseAnalysis;
+    /**
+     * Analyze Logic (L): Structured and coherent prompts
+     */
+    analyzeLogic(prompt: string): LogicAnalysis;
+    /**
+     * Analyze Explicitness (E): Clear output specifications
+     */
+    analyzeExplicitness(prompt: string): ExplicitAnalysis;
+    /**
+     * Analyze Adaptiveness (A): Flexibility and customization
+     */
+    analyzeAdaptiveness(prompt: string): AdaptiveAnalysis;
+    /**
+     * Analyze Reflectiveness (R): Continuous evaluation and improvement
+     */
+    analyzeReflectiveness(prompt: string): ReflectiveAnalysis;
+    /**
+     * Calculate overall CLEAR score with weighted components
+     */
+    calculateCLEARScore(analysis: {
+        conciseness: ConciseAnalysis;
+        logic: LogicAnalysis;
+        explicitness: ExplicitAnalysis;
+        adaptiveness?: AdaptiveAnalysis;
+        reflectiveness?: ReflectiveAnalysis;
+    }): CLEARScore;
+    /**
+     * Generate improved prompt using CLEAR framework insights
+     */
+    private generateCLEARImprovedPrompt;
+    /**
+     * Generate CLEAR-labeled changes summary
+     */
+    private generateCLEARChangesSummary;
+    /**
+     * Map CLEAR result to legacy PromptAnalysis format for backward compatibility
+     */
+    mapCLEARToLegacy(clearResult: CLEARResult): PromptAnalysis;
+    /**
+     * Extract strengths from CLEAR analysis
+     */
+    private extractCLEARStrengths;
+    /**
+     * Find gaps in the prompt
+     */
+    private findGaps;
+    /**
+     * Find ambiguities in the prompt
+     */
+    private findAmbiguities;
+    /**
+     * Find strengths in the prompt
+     */
+    private findStrengths;
+    /**
+     * Generate improvement suggestions
+     */
+    private generateSuggestions;
+    /**
+     * Generate improved prompt with structure
+     */
+    private generateImprovedPrompt;
+    private hasContext;
+    private hasSuccessCriteria;
+    private hasTechnicalDetails;
+    private hasUserNeeds;
+    private hasExpectedOutput;
+    private extractOrInferObjective;
+    private extractOrInferRequirements;
+    private extractOrInferTechnical;
+    private extractOrInferOutput;
+    private extractOrInferSuccess;
+    /**
+     * Count missing critical elements
+     */
+    private countMissingCriticalElements;
+    /**
+     * Check for vague scope words without sufficient context
+     */
+    private hasVagueScopeWithoutContext;
+    /**
+     * Check if prompt has a clear goal
+     */
+    private hasClearGoal;
+    /**
+     * Check if prompt uses actionable language
+     */
+    private hasActionableLanguage;
+    /**
+     * Check if prompt has reasonable scope
+     */
+    private hasReasonableScope;
+    /**
+     * Generate changes summary
+     */
+    private generateChangesSummary;
+    /**
+     * Generate alternative phrasings (deep mode)
+     */
+    private generateAlternativePhrasings;
+    /**
+     * Identify edge cases in requirements (deep mode)
+     */
+    private identifyEdgeCases;
+    /**
+     * Generate implementation examples (deep mode)
+     */
+    private generateImplementationExamples;
+    /**
+     * Suggest alternative prompt structures (deep mode)
+     */
+    private suggestAlternativeStructures;
+    /**
+     * Identify potential issues with the prompt (deep mode)
+     */
+    private identifyPotentialIssues;
+    /**
+     * Extract core requirement from prompt
+     */
+    private extractCoreRequirement;
+}
+//# sourceMappingURL=prompt-optimizer.d.ts.map