> ## Documentation Index
> Fetch the complete documentation index at: https://docs.typesafe.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Questions
> Provide state and ask yes/no, choice, and score questions using objects or dictionaries.
export function SdkSignature({children}) {
async function copy(event) {
const button = event.currentTarget;
const code = button.parentElement.querySelector("pre code");
try {
await navigator.clipboard.writeText(code.textContent);
button.setAttribute("aria-label", "Signature copied");
button.dataset.copied = "true";
} catch {
button.setAttribute("aria-label", "Copy failed; select the signature to copy");
}
setTimeout(() => {
button.setAttribute("aria-label", "Copy signature");
delete button.dataset.copied;
}, 2000);
}
return ;
}
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
Bases: TypedDict
Optional descriptions of the yes and no outcomes.
true instance-attribute
{"true"}{":"}{" "}{"("}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"None"}{"\n"}{")"}{"\n"}
Description of the yes outcome as text, a JSON object, or an array; `None` leaves it undescribed.
false instance-attribute
{"false"}{":"}{" "}{"("}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"None"}{"\n"}{")"}{"\n"}
Description of the no outcome as text, a JSON object, or an array; `None` leaves it undescribed.
typesafe\_sdk.Noul
Bases: `wire.NoulQuestion`
A yes/no question with optional descriptions for either outcome.
See the [noul primitive](https://docs.typesafe.ai/primitives/noul) for details.
instructions class-attribute instance-attribute
{"instructions"}{":"}{" "}{"("}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"None"}{"\n"}{")"}{" "}{"="}{" "}{"None"}{"\n"}
The question to ask, expressed as text, a JSON object, or an array; optional.
criteria class-attribute instance-attribute
{"criteria"}
{":"}
{" "}
{"NoulCriteria"}
{" "}
{"|"}
{" "}
{"None"}
{" "}
{"="}
{" "}
{"None"}
{"\n"}
Optional descriptions of the yes and no outcomes.
typesafe\_sdk.Choice
Bases: `wire.ChoiceQuestion`
A question that selects between named alternatives.
See the [choice primitive](https://docs.typesafe.ai/primitives/choice) for details.
criteria instance-attribute
{"criteria"}{":"}{" "}{"dict"}{"["}{"\n"}{" "}{"str"}{","}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"None"}{","}{"\n"}{"]"}{"\n"}
Labels mapped to text, object, or array descriptions, or `None` for undescribed labels.
instructions class-attribute instance-attribute
{"instructions"}{":"}{" "}{"("}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"None"}{"\n"}{")"}{" "}{"="}{" "}{"None"}{"\n"}
The question to ask, expressed as text, a JSON object, or an array; optional.
typesafe\_sdk.Score
Bases: `wire.ScoreQuestion`
A question that assigns a score using an ordered rubric.
See the [score primitive](https://docs.typesafe.ai/primitives/score) for details.
criteria instance-attribute
{"criteria"}{":"}{" "}{"("}{"\n"}{" "}{"list"}{"["}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"]"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"\n"}{" "}{"int"}{","}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"],"}{"\n"}{" "}{"]"}{"\n"}{")"}{"\n"}
Nonempty text, object, or array descriptions indexed from zero, with no gaps in dictionary keys.
instructions class-attribute instance-attribute
{"instructions"}{":"}{" "}{"("}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"None"}{"\n"}{")"}{" "}{"="}{" "}{"None"}{"\n"}
The question to ask, expressed as text, a JSON object, or an array; optional.
typesafe\_sdk.Question module-attribute
{"Question"}{":"}{" "}{"TypeAlias"}{" "}{"="}{" "}{"("}{"\n"}{" "}{"Noul"}{" "}{"|"}{" "}{"Choice"}{" "}{"|"}{" "}{"Score"}{" "}{"|"}{" "}{"QuestionModel"}{"\n"}{")"}{"\n"}
A question object or question dictionary.
typesafe\_sdk.Questions module-attribute
{"Questions"}
{":"}
{" "}
{"TypeAlias"}
{" "}
{"="}
{" "}
{"Mapping"}
{"["}
{"str"}
{","}
{" "}
{"Question"}
{"]"}
{"\n"}
Question inputs keyed by the names used to identify their answers.
Question dictionaries
Question dictionaries include a `type` key: `"noul"`, `"choice"`, or `"score"`. You can mix dictionaries and question objects in the same request.
typesafe\_sdk.NoulModel
Bases: TypedDict
A yes/no question dictionary with `type="noul"`, allowing extra JSON fields.
type instance-attribute
{"type"}
{":"}
{" "}
{"Literal"}
{"["}
{"'noul'"}
{"]"}
{"\n"}
instructions instance-attribute
{"instructions"}{":"}{" "}{"NotRequired"}{"["}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"None"}{"\n"}{"]"}{"\n"}
The question to ask, expressed as text, a JSON object, or an array; optional.
criteria instance-attribute
{"criteria"}
{":"}
{" "}
{"NotRequired"}
{"["}
{"NoulCriteria"}
{" "}
{"|"}
{" "}
{"None"}
{"]"}
{"\n"}
Optional descriptions of the yes and no outcomes.
typesafe\_sdk.ChoiceModel
Bases: TypedDict
A choice question dictionary with `type="choice"`, allowing extra JSON fields.
type instance-attribute
{"type"}
{":"}
{" "}
{"Literal"}
{"["}
{"'choice'"}
{"]"}
{"\n"}
instructions instance-attribute
{"instructions"}{":"}{" "}{"NotRequired"}{"["}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"None"}{"\n"}{"]"}{"\n"}
The question to ask, expressed as text, a JSON object, or an array; optional.
criteria instance-attribute
{"criteria"}{":"}{" "}{"dict"}{"["}{"\n"}{" "}{"str"}{","}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"None"}{","}{"\n"}{"]"}{"\n"}
Labels mapped to text, object, or array descriptions, or `None` for undescribed labels.
typesafe\_sdk.ScoreModel
Bases: TypedDict
A score question dictionary with `type="score"`, allowing extra JSON fields.
type instance-attribute
{"type"}
{":"}
{" "}
{"Literal"}
{"["}
{"'score'"}
{"]"}
{"\n"}
instructions instance-attribute
{"instructions"}{":"}{" "}{"NotRequired"}{"["}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"None"}{"\n"}{"]"}{"\n"}
The question to ask, expressed as text, a JSON object, or an array; optional.
criteria instance-attribute
{"criteria"}{":"}{" "}{"("}{"\n"}{" "}{"list"}{"["}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"]"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"\n"}{" "}{"int"}{","}{"\n"}{" "}{"str"}{"\n"}{" "}{"|"}{" "}{"dict"}{"["}{"str"}{","}{" "}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"]"}{"\n"}{" "}{"|"}{" "}{"list"}{"["}{"JSONValue"}{" "}{"|"}{" "}{"None"}{"],"}{"\n"}{" "}{"]"}{"\n"}{")"}{"\n"}
Nonempty text, object, or array descriptions indexed from zero, with no gaps in dictionary keys.
typesafe\_sdk.QuestionModel module-attribute
{"QuestionModel"}{":"}{" "}{"TypeAlias"}{" "}{"="}{" "}{"("}{"\n"}{" "}{"NoulModel"}{" "}{"|"}{" "}{"ChoiceModel"}{" "}{"|"}{" "}{"ScoreModel"}{"\n"}{")"}{"\n"}
A question dictionary identified by its `type` key.