GitHub

API reference for schema.

TypeSafe's System One wire format (Effect's TypeSafeSchema): the questions of a /systemone request, the answers of its response and the /models list, as TypedDict types with their schemas.

Values

AttributeTypeDescription
ENTRYBottom[str | dict[str, bool | int | float | str | Sequence[JsonValue] | Mapping[str, JsonValue] | None] | tuple[bool | int | float | str | Sequence[JsonValue] | Mapping[str, JsonValue] | None, ...] | None, str | Mapping[str, bool | int | float | str | Sequence[JsonValue] | Mapping[str, JsonValue] | None] | Sequence[bool | int | float | str | Sequence[JsonValue] | Mapping[str, JsonValue] | None] | None, Never, Never]
CHOICE_QUESTIONStructSchema[ChoiceQuestion, Never, Never]
SCORE_QUESTIONStructSchema[ScoreQuestion, Never, Never]
NOUL_QUESTIONStructSchema[NoulQuestion, Never, Never]
BOX_QUESTIONStructSchema[BoxQuestion, Never, Never]
QUESTIONUnionSchema[ChoiceQuestion | ScoreQuestion | NoulQuestion | BoxQuestion, Mapping[str, object], Never, Never]
IMAGE_ASSETStructSchema[ImageAsset, Never, Never]
SYSTEM_ONE_REQUESTStructSchema[SystemOneRequest, Never, Never]
CHOICE_ANSWERStructSchema[ChoiceAnswer, Never, Never]
SCORE_ANSWERStructSchema[ScoreAnswer, Never, Never]
NOUL_ANSWERStructSchema[NoulAnswer, Never, Never]
BOX_ANSWERStructSchema[BoxAnswer, Never, Never]
ANSWERUnionSchema[ChoiceAnswer | ScoreAnswer | NoulAnswer | BoxAnswer, Mapping[str, object], Never, Never]
SYSTEM_ONE_RESPONSEStructSchema[SystemOneResponse, Never, Never]
LIST_MODELS_RESPONSEStructSchema[ListModelsResponse, Never, Never]

Types

TypeDefinitionDescription
Entrytype Entry = str | Mapping[str, JsonValue] | Sequence[JsonValue] | None

Instructions or a description: a string, a JSON object, a JSON array or None.

Questiontype Question = ChoiceQuestion | ScoreQuestion | NoulQuestion | BoxQuestion
Answertype Answer = ChoiceAnswer | ScoreAnswer | NoulAnswer | BoxAnswer

Classes