Merge pull request #44 from WSE-research/threeshot_input_generative

Added three-shot (input) and zero-shot (output) generative support

pom.xml

@@ -10,7 +10,7 @@
     </parent>
     <groupId>com.wse</groupId>
     <artifactId>qanary-explanation-service</artifactId>
-    <version>3.4.1</version>
+    <version>3.5.0</version>
     <name>Qanary explanation service</name>
     <description>Webservice for rule-based explanation of QA-Systems as well as specific components</description>
     <properties>

src/main/java/com/wse/qanaryexplanationservice/repositories/QanaryRepository.java

@@ -51,7 +51,6 @@ public QanaryResponseObject executeQanaryPipeline(QanaryRequestObject qanaryRequ
         MultiValueMap<String, String> multiValueMap = new LinkedMultiValueMap();
         multiValueMap.add("question", qanaryRequestObject.getQuestion());
         multiValueMap.addAll(qanaryRequestObject.getComponentListAsMap());
-
         return webClient.post().uri(uriBuilder -> uriBuilder // TODO: use new endpoint for question answering
                         .scheme("http").host(QANARY_PIPELINE_HOST).port(QANARY_PIPELINE_PORT).path("/startquestionansweringwithtextquestion")
                         .queryParams(multiValueMap)
@@ -75,6 +74,7 @@ public void initConnection() {
     }
 
     public String getQuestionFromQuestionId(String questionId) {
+        logger.info("Get question from url: {}", questionId);
         return webClient.get().uri(questionId).retrieve().bodyToMono(String.class).block();
     }
 

src/main/java/com/wse/qanaryexplanationservice/services/GenerativeExplanations.java

@@ -70,6 +70,7 @@ public class GenerativeExplanations {
         put("^^http://www.w3.org/2001/XMLSchema#double", "");
     }};
     private static final Map<Integer, String> EXAMPLE_COUNT_AND_TEMPLATE = new HashMap<>() {{
+        put(0, "/prompt_templates/outputdata/zeroshot");
         put(1, "/prompt_templates/outputdata/oneshot");
         put(2, "/prompt_templates/outputdata/twoshot");
         put(3, "/prompt_templates/outputdata/threeshot");
@@ -79,6 +80,7 @@ public class GenerativeExplanations {
         put(1, "/prompt_templates/inputdata/oneshot");
         put(2, "/prompt_templates/inputdata/twoshot");
         put(0, "/prompt_templates/inputdata/zeroshot");
+        put(3, "/prompt_templates/inputdata/threeshot");
     }};
     private static final String EXPLANATION_NAMESPACE = "urn:qanary:explanations#";
     private static final String QUESTION_QUERY = "/queries/random_question_query.rq";

src/main/java/com/wse/qanaryexplanationservice/services/GenerativeExplanationsService.java

@@ -156,8 +156,6 @@ public String createPrompt(int shots, GenerativeExplanationObject generativeExpl
                 generativeExplanations.getPromptTemplate(shots)
         );
 
-        logger.info("Shots {} and Object {}", shots, generativeExplanationObject.getExampleComponents().get(0).getExplanation());
-
         prompt = prompt.replace("<TASK_RDF_DATA_TEST>", generativeExplanationObject.getTestComponent().getDataSet());
 
         ArrayList<TestDataObject> testDataObjects = generativeExplanationObject.getExampleComponents();
@@ -194,14 +192,17 @@ public String sendPrompt(String prompt, GptModel gptModel) throws Exception {
      */
     public String getInputDataExplanationPrompt(QanaryComponent component, String body, int shots) throws Exception {
         String prompt = getStringFromFile(generativeExplanations.getPromptTemplateInputData(shots));
-
         prompt = prompt.replace("${QUERY}", body).replace("${COMPONENT}", component.getPrefixedComponentName());
         if (shots > 0) {
             InputQueryExample inputQueryExample = GenerativeExplanations.INPUT_QUERIES_AND_EXAMPLE.get(random.nextInt(GenerativeExplanations.INPUT_QUERIES_AND_EXAMPLE.size()));
             prompt = prompt.replace("${ZEROSHOT_QUERY}", inputQueryExample.getQuery()).replace("${ZEROSHOT_EXPLANATION", inputQueryExample.getExplanations()); // select random pre-defined statements
             if (shots > 1) {
                 InputQueryExample inputQueryExample2 = GenerativeExplanations.INPUT_QUERIES_AND_EXAMPLE.get(random.nextInt(GenerativeExplanations.INPUT_QUERIES_AND_EXAMPLE.size()));
                 prompt = prompt.replace("${ONESHOT_QUERY}", inputQueryExample2.getQuery()).replace("${ONESHOT_EXPLANATION", inputQueryExample2.getExplanations()); // select random pre-defined statements
+                if (shots > 2) {
+                    InputQueryExample inputQueryExample3 = GenerativeExplanations.INPUT_QUERIES_AND_EXAMPLE.get(random.nextInt(GenerativeExplanations.INPUT_QUERIES_AND_EXAMPLE.size()));
+                    prompt = prompt.replace("${TWOSHOT_QUERY}", inputQueryExample3.getQuery()).replace("${TWOSHOT_EXPLANATION", inputQueryExample3.getExplanations()); // select random pre-defined statements
+                }
             }
         }
         return prompt;

src/main/resources/prompt_templates/inputdata/threeshot

@@ -0,0 +1,33 @@
+Given the following context: Here, we consider the data of a Question Answering system. The data describes a SPARQL query. As a user I'd like to understand what the query means and does. For this purpose a (text-based) explanation has to be computed.
+Here's an example explanation:
+The query:
+```
+"${ZEROSHOT_QUERY}"
+```
+The example explanation:
+"${ZEROSHOT_EXPLANATION}"
+
+Another example is the following:
+The query:
+```
+${ONESHOT_QUERY}
+```
+The 2nd example explanation:
+"${ONESHOT_EXPLANATION}"
+
+And lastly an 3rd example:
+The query
+```
+"${TWOSHOT_QUERY}"
+```
+The 3rd explanation:
+```
+"${TWOSHOT_EXPLANATION}"
+```
+
+Now explain the following query, used by the component "${COMPONENT}":
+```
+${QUERY}
+```
+
+Don't use more than 3 sentences.

src/main/resources/prompt_templates/outputdata/zeroshot

@@ -0,0 +1,12 @@
+Given the following context:
+Here, we consider the data of a Question Answering system.
+The data describes the outcome of this system.
+As a user I'd like to understand what happened inside that particular component.
+For this purpose a (text-based) explanation has to be computed.
+
+Given is the following data:
+<TASK_RDF_DATA_TEST>
+
+Now, create an explanation for this data.
+
+Don't introduce your answer and only return the result.