Skip to main content

Module understanding

Module understanding 

Source
Expand description

What a turn was understood to say, assembled by code from small model tasks.

An Understanding is the reducer’s input: every act with an ActId, its target, its parsed arguments and the words that state them, and the questions, constraints, card answer and disputes of the same message. Nothing in it is model-facing; the tasks that produced it have their own schemas.

Structs§

ActId
One act of a unit: u2.a1. Command ids, card keys and minted case ids derive from it.
ActIdError
An act identifier that is not of the form u<n>.a<m>.
CardAnswer
A typed answer to the card on screen.
Dispute
Something the assistant reported that the user contests.
Excerpt
Words and the message they are in: the evidence for a value.
NotUnderstood
A unit that produced nothing to act on, and why.
Superseded
An act a later unit of the same message replaced or withdrew.
TurnConstraint
A constraint and its words.
Understanding
Everything a turn was understood to say.
UnderstoodAct
One act the turn asks for.
UnderstoodArgument
An argument and the words that state it.
UnderstoodQuestion
A question the user asked.
Unit
One unit of the message.
UnitId
One unit of a message: u1. The segmentation’s units are numbered from 1 in message order, and units coverage adds follow them.
WordRange
Words of a message: word indices, inclusive, and the byte range they cover.

Enums§

ActAction
What an act does.
ActStatus
Whether an act may proceed to the reducer as it is.
ActTarget
The record an act applies to.
ArgumentValue
An argument’s value, parsed and evaluated by code.
ConstraintKind
A condition the user placed on the whole turn.
FoundBy
Which task found a unit.
MessageRef
Which message some words are in: the turn’s own, or one of the transcript window shown.
NotUnderstoodReason
Why a unit was not understood.
QuestionTopic
What kind of thing a question asks.
RecordValue
A record an argument names.
UnitKind
What a unit is.
Unreadable
Why a whole message could not be read, so no act of it runs.