kobotoolbox / kpi / 23050028172 / 3

82%

master: 76%

push

github

feat(qual): add question and choice hints DEV-714 (#6813)

### 📣 Summary
Allow users to add hints to QA questions and choices.


### 📖 Description
Question/choice hints will be sent to the LLM to assist with processing.


### 💭 Notes
What it says on the tin. The only extra change is putting some of the
manual_qual tests inside a class so we can use the `ddt` class
decorator. This PR handles updating the schemas and documentation
examples as well.

### 👀 Preview steps

1. ℹ️ have an account and a project with an audio question and at least
one submission
2. Add a transcript 
3. Add either a multiple- or single-choice QA question (to make it
easier, have just one option)
4. Update the new question by PATCHing
`api/v2/assets/{asset_uid}/advanced-features/{manual_qual_uid}` with
```
{
  "params": [
     {
         "uuid": "<question uuid>",
         "type": "<question type>",
         "labels": {"_default": "<question text>"},
         "hint": {"labels": {"_default": "This is a question hint"}},
         "choices": [
             {
                 "labels": {"_default": "<choice text>"}
                 "uuid": "<choice uuid>"
                 "hint": {"labels": {"_default": "This is a choice hint"}}
             }
          ]
     }
  ]
}
```
5. Request an AI-generated answer
6. 🟢 [on PR] In the kpi logs, it will show the prompt sent to the LLM.
The prompt should contain both the question and the choice hints

3596 of 11508 branches covered (31.25%)

19184 of 35238 relevant lines covered (54.44%)

0.54 hits per line