panini-lang-core 0.3.0

Core traits and types for the Panini linguistic feature extraction framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

use std::fmt::Debug;

use crate::component::{AnalysisComponent, ComponentContext};
use crate::traits::LinguisticDefinition;

/// Produces a pedagogical explanation of the sentence in the learner's language.
#[derive(Debug, Clone, Default)]
pub struct PedagogicalExplanation;

impl<L: LinguisticDefinition> crate::component::ComponentRequires<L> for PedagogicalExplanation {}

impl<L: LinguisticDefinition> AnalysisComponent<L> for PedagogicalExplanation {
    fn name(&self) -> &'static str {
        "Pedagogical Explanation"
    }

    fn schema_key(&self) -> &'static str {
        "pedagogical_explanation"
    }

    fn schema_fragment(&self, _lang: &L) -> serde_json::Value {
        serde_json::json!({
            "type": "string",
            "description": concat!(
                "PEDAGOGICAL EXPLANATION FORMAT:\n",
                "Write the ENTIRE explanation in the learner's interface language.\n",
                "The field must be an HTML string (no markdown). Structure it as follows:\n\n",
                "1. **Translations**: Start with literal and natural translations (if they differ).\n",
                "   Use: <p><b>Translations:</b><br><i>Lit:</i> ...<br><i>Nat:</i> ...</p>\n\n",
                "2. **Analysis**: A bullet list analyzing key grammatical components of the sentence.\n",
                "   - Focus on the grammar concepts relevant to the skill being tested.\n",
                "   - Highlight verbs in <span style='color:#e74c3c'><b>red</b></span>, ",
                "nouns/subjects in <span style='color:#3498db'><b>blue</b></span>, ",
                "grammar rules/cases in <span style='color:#27ae60'><b>green</b></span>.\n",
                "   - Do NOT analyze every single trivial word. Merge concepts where natural.\n",
                "   Use: <p><b>Analysis:</b></p><ul><li>...</li></ul>\n\n",
                "3. **Grammar Recap**: A summary box of the specific declensions, conjugations, or rules used.\n",
                "   Use: <div style='background-color:#3a3a3a;color:#e0e0e0;padding:10px;",
                "border-radius:5px;margin-top:10px;border-left:4px solid #3498db'>",
                "<b>Grammar Recap:</b><br>...</div>\n\n",
                "IMPORTANT: No introductory or concluding chatter. No \"Here is...\" or \"Great example!\". ",
                "Just the structured analysis."
            )
        })
    }

    fn prompt_fragment(&self, _lang: &L, ctx: &ComponentContext) -> String {
        let mut s = format!(
            "Write a clear, pedagogically useful explanation of the sentence in {}.",
            ctx.learner_ui_language
        );
        if !ctx.linguistic_background.is_empty() {
            s.push_str(
                " When genuinely helpful, use the learner's known languages as cognitive bridges.",
            );
        }
        s
    }
}