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

Bases: TypedDict

Optional descriptions of the yes and no outcomes.

See the noul primitive for details.

true

instance-attribute

true: JSONContent | None

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

false

instance-attribute

false: JSONContent | None

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

typesafe_sdk.Noul

pydantic-model

Bases: _Question, wire.NoulQuestion

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

See the noul primitive for details.

Show JSON schema:

Details

{
  "$defs": {
    "JSONContent": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/JSONValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/JSONValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        }
      ]
    },
    "JSONValue": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/JSONValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/JSONValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        }
      ]
    },
    "NoulCriteria": {
      "additionalProperties": false,
      "description": "Optional descriptions of the yes and no outcomes.\n\nSee the [noul primitive](../../../../primitives/noul) for details.",
      "properties": {
        "true": {
          "anyOf": [
            {
              "$ref": "#/$defs/JSONContent"
            },
            {
              "type": "null"
            }
          ]
        },
        "false": {
          "anyOf": [
            {
              "$ref": "#/$defs/JSONContent"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "title": "NoulCriteria",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "description": "A yes/no question with optional descriptions for either outcome.\n\nSee the [noul primitive](../../../../primitives/noul) for details.",
  "properties": {
    "type": {
      "const": "noul",
      "default": "noul",
      "title": "Type",
      "type": "string"
    },
    "instructions": {
      "anyOf": [
        {
          "$ref": "#/$defs/JSONContent"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "criteria": {
      "anyOf": [
        {
          "$ref": "#/$defs/NoulCriteria"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "title": "Noul",
  "type": "object"
}

Fields:

type (Literal[‘noul’])
instructions (JSONContent | None)
criteria (NoulCriteria | None)

instructions

pydantic-field

instructions: JSONContent | None = None

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

criteria

pydantic-field

criteria: NoulCriteria | None = None

Optional descriptions of the yes and no outcomes.

typesafe_sdk.Choice

pydantic-model

Bases: _Question, wire.ChoiceQuestion

A question that selects between named alternatives.

See the choice primitive for details.

Show JSON schema:

Details

{
  "$defs": {
    "JSONContent": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/JSONValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/JSONValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        }
      ]
    },
    "JSONValue": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/JSONValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/JSONValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        }
      ]
    }
  },
  "additionalProperties": false,
  "description": "A question that selects between named alternatives.\n\nSee the [choice primitive](../../../../primitives/choice) for details.",
  "properties": {
    "type": {
      "const": "choice",
      "default": "choice",
      "title": "Type",
      "type": "string"
    },
    "instructions": {
      "anyOf": [
        {
          "$ref": "#/$defs/JSONContent"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "criteria": {
      "additionalProperties": {
        "anyOf": [
          {
            "$ref": "#/$defs/JSONContent"
          },
          {
            "type": "null"
          }
        ]
      },
      "title": "Criteria",
      "type": "object"
    }
  },
  "required": [
    "criteria"
  ],
  "title": "Choice",
  "type": "object"
}

Fields:

type (Literal[‘choice’])
criteria (Mapping[str, JSONContent | None])
instructions (JSONContent | None)

criteria

pydantic-field

criteria: Mapping[str, JSONContent | None]

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

instructions

pydantic-field

instructions: JSONContent | None = None

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

typesafe_sdk.Score

pydantic-model

Bases: _Question, wire.ScoreQuestion

A question that assigns a score using an ordered rubric.

See the score primitive for details.

Show JSON schema:

Details

{
  "$defs": {
    "JSONContent": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/JSONValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/JSONValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        }
      ]
    },
    "JSONValue": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/JSONValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/JSONValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        }
      ]
    }
  },
  "additionalProperties": false,
  "description": "A question that assigns a score using an ordered rubric.\n\nSee the [score primitive](../../../../primitives/score) for details.",
  "properties": {
    "type": {
      "const": "score",
      "default": "score",
      "title": "Type",
      "type": "string"
    },
    "instructions": {
      "anyOf": [
        {
          "$ref": "#/$defs/JSONContent"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "criteria": {
      "items": {
        "$ref": "#/$defs/JSONContent"
      },
      "title": "Criteria",
      "type": "array"
    }
  },
  "required": [
    "criteria"
  ],
  "title": "Score",
  "type": "object"
}

Fields:

type (Literal[‘score’])
criteria (Sequence[JSONContent])
instructions (JSONContent | None)

criteria

pydantic-field

criteria: Sequence[JSONContent]

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

instructions

pydantic-field

instructions: JSONContent | None = None

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

typesafe_sdk.Question

module-attribute

Question: TypeAlias = (
    Noul | Choice | Score | QuestionModel
)

A question object or question dictionary.

typesafe_sdk.Questions

module-attribute

Questions: TypeAlias = Mapping[str, Question]

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".

See the noul primitive for details.

type

instance-attribute

type: Literal['noul']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

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

criteria

instance-attribute

criteria: NotRequired[NoulCriteria | None]

Optional descriptions of the yes and no outcomes.

typesafe_sdk.ChoiceModel

Bases: TypedDict

A choice question dictionary with type="choice".

See the choice primitive for details.

type

instance-attribute

type: Literal['choice']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

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

criteria

instance-attribute

criteria: Mapping[str, JSONContent | None]

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".

See the score primitive for details.

type

instance-attribute

type: Literal['score']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

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

criteria

instance-attribute

criteria: Sequence[JSONContent]

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

typesafe_sdk.QuestionModel

module-attribute

QuestionModel: TypeAlias = (
    NoulModel | ChoiceModel | ScoreModel
)

A question dictionary identified by its type key.