Fragen

Gib einen Zustand an und stelle Ja/Nein-, choice- und score-Fragen über Objekte oder Wörterbücher.

Zustand

state ist der Text oder das JSON-Objekt, zu dem du Fragen stellen möchtest. Er darf nicht None sein, aber Werte innerhalb eines Objekts dürfen None sein.

Frageobjekte

Verwende Noul, Choice und Score, um Fragen mit benannten Argumenten zu definieren.

typesafe_sdk.NoulCriteria

Basisklasse: TypedDict

Optionale Beschreibungen der Ja- und Nein-Ergebnisse.

Siehe das noul-Primitiv für Details.

true

instance-attribute

true: JSONContent | None

Beschreibung des Ja-Ergebnisses als Text, ein JSON-Objekt oder ein Array; None lässt es unbeschrieben.

false

instance-attribute

false: JSONContent | None

Beschreibung des Nein-Ergebnisses als Text, ein JSON-Objekt oder ein Array; None lässt es unbeschrieben.

typesafe_sdk.Noul

pydantic-model

Basisklasse: _Question, wire.NoulQuestion

Eine Ja/Nein-Frage mit optionalen Beschreibungen für beide Ergebnisse.

Siehe das noul-Primitiv für Details.

JSON-Schema anzeigen:

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

Felder:

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

instructions

pydantic-field

instructions: JSONContent | None = None

Die zu stellende Frage, ausgedrückt als Text, ein JSON-Objekt oder ein Array; optional.

criteria

pydantic-field

criteria: NoulCriteria | None = None

Optionale Beschreibungen der Ja- und Nein-Ergebnisse.

typesafe_sdk.Choice

pydantic-model

Basisklasse: _Question, wire.ChoiceQuestion

Eine Frage, die zwischen benannten Alternativen auswählt.

Siehe das choice-Primitiv für Details.

JSON-Schema anzeigen:

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

Felder:

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

criteria

pydantic-field

criteria: Mapping[str, JSONContent | None]

Labels, die auf Text-, Objekt- oder Array-Beschreibungen abgebildet werden, oder None für unbeschriebene Labels.

instructions

pydantic-field

instructions: JSONContent | None = None

Die zu stellende Frage, ausgedrückt als Text, ein JSON-Objekt oder ein Array; optional.

typesafe_sdk.Score

pydantic-model

Basisklasse: _Question, wire.ScoreQuestion

Eine Frage, die anhand einer geordneten Rubrik einen Score vergibt.

Siehe das score-Primitiv für Details.

JSON-Schema anzeigen:

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

Felder:

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

criteria

pydantic-field

criteria: Sequence[JSONContent]

Eine nicht leere, geordnete Liste von Text-, Objekt- oder Array-Beschreibungen, eine pro Score ab null.

instructions

pydantic-field

instructions: JSONContent | None = None

Die zu stellende Frage, ausgedrückt als Text, ein JSON-Objekt oder ein Array; optional.

typesafe_sdk.Question

module-attribute

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

Ein Frageobjekt oder ein Fragewörterbuch.

typesafe_sdk.Questions

module-attribute

Questions: TypeAlias = Mapping[str, Question]

Frageeingaben, indiziert nach den Namen, die zur Identifikation ihrer Antworten verwendet werden.

Fragewörterbücher

Fragewörterbücher enthalten einen type-Schlüssel: "noul", "choice" oder "score". Du kannst Wörterbücher und Frageobjekte in derselben Anfrage mischen.

typesafe_sdk.NoulModel

Basisklasse: TypedDict

Ein Ja/Nein-Fragewörterbuch mit type="noul".

Siehe das noul-Primitiv für Details.

type

instance-attribute

type: Literal['noul']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

Die zu stellende Frage, ausgedrückt als Text, ein JSON-Objekt oder ein Array; optional.

criteria

instance-attribute

criteria: NotRequired[NoulCriteria | None]

Optionale Beschreibungen der Ja- und Nein-Ergebnisse.

typesafe_sdk.ChoiceModel

Basisklasse: TypedDict

Ein choice-Fragewörterbuch mit type="choice".

Siehe das choice-Primitiv für Details.

type

instance-attribute

type: Literal['choice']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

Die zu stellende Frage, ausgedrückt als Text, ein JSON-Objekt oder ein Array; optional.

criteria

instance-attribute

criteria: Mapping[str, JSONContent | None]

Labels, die auf Text-, Objekt- oder Array-Beschreibungen abgebildet werden, oder None für unbeschriebene Labels.

typesafe_sdk.ScoreModel

Basisklasse: TypedDict

Ein score-Fragewörterbuch mit type="score".

Siehe das score-Primitiv für Details.

type

instance-attribute

type: Literal['score']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

Die zu stellende Frage, ausgedrückt als Text, ein JSON-Objekt oder ein Array; optional.

criteria

instance-attribute

criteria: Sequence[JSONContent]

Eine nicht leere, geordnete Liste von Text-, Objekt- oder Array-Beschreibungen, eine pro Score ab null.

typesafe_sdk.QuestionModel

module-attribute

QuestionModel: TypeAlias = (
    NoulModel | ChoiceModel | ScoreModel
)

Ein Fragewörterbuch, das durch seinen type-Schlüssel identifiziert wird.