Preguntas

Proporciona un estado y haz preguntas de sí/no, choice y score usando objetos o diccionarios.

Estado

state es el texto o el objeto JSON sobre el que quieres hacer preguntas. No puede ser None, pero los valores dentro de un objeto sí pueden ser None.

Objetos de pregunta

Usa Noul, Choice y Score para definir preguntas con argumentos con nombre.

typesafe_sdk.NoulCriteria

Bases: TypedDict

Descripciones opcionales de los resultados sí y no.

Consulta la primitiva noul para obtener más detalles.

true

instance-attribute

true: JSONContent | None

Descripción del resultado afirmativo como texto, un objeto JSON o un array; None lo deja sin describir.

false

instance-attribute

false: JSONContent | None

Descripción del resultado negativo como texto, un objeto JSON o un array; None lo deja sin describir.

typesafe_sdk.Noul

pydantic-model

Bases: _Question, wire.NoulQuestion

Una pregunta de sí/no con descripciones opcionales para cualquiera de los dos resultados.

Consulta la primitiva noul para obtener más detalles.

Mostrar esquema JSON:

Detalles

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

La pregunta que se va a formular, expresada como texto, un objeto JSON o un array; opcional.

criteria

pydantic-field

criteria: NoulCriteria | None = None

Descripciones opcionales de los resultados sí y no.

typesafe_sdk.Choice

pydantic-model

Bases: _Question, wire.ChoiceQuestion

Una pregunta que elige entre alternativas con nombre.

Consulta la primitiva choice para obtener más detalles.

Mostrar esquema JSON:

Detalles

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

Etiquetas asignadas a descripciones como texto, objeto o array, o None para etiquetas sin describir.

instructions

pydantic-field

instructions: JSONContent | None = None

La pregunta que se va a formular, expresada como texto, un objeto JSON o un array; opcional.

typesafe_sdk.Score

pydantic-model

Bases: _Question, wire.ScoreQuestion

Una pregunta que asigna una puntuación mediante una rúbrica ordenada.

Consulta la primitiva score para obtener más detalles.

Mostrar esquema JSON:

Detalles

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

Una lista ordenada y no vacía de descripciones como texto, objeto o array, una por puntuación desde cero.

instructions

pydantic-field

instructions: JSONContent | None = None

La pregunta que se va a formular, expresada como texto, un objeto JSON o un array; opcional.

typesafe_sdk.Question

module-attribute

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

Un objeto de pregunta o un diccionario de pregunta.

typesafe_sdk.Questions

module-attribute

Questions: TypeAlias = Mapping[str, Question]

Entradas de preguntas indexadas por los nombres usados para identificar sus respuestas.

Diccionarios de preguntas

Los diccionarios de preguntas incluyen una clave type: "noul", "choice" o "score". Puedes mezclar diccionarios y objetos de pregunta en la misma solicitud.

typesafe_sdk.NoulModel

Bases: TypedDict

Un diccionario de pregunta de sí/no con type="noul".

Consulta la primitiva noul para obtener más detalles.

type

instance-attribute

type: Literal['noul']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

La pregunta que se va a formular, expresada como texto, un objeto JSON o un array; opcional.

criteria

instance-attribute

criteria: NotRequired[NoulCriteria | None]

Descripciones opcionales de los resultados sí y no.

typesafe_sdk.ChoiceModel

Bases: TypedDict

Un diccionario de pregunta choice con type="choice".

Consulta la primitiva choice para obtener más detalles.

type

instance-attribute

type: Literal['choice']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

La pregunta que se va a formular, expresada como texto, un objeto JSON o un array; opcional.

criteria

instance-attribute

criteria: Mapping[str, JSONContent | None]

Etiquetas asignadas a descripciones como texto, objeto o array, o None para etiquetas sin describir.

typesafe_sdk.ScoreModel

Bases: TypedDict

Un diccionario de pregunta score con type="score".

Consulta la primitiva score para obtener más detalles.

type

instance-attribute

type: Literal['score']

instructions

instance-attribute

instructions: NotRequired[JSONContent | None]

La pregunta que se va a formular, expresada como texto, un objeto JSON o un array; opcional.

criteria

instance-attribute

criteria: Sequence[JSONContent]

Una lista ordenada y no vacía de descripciones como texto, objeto o array, una por puntuación desde cero.

typesafe_sdk.QuestionModel

module-attribute

QuestionModel: TypeAlias = (
    NoulModel | ChoiceModel | ScoreModel
)

Un diccionario de pregunta identificado por su clave type.