Perguntas

Forneça um estado e faça perguntas de sim/não, choice e score usando objetos ou dicionários.

Estado

state é o texto ou objeto JSON sobre o qual você quer fazer perguntas. Não pode ser None, mas valores dentro de um objeto podem ser None.

Objetos de pergunta

Use Noul, Choice e Score para definir perguntas com argumentos nomeados.

typesafe_sdk.NoulCriteria

Bases: TypedDict

Descrições opcionais dos resultados sim e não.

Consulte a primitiva noul para obter detalhes.

true

instance-attribute

true: JSONContent | None

Descrição do resultado sim como texto, um objeto JSON ou um array; None deixa-o sem descrição.

false

instance-attribute

false: JSONContent | None

Descrição do resultado não como texto, um objeto JSON ou um array; None deixa-o sem descrição.

typesafe_sdk.Noul

pydantic-model

Bases: _Question, wire.NoulQuestion

Uma pergunta de sim/não com descrições opcionais para qualquer um dos resultados.

Consulte a primitiva noul para obter detalhes.

Mostrar esquema JSON:

Detalhes

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

Campos:

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

instructions

pydantic-field

instructions: JSONContent | None = None

A pergunta a fazer, expressa como texto, um objeto JSON ou um array; opcional.

criteria

pydantic-field

criteria: NoulCriteria | None = None

Descrições opcionais dos resultados sim e não.

typesafe_sdk.Choice

pydantic-model

Bases: _Question, wire.ChoiceQuestion

Uma pergunta que seleciona entre alternativas nomeadas.

Consulte a primitiva choice para obter detalhes.

Mostrar esquema JSON:

Detalhes

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

Campos:

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

criteria

pydantic-field

criteria: Mapping[str, JSONContent | None]

Rótulos mapeados para descrições em texto, objeto ou array, ou None para rótulos sem descrição.

instructions

pydantic-field

instructions: JSONContent | None = None

A pergunta a fazer, expressa como texto, um objeto JSON ou um array; opcional.

typesafe_sdk.Score

pydantic-model

Bases: _Question, wire.ScoreQuestion

Uma pergunta que atribui um score usando uma rubrica ordenada.

Consulte a primitiva score para obter detalhes.

Mostrar esquema JSON:

Detalhes

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

Campos:

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

criteria

pydantic-field

criteria: Sequence[JSONContent]

Uma lista ordenada e não vazia de descrições em texto, objeto ou array, uma por score a partir de zero.

instructions

pydantic-field

instructions: JSONContent | None = None

A pergunta a fazer, expressa como texto, um objeto JSON ou um array; opcional.

typesafe_sdk.Question

module-attribute

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

Um objeto de pergunta ou dicionário de pergunta.

typesafe_sdk.Questions

module-attribute

Questions: TypeAlias = Mapping[str, Question]

Entradas de pergunta indexadas pelos nomes usados para identificar suas respostas.

Dicionários de perguntas

Os dicionários de perguntas incluem uma chave type: "noul", "choice" ou "score". Você pode misturar dicionários e objetos de pergunta na mesma requisição.

typesafe_sdk.NoulModel

Bases: TypedDict

Um dicionário de pergunta de sim/não com type="noul".

Consulte a primitiva noul para obter detalhes.

type

instance-attribute

type: Literal['noul']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

A pergunta a fazer, expressa como texto, um objeto JSON ou um array; opcional.

criteria

instance-attribute

criteria: NotRequired[NoulCriteria | None]

Descrições opcionais dos resultados sim e não.

typesafe_sdk.ChoiceModel

Bases: TypedDict

Um dicionário de pergunta choice com type="choice".

Consulte a primitiva choice para obter detalhes.

type

instance-attribute

type: Literal['choice']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

A pergunta a fazer, expressa como texto, um objeto JSON ou um array; opcional.

criteria

instance-attribute

criteria: Mapping[str, JSONContent | None]

Rótulos mapeados para descrições em texto, objeto ou array, ou None para rótulos sem descrição.

typesafe_sdk.ScoreModel

Bases: TypedDict

Um dicionário de pergunta score com type="score".

Consulte a primitiva score para obter detalhes.

type

instance-attribute

type: Literal['score']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

A pergunta a fazer, expressa como texto, um objeto JSON ou um array; opcional.

criteria

instance-attribute

criteria: Sequence[JSONContent]

Uma lista ordenada e não vazia de descrições em texto, objeto ou array, uma por score a partir de zero.

typesafe_sdk.QuestionModel

module-attribute

QuestionModel: TypeAlias = (
    NoulModel | ChoiceModel | ScoreModel
)

Um dicionário de pergunta identificado por sua chave type.