Skip to main content

Module types

Module types 

Source
Expand description

Wire types for the System One API.

Question is what you send; Answer / SystemOneResponse is what you get back. Entry is TypeSafe’s string | object | array | null slot used for instructions and criteria.

Structs§

ChoiceView
Borrowed view of a Choice answer.
ListModelsResponse
Wire body for GET /v1/models.
ModelCard
Metadata for an available model.
NoulCriteria
Optional yes/no descriptions for a Noul question.
NoulView
Borrowed view of a Noul answer.
ResponseMeta
Metadata captured from the HTTP response (not part of the JSON body).
ScoreView
Borrowed view of a Score answer.
SystemOneRequest
Request body for POST /v1/systemone.
SystemOneResponse
Parsed POST /v1/systemone response.
Usage
Token usage reported by the API.

Enums§

Answer
A typed answer, or Answer::Unknown for forward-compatible types.
Entry
Text, structured JSON, or null for state, instructions, and criteria.
Question
A typed System One question.

Constants§

MAX_CHOICE_OPTIONS
Maximum number of Choice options accepted by client-side validation.

Functions§

validate_questions
Validate a question map before sending it on the wire.

Type Aliases§

Questions
Ordered map of named questions, keyed as they should appear in answers.