Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rbyh committed Sep 20, 2024
1 parent d00bdae commit a952130
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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*.
Expand Down Expand Up @@ -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.

Expand Down

0 comments on commit a952130

Please sign in to comment.