Questions

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, Score, and Box 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 Description of the yes outcome as text, an asset, a JSON object, or an array; None leaves it undescribed.

false

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

typesafe_sdk.Noul

pydantic-model

Implementation
Overload 1
Overload 2

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": {
    "Content": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        }
      ]
    },
    "ContentValue": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        }
      ]
    },
    "NoulCriteria": {
      "additionalProperties": false,
      "description": "Optional descriptions of the yes and no outcomes.\n\nSee the [noul primitive](https://docs.typesafe.ai/go/noul) for details.",
      "properties": {
        "true": {
          "anyOf": [
            {
              "$ref": "#/$defs/Content"
            },
            {
              "type": "null"
            }
          ]
        },
        "false": {
          "anyOf": [
            {
              "$ref": "#/$defs/Content"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "title": "NoulCriteria",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "description": "A yes/no question with optional descriptions for either outcome.\n\nSee the [noul primitive](https://docs.typesafe.ai/go/noul) for details.",
  "properties": {
    "type": {
      "const": "noul",
      "default": "noul",
      "title": "Type",
      "type": "string"
    },
    "instructions": {
      "anyOf": [
        {
          "$ref": "#/$defs/Content"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "criteria": {
      "anyOf": [
        {
          "$ref": "#/$defs/NoulCriteria"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "title": "Noul",
  "type": "object"
}

Fields:

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

instructions

pydantic-field The question to ask, expressed as text, an asset, a JSON object, or an array; optional when criteria describes an outcome.

criteria

pydantic-field Optional descriptions of the yes and no outcomes; required when instructions is None.

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": {
    "Content": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        }
      ]
    },
    "ContentValue": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        }
      ]
    }
  },
  "additionalProperties": false,
  "description": "A question that selects between named alternatives.\n\nSee the [choice primitive](https://docs.typesafe.ai/go/choice) for details.",
  "properties": {
    "type": {
      "const": "choice",
      "default": "choice",
      "title": "Type",
      "type": "string"
    },
    "instructions": {
      "anyOf": [
        {
          "$ref": "#/$defs/Content"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "criteria": {
      "additionalProperties": {
        "anyOf": [
          {
            "$ref": "#/$defs/Content"
          },
          {
            "type": "null"
          }
        ]
      },
      "title": "Criteria",
      "type": "object"
    }
  },
  "required": [
    "criteria"
  ],
  "title": "Choice",
  "type": "object"
}

Fields:

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

criteria

pydantic-field A nonempty mapping of labels to text, asset, object, or array descriptions, or None for undescribed labels.

instructions

pydantic-field The question to ask, expressed as text, an asset, 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": {
    "Content": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        }
      ]
    },
    "ContentValue": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        }
      ]
    }
  },
  "additionalProperties": false,
  "description": "A question that assigns a score using an ordered rubric.\n\nSee the [score primitive](https://docs.typesafe.ai/go/score) for details.",
  "properties": {
    "type": {
      "const": "score",
      "default": "score",
      "title": "Type",
      "type": "string"
    },
    "instructions": {
      "anyOf": [
        {
          "$ref": "#/$defs/Content"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "criteria": {
      "items": {
        "$ref": "#/$defs/Content"
      },
      "minItems": 1,
      "title": "Criteria",
      "type": "array"
    }
  },
  "required": [
    "criteria"
  ],
  "title": "Score",
  "type": "object"
}

Fields:

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

criteria

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

instructions

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

typesafe_sdk.Box

pydantic-model Bases: _Question, wire.BoxQuestion A question that locates what its instructions describe in the request’s image. Examples:

from pathlib import Path

from typesafe_sdk import Box, BoxAnswer, Image, TypeSafeClient


def locate_dog(client: TypeSafeClient, photo: Path) -> BoxAnswer:
    result = client.system_one(
        state=Image(photo),
        questions={"dog": Box(instructions="The dog")},
        model="jev-preview",
    )
    return result.boxes["dog"]

Show JSON schema:

Details

{
  "$defs": {
    "Content": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        }
      ]
    },
    "ContentValue": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "array"
        },
        {
          "additionalProperties": {
            "anyOf": [
              {
                "$ref": "#/$defs/ContentValue"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        }
      ]
    }
  },
  "additionalProperties": false,
  "description": "A question that locates what its instructions describe in the request's image.\n\nExamples:\n    ```python\n    from pathlib import Path\n\n    from typesafe_sdk import Box, BoxAnswer, Image, TypeSafeClient\n\n\n    def locate_dog(client: TypeSafeClient, photo: Path) -> BoxAnswer:\n        result = client.system_one(\n            state=Image(photo),\n            questions={\"dog\": Box(instructions=\"The dog\")},\n            model=\"jev-preview\",\n        )\n        return result.boxes[\"dog\"]\n    ```",
  "properties": {
    "type": {
      "const": "box",
      "default": "box",
      "title": "Type",
      "type": "string"
    },
    "instructions": {
      "anyOf": [
        {
          "$ref": "#/$defs/Content"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "title": "Box",
  "type": "object"
}

Fields:

type (Literal[‘box’])
instructions (Content | None)

instructions

pydantic-field What to locate in the request’s image, expressed as text, an asset, a JSON object, or an array; optional.

typesafe_sdk.Question

module-attribute A question object or question dictionary.

typesafe_sdk.Questions

module-attribute Question inputs keyed by the names used to identify their answers.

Question dictionaries

Question dictionaries include a type key: "noul", "choice", "score", or "box". 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

instructions

instance-attribute The question to ask, expressed as text, an asset, a JSON object, or an array; optional when criteria describes an outcome.

criteria

instance-attribute Optional descriptions of the yes and no outcomes; required when instructions is None.

typesafe_sdk.ChoiceModel

Bases: TypedDict A choice question dictionary with type="choice". See the choice primitive for details.

type

instance-attribute

instructions

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

criteria

instance-attribute A nonempty mapping of labels to text, asset, 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

instructions

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

criteria

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

typesafe_sdk.BoxModel

Bases: TypedDict A box question dictionary with type="box".

type

instance-attribute

instructions

instance-attribute What to locate in the request’s image, expressed as text, an asset, a JSON object, or an array; optional.

typesafe_sdk.QuestionModel

module-attribute A question dictionary identified by its type key.

Reference

API reference

Client SDKs

State

Question objects

typesafe_sdk.NoulCriteria

true

false

typesafe_sdk.Noul

instructions

criteria

typesafe_sdk.Choice

criteria

instructions

typesafe_sdk.Score

criteria

instructions

typesafe_sdk.Box

instructions

typesafe_sdk.Question

typesafe_sdk.Questions

Question dictionaries

typesafe_sdk.NoulModel

type

instructions

criteria

typesafe_sdk.ChoiceModel

type

instructions

criteria

typesafe_sdk.ScoreModel

type

instructions

criteria

typesafe_sdk.BoxModel

type

instructions

typesafe_sdk.QuestionModel

​State

​Question objects

​typesafe_sdk.NoulCriteria

​true

​false

​typesafe_sdk.Noul

​instructions

​criteria

​typesafe_sdk.Choice

​criteria

​instructions

​typesafe_sdk.Score

​criteria

​instructions

​typesafe_sdk.Box

​instructions

​typesafe_sdk.Question

​typesafe_sdk.Questions

​Question dictionaries

​typesafe_sdk.NoulModel

​type

​instructions

​criteria

​typesafe_sdk.ChoiceModel

​type

​instructions

​criteria

​typesafe_sdk.ScoreModel

​type

​instructions

​criteria

​typesafe_sdk.BoxModel

​type

​instructions

​typesafe_sdk.QuestionModel

State

Question objects

typesafe_sdk.NoulCriteria

true

false

typesafe_sdk.Noul

instructions

criteria

typesafe_sdk.Choice

criteria

instructions

typesafe_sdk.Score

criteria

instructions

typesafe_sdk.Box

instructions

typesafe_sdk.Question

typesafe_sdk.Questions

Question dictionaries

typesafe_sdk.NoulModel

type

instructions

criteria

typesafe_sdk.ChoiceModel

type

instructions

criteria

typesafe_sdk.ScoreModel

type

instructions

criteria

typesafe_sdk.BoxModel

type

instructions

typesafe_sdk.QuestionModel