Вопросы

Передавайте состояние и задавайте вопросы «да/нет», choice и score через объекты или словари.

Состояние

state — это текст или объект JSON, о котором вы хотите задать вопросы. Он не может быть None, но значения внутри объекта могут быть None.

Объекты вопросов

Используйте Noul, Choice и Score, чтобы определять вопросы с именованными аргументами.

typesafe_sdk.NoulCriteria

Базовые классы: TypedDict

Необязательные описания исходов «да» и «нет».

Подробности см. в примитиве noul.

true

instance-attribute

true: JSONContent | None

Описание исхода «да» в виде текста, объекта JSON или массива; None оставляет его без описания.

false

instance-attribute

false: JSONContent | None

Описание исхода «нет» в виде текста, объекта JSON или массива; None оставляет его без описания.

typesafe_sdk.Noul

pydantic-model

Базовые классы: _Question, wire.NoulQuestion

Вопрос «да/нет» с необязательными описаниями для любого из исходов.

Подробности см. в примитиве noul.

Показать схему JSON:

Подробности

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

Поля:

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

instructions

pydantic-field

instructions: JSONContent | None = None

Задаваемый вопрос, выраженный как текст, объект JSON или массив; необязателен.

criteria

pydantic-field

criteria: NoulCriteria | None = None

Необязательные описания исходов «да» и «нет».

typesafe_sdk.Choice

pydantic-model

Базовые классы: _Question, wire.ChoiceQuestion

Вопрос, выбирающий один из именованных вариантов.

Подробности см. в примитиве choice.

Показать схему JSON:

Подробности

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

Поля:

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

criteria

pydantic-field

criteria: Mapping[str, JSONContent | None]

Метки, сопоставленные описаниям в виде текста, объекта или массива, либо None для меток без описания.

instructions

pydantic-field

instructions: JSONContent | None = None

Задаваемый вопрос, выраженный как текст, объект JSON или массив; необязателен.

typesafe_sdk.Score

pydantic-model

Базовые классы: _Question, wire.ScoreQuestion

Вопрос, назначающий score с помощью упорядоченной рубрики.

Подробности см. в примитиве score.

Показать схему JSON:

Подробности

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

Поля:

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

criteria

pydantic-field

criteria: Sequence[JSONContent]

Непустой упорядоченный список описаний в виде текста, объекта или массива, по одному на каждый score начиная с нуля.

instructions

pydantic-field

instructions: JSONContent | None = None

Задаваемый вопрос, выраженный как текст, объект JSON или массив; необязателен.

typesafe_sdk.Question

module-attribute

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

Объект вопроса или словарь вопроса.

typesafe_sdk.Questions

module-attribute

Questions: TypeAlias = Mapping[str, Question]

Входные вопросы с ключами — именами, по которым определяются их ответы.

Словари вопросов

Словари вопросов включают ключ type: "noul", "choice" или "score". В одном запросе можно смешивать словари и объекты вопросов.

typesafe_sdk.NoulModel

Базовые классы: TypedDict

Словарь вопроса «да/нет» с type="noul".

Подробности см. в примитиве noul.

type

instance-attribute

type: Literal['noul']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

Задаваемый вопрос, выраженный как текст, объект JSON или массив; необязателен.

criteria

instance-attribute

criteria: NotRequired[NoulCriteria | None]

Необязательные описания исходов «да» и «нет».

typesafe_sdk.ChoiceModel

Базовые классы: TypedDict

Словарь вопроса choice с type="choice".

Подробности см. в примитиве choice.

type

instance-attribute

type: Literal['choice']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

Задаваемый вопрос, выраженный как текст, объект JSON или массив; необязателен.

criteria

instance-attribute

criteria: Mapping[str, JSONContent | None]

Метки, сопоставленные описаниям в виде текста, объекта или массива, либо None для меток без описания.

typesafe_sdk.ScoreModel

Базовые классы: TypedDict

Словарь вопроса score с type="score".

Подробности см. в примитиве score.

type

instance-attribute

type: Literal['score']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

Задаваемый вопрос, выраженный как текст, объект JSON или массив; необязателен.

criteria

instance-attribute

criteria: Sequence[JSONContent]

typesafe_sdk.QuestionModel

module-attribute

QuestionModel: TypeAlias = (
    NoulModel | ChoiceModel | ScoreModel
)

Словарь вопроса, определяемый по его ключу type.