questions.md

Questions

Provide state and ask yes/no, choice, and score questions using objects or dictionaries.

State

state is the text or JSON object you want to ask questions about. It cannot be None, but values inside an object may be None.

Question objects

Use Noul, Choice, and Score to define questions with named arguments.

typesafe_sdk.NoulCriteria

Optional descriptions of the yes and no outcomes.

true

instance-attribute

{"true"} {":"} {" "} {"JSONContent"} {" "} {"|"} {" "} {"None"} {"\n"}

Description of the yes outcome as text, a JSON object, or an array; None leaves it undescribed.

false

instance-attribute

{"false"} {":"} {" "} {"JSONContent"} {" "} {"|"} {" "} {"None"} {"\n"}

Description of the no outcome as text, a JSON object, or an array; None leaves it undescribed.

typesafe_sdk.Noul

pydantic-model

A yes/no question with optional descriptions for either outcome.

instructions

The question to ask, expressed as text, a JSON object, or an array; optional.

criteria

Optional descriptions of the yes and no outcomes.

typesafe_sdk.Choice

pydantic-model

A question that selects between named alternatives.

criteria

Labels mapped to text, object, or array descriptions, or None for undescribed labels.

instructions

The question to ask, expressed as text, a JSON object, or an array; optional.

typesafe_sdk.Score

pydantic-model

A question that assigns a score using an ordered rubric.

criteria

A nonempty, ordered list of text, object, or array descriptions, one per score from zero.

instructions

The question to ask, expressed as text, a JSON object, or an array; optional.