From a952130dc20e3ee5473420e71130a3cf674061de Mon Sep 17 00:00:00 2001 From: robin Date: Fri, 20 Sep 2024 14:37:25 -0400 Subject: [PATCH] updating docs --- CHANGELOG.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bf1d0743..58dac7f9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,14 +5,17 @@ - New fields for `Question` objects: `include_comment`: bool = True + `use_code`: bool = False `answering_instructions`: Optional[str] = None `question_presentation`: Optional[str] = None `permissive`: bool = False -- Optional `Question` paramaters `answering_instructions` and `question_presentation` allow you to control exact prompt language and separate instructions for the presentation of a question. - - Optional `Question` parameter `include_comment = False` allows you to turn off the comment field that is automatically added to all question types other than `QuestionFreeText`. +- Optional `Question` parameter `use_code = True` modifies the question prompt to instruct the model to return the (integer) code for the selected question option in lieu of the question option text. + +- Optional `Question` paramaters `answering_instructions` and `question_presentation` allow you to control exact prompt language and separate instructions for the presentation of a question. + - Optional boolean `Question` parameter `permissive` allows you to turn off enforcement of question constraints (e.g., if min/max selections for a checkbox question have been specified, you can set `permissive = True` to allow responses that fewer or greater selections). - `Question` method `loop()` allows you to create multiple versions of a question when you are constructing a survey. It takes a `ScenarioList` and automatically creates a copy of the question for each scenario, which can then be passed as a list to a `Survey`. This is different from adding scenarios to a question or survey (using the `by()` method) *at the time that the question or survey is run*. @@ -46,6 +49,8 @@ - Question validation methods no longer use JSON. This will eliminate exceptions relating to JSON errors previously common to certain models. +- Base agent instructions template is not added to a job if no agent is used with a survey (reducing tokens). + ### Fixed - Bug in enforcement of token/rate limits.