Skip to main content

Module protocol

Module protocol 

Source
Expand description

Wire types for TypeSafe’s Jev “System One” REST API.

The API answers a map of named questions about one opaque state in a single request — choice (pick one of a labelled set), score (rate against an ordered scale) and noul (a yes/no probability) all share the one /v1/systemone endpoint, distinguished by an internally-tagged type field. See docs/jev.md for the operator-facing guide.

Every map here is a BTreeMap, never a HashMap: neither indexmap nor serde_json’s preserve_order feature is a dependency, so a HashMap would serialise in random order on every run.

Structs§

NoulCriteria
Optional descriptions of the two poles of a Question::Noul question.
QuestionLimits
The upper size limits a model accepts, per question type.
SystemOneRequest
A POST /v1/systemone request body.
SystemOneResponse
A POST /v1/systemone response body.
Usage
Token accounting for one SystemOneRequest/SystemOneResponse pair.

Enums§

Answer
The answer to a single Question.
Question
A single question asked of the state.

Constants§

DEFAULT_MODEL
Default model identifier, used when no --jev-model / TYPESAFE_MODEL override is configured.
MAX_CHOICE_OPTIONS
Most options a Question::Choice may offer on jev-1.13.
MAX_SCORE_LEVELS
Most levels a Question::Score scale may have on jev-1.13.
MIN_CHOICE_OPTIONS
Minimum number of options a Question::Choice must offer — picking “one of one” is not a judgment.
MIN_SCORE_LEVELS
Minimum number of levels a Question::Score scale must have.