caretech-owl / gerd

Generating and evaluating relevant documentation (GERD)
https://towardsdatascience.com/running-llama-2-on-cpu-inference-for-document-q-a-3d636037a3d8
MIT License
4 stars 0 forks source link

[UC]: QA: Output format Json #22

Closed Depo14 closed 2 months ago

Depo14 commented 11 months ago

Summary

There should be the possibility to format the output of the process as json

Rationale

The json formatting should enable communication with other systems like the generation

Level

subfunction

Actors

QA_Service

Preconditions

-user input is present

Postconditions

Basic Flow

  1. User input is present
  2. Model generates a json output based on the prompt and the user input
  3. A validate function must check the json formating
  4. When the formatting is right, the response is displayed

Alternative Paths

4.1 If the formatting is wrong, an error is displayed

Visualisation

flowchart LR;
  1-->2
  2-->3
  3--json format-->4
  3--no json format -->4.1

Other related issues, use cases, features

16 #17