From 40ac46daf8548ebace1cebac895c9cf4b67e45cd Mon Sep 17 00:00:00 2001
From: Richard Eckart de Castilho <richard.eckart@gmail.com>
Date: Fri, 1 Dec 2023 06:37:45 +0100
Subject: [PATCH] #4292 - ollama-based recommender

- Template variable hints
---
 .../ollama/OllamaRecommenderTraitsEditor.html |  3 ++-
 .../ollama/OllamaRecommenderTraitsEditor.java | 16 ++++++++++-
 .../imls/ollama/prompt/PromptingMode.java     | 27 ++++++++++++++++---
 3 files changed, 41 insertions(+), 5 deletions(-)

diff --git a/inception/inception-imls-ollama/src/main/java/de/tudarmstadt/ukp/inception/recommendation/imls/ollama/OllamaRecommenderTraitsEditor.html b/inception/inception-imls-ollama/src/main/java/de/tudarmstadt/ukp/inception/recommendation/imls/ollama/OllamaRecommenderTraitsEditor.html
index f7857ab63c8..010b3773ffe 100644
--- a/inception/inception-imls-ollama/src/main/java/de/tudarmstadt/ukp/inception/recommendation/imls/ollama/OllamaRecommenderTraitsEditor.html
+++ b/inception/inception-imls-ollama/src/main/java/de/tudarmstadt/ukp/inception/recommendation/imls/ollama/OllamaRecommenderTraitsEditor.html
@@ -77,9 +77,10 @@
     <div class="row form-row" wicket:enclosure="prompt">
       <label class="col-sm-3 col-form-label" wicket:for="prompt">
         <wicket:message key="prompt"/>
-        <div class="small text-muted">
+        <div class="small text-muted mb-2">
           <i class="fas fa-torii-gate"></i> Jinja supported
         </div>
+        <div wicket:id="promptHints" class="small text-muted"/>
       </label>
       <div class="col-sm-9">
         <textarea wicket:id="prompt" class="form-control" rows="10"/>
diff --git a/inception/inception-imls-ollama/src/main/java/de/tudarmstadt/ukp/inception/recommendation/imls/ollama/OllamaRecommenderTraitsEditor.java b/inception/inception-imls-ollama/src/main/java/de/tudarmstadt/ukp/inception/recommendation/imls/ollama/OllamaRecommenderTraitsEditor.java
index be45444bed1..4b59dd142e9 100644
--- a/inception/inception-imls-ollama/src/main/java/de/tudarmstadt/ukp/inception/recommendation/imls/ollama/OllamaRecommenderTraitsEditor.java
+++ b/inception/inception-imls-ollama/src/main/java/de/tudarmstadt/ukp/inception/recommendation/imls/ollama/OllamaRecommenderTraitsEditor.java
@@ -35,6 +35,7 @@
 import org.apache.wicket.markup.html.list.ListView;
 import org.apache.wicket.model.CompoundPropertyModel;
 import org.apache.wicket.model.IModel;
+import org.apache.wicket.model.LoadableDetachableModel;
 import org.apache.wicket.model.Model;
 import org.apache.wicket.model.PropertyModel;
 import org.apache.wicket.model.util.ListModel;
@@ -49,6 +50,7 @@
 import de.tudarmstadt.ukp.inception.support.lambda.LambdaAjaxFormComponentUpdatingBehavior;
 import de.tudarmstadt.ukp.inception.support.lambda.LambdaAjaxLink;
 import de.tudarmstadt.ukp.inception.support.lambda.LambdaAjaxSubmitLink;
+import de.tudarmstadt.ukp.inception.support.markdown.MarkdownLabel;
 
 public class OllamaRecommenderTraitsEditor
     extends AbstractTraitsEditor
@@ -109,7 +111,14 @@ protected void onSubmit()
         form.add(new TextField<String>("model"));
         form.add(new TextArea<String>("prompt"));
         form.add(new CheckBox("raw").setOutputMarkupPlaceholderTag(true));
-        form.add(new PromptingModeSelect("promptingMode"));
+        var markdownLabel = new MarkdownLabel("promptHints",
+                LoadableDetachableModel.of(this::getPromptHints));
+        markdownLabel.setOutputMarkupId(true);
+        form.add(markdownLabel);
+        form.add(new PromptingModeSelect("promptingMode")
+                .add(new LambdaAjaxFormComponentUpdatingBehavior("change", _target -> {
+                    _target.add(markdownLabel);
+                })));
         form.add(new ExtractionModeSelect("extractionMode"));
         form.add(new OllamaResponseFormatSelect("format"));
         add(form);
@@ -169,4 +178,9 @@ private void removeOptionSetting(AjaxRequestTarget aTarget, OptionSetting aBindi
         optionSettings.getObject().remove(aBinding);
         aTarget.add(optionSettingsContainer);
     }
+
+    private String getPromptHints()
+    {
+        return traits.getObject().getPromptingMode().getHints();
+    }
 }
diff --git a/inception/inception-imls-ollama/src/main/java/de/tudarmstadt/ukp/inception/recommendation/imls/ollama/prompt/PromptingMode.java b/inception/inception-imls-ollama/src/main/java/de/tudarmstadt/ukp/inception/recommendation/imls/ollama/prompt/PromptingMode.java
index 56ec5a40e90..dc54330b650 100644
--- a/inception/inception-imls-ollama/src/main/java/de/tudarmstadt/ukp/inception/recommendation/imls/ollama/prompt/PromptingMode.java
+++ b/inception/inception-imls-ollama/src/main/java/de/tudarmstadt/ukp/inception/recommendation/imls/ollama/prompt/PromptingMode.java
@@ -22,11 +22,32 @@
 public enum PromptingMode
 {
     @JsonProperty("per-annotation")
-    PER_ANNOTATION, //
+    PER_ANNOTATION("""
+            Template variables:
+            * `text`: annotation text,
+            * `sentence`: sentence containing annotation,
+            * `examples`: labeled annotations"""),
 
     @JsonProperty("per-sentence")
-    PER_SENTENCE, //
+    PER_SENTENCE("""
+            Template variables:
+            * `text`: sentence text,
+            * `examples`: labeled annotations"""),
 
     @JsonProperty("per-document")
-    PER_DOCUMENT
+    PER_DOCUMENT("""
+            Template variables:
+            * `text`: document text""");
+
+    private final String hints;
+
+    private PromptingMode(String aHints)
+    {
+        hints = aHints;
+    }
+
+    public String getHints()
+    {
+        return hints;
+    }
 }