@altnovatrail/contracts 0.7.9 → 0.8.1

package/novatrail/api/v1/attempt_pb.d.ts

@@ -0,0 +1,1406 @@
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file novatrail/api/v1/attempt.proto (package novatrail.api.v1, syntax proto3)
+/* eslint-disable */
+
+// The checking of an attempt in the contract between `app` and `api`: the submission of the work
+// and the verdict, the tutor's words and marks, hints, the solution shown, and "Done" on a task with
+// a rubric. What each message means, what never reaches the device, and what a repeat with the same
+// idempotency key answers are the rules of contracts/README.md, section 15.
+
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { CloseReason, Outcome } from "./cause_pb.js";
+import type { AnswerSlotPlace, CropBox } from "../../observation/v1/observation_pb.js";
+
+/**
+ * Describes the file novatrail/api/v1/attempt.proto.
+ */
+export declare const file_novatrail_api_v1_attempt: GenFile;
+
+/**
+ * The submission of a task with a verdict.
+ *
+ * @generated from message novatrail.api.v1.SubmitWorkRequest
+ */
+export declare type SubmitWorkRequest = Message<"novatrail.api.v1.SubmitWorkRequest"> & {
+  /**
+   * The profile whose attempt it is.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The attempt.
+   *
+   * @generated from field: string attempt_id = 2;
+   */
+  attemptId: string;
+
+  /**
+   * The idempotency key of this action of the learner: `app` makes one for it, and sends it again
+   * with every repeat of it.
+   *
+   * @generated from field: string idempotency_key = 3;
+   */
+  idempotencyKey: string;
+
+  /**
+   * The handwriting for checking: absent when the task's answer slots are bound `choice` alone.
+   *
+   * @generated from field: novatrail.api.v1.Work work = 4;
+   */
+  work?: Work | undefined;
+
+  /**
+   * The options tapped, one for each answer slot bound `choice` that the learner tapped one of, in
+   * the task's order.
+   *
+   * @generated from field: repeated novatrail.api.v1.TappedChoice tapped_choices = 5;
+   */
+  tappedChoices: TappedChoice[];
+
+  /**
+   * The learner's own key and its provider: with a profile of its owner, when AI reads the work.
+   *
+   * @generated from field: novatrail.api.v1.OwnKey own_key = 6;
+   */
+  ownKey?: OwnKey | undefined;
+
+  /**
+   * The offset of the device's clock from UTC, in minutes: with a request on platform AI alone.
+   *
+   * @generated from field: optional int32 clock_offset_minutes = 7;
+   */
+  clockOffsetMinutes?: number | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.SubmitWorkRequest.
+ * Use `create(SubmitWorkRequestSchema)` to create a new message.
+ */
+export declare const SubmitWorkRequestSchema: GenMessage<SubmitWorkRequest>;
+
+/**
+ * The verdict of a submission.
+ *
+ * @generated from message novatrail.api.v1.SubmitWorkResponse
+ */
+export declare type SubmitWorkResponse = Message<"novatrail.api.v1.SubmitWorkResponse"> & {
+  /**
+   * Every item of the task, in the task's order, with its verdict.
+   *
+   * @generated from field: repeated novatrail.api.v1.ItemVerdict items = 1;
+   */
+  items: ItemVerdict[];
+
+  /**
+   * What the call of AI came to, when the answer slots that AI reads got "unchecked" by it: a
+   * failure of AI, a quota or a limit, no admission, or a refusal of the own key. A slot bound
+   * `choice` still has its verdict.
+   *
+   * @generated from field: novatrail.api.v1.Outcome outcome = 2;
+   */
+  outcome?: Outcome | undefined;
+
+  /**
+   * How many wrong answers the attempt has, this submission's too: a wrong answer is a submission
+   * with an answer slot "not_yet".
+   *
+   * @generated from field: int32 wrong_answers = 3;
+   */
+  wrongAnswers: number;
+
+  /**
+   * The solved task, when every item is correct and the attempt is closed `CLOSE_REASON_CORRECT`.
+   *
+   * @generated from field: novatrail.api.v1.SolvedTask solved = 4;
+   */
+  solved?: SolvedTask | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.SubmitWorkResponse.
+ * Use `create(SubmitWorkResponseSchema)` to create a new message.
+ */
+export declare const SubmitWorkResponseSchema: GenMessage<SubmitWorkResponse>;
+
+/**
+ * The submission of an essay.
+ *
+ * @generated from message novatrail.api.v1.SubmitEssayRequest
+ */
+export declare type SubmitEssayRequest = Message<"novatrail.api.v1.SubmitEssayRequest"> & {
+  /**
+   * The profile whose attempt it is.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The attempt.
+   *
+   * @generated from field: string attempt_id = 2;
+   */
+  attemptId: string;
+
+  /**
+   * The idempotency key of this action of the learner.
+   *
+   * @generated from field: string idempotency_key = 3;
+   */
+  idempotencyKey: string;
+
+  /**
+   * The PNG of the crop of the sheet, without its `sheet_box`.
+   *
+   * @generated from field: bytes crop = 4;
+   */
+  crop: Uint8Array;
+
+  /**
+   * The learner's own key and its provider: with a profile of its owner.
+   *
+   * @generated from field: novatrail.api.v1.OwnKey own_key = 5;
+   */
+  ownKey?: OwnKey | undefined;
+
+  /**
+   * The offset of the device's clock from UTC, in minutes: with a request on platform AI alone.
+   *
+   * @generated from field: optional int32 clock_offset_minutes = 6;
+   */
+  clockOffsetMinutes?: number | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.SubmitEssayRequest.
+ * Use `create(SubmitEssayRequestSchema)` to create a new message.
+ */
+export declare const SubmitEssayRequestSchema: GenMessage<SubmitEssayRequest>;
+
+/**
+ * How a submission of an essay ended (R87). No verdict: an item with a rubric has none.
+ *
+ * @generated from message novatrail.api.v1.SubmitEssayResponse
+ */
+export declare type SubmitEssayResponse = Message<"novatrail.api.v1.SubmitEssayResponse"> & {
+  /**
+   * How the submission ended.
+   *
+   * @generated from field: novatrail.api.v1.SubmissionEnd end = 1;
+   */
+  end: SubmissionEnd;
+
+  /**
+   * The text read, as it is written, when the essay was read: beside the feedback, and beside
+   * "unchecked" when the assessment gave none.
+   *
+   * @generated from field: optional string text = 2;
+   */
+  text?: string | undefined;
+
+  /**
+   * Why the essay could not be read, as a verdict's reason is written: "blank" or "illegible",
+   * beside `SUBMISSION_END_UNREADABLE` alone, and empty beside the others. The learner writes the
+   * sheet again.
+   *
+   * @generated from field: string reason = 3;
+   */
+  reason: string;
+
+  /**
+   * The words of the feedback, beside `SUBMISSION_END_FEEDBACK`: absent when they failed the leak
+   * check or the rule of feedback, and then `app` shows its own phrase, "no feedback this time".
+   *
+   * @generated from field: optional string feedback = 4;
+   */
+  feedback?: string | undefined;
+
+  /**
+   * What the call of AI came to, beside `SUBMISSION_END_UNCHECKED`: absent when the assessment
+   * assessed no criterion.
+   *
+   * @generated from field: novatrail.api.v1.Outcome outcome = 5;
+   */
+  outcome?: Outcome | undefined;
+
+  /**
+   * Why the attempt was closed while this submission went: `CLOSE_REASON_UNSPECIFIED` when it is
+   * still open. The feedback came all the same, from the memory of the request.
+   *
+   * @generated from field: novatrail.api.v1.CloseReason closed = 6;
+   */
+  closed: CloseReason;
+
+  /**
+   * The answer of a repeat with the same idempotency key: it holds neither the text read nor the
+   * words of the feedback, which are nowhere on the server.
+   *
+   * @generated from field: bool repeated = 7;
+   */
+  repeated: boolean;
+};
+
+/**
+ * Describes the message novatrail.api.v1.SubmitEssayResponse.
+ * Use `create(SubmitEssayResponseSchema)` to create a new message.
+ */
+export declare const SubmitEssayResponseSchema: GenMessage<SubmitEssayResponse>;
+
+/**
+ * "Done" on a task with a rubric.
+ *
+ * @generated from message novatrail.api.v1.DoneRequest
+ */
+export declare type DoneRequest = Message<"novatrail.api.v1.DoneRequest"> & {
+  /**
+   * The profile whose attempt it is.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The attempt.
+   *
+   * @generated from field: string attempt_id = 2;
+   */
+  attemptId: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.DoneRequest.
+ * Use `create(DoneRequestSchema)` to create a new message.
+ */
+export declare const DoneRequestSchema: GenMessage<DoneRequest>;
+
+/**
+ * What "Done" gives: the task solved.
+ *
+ * @generated from message novatrail.api.v1.DoneResponse
+ */
+export declare type DoneResponse = Message<"novatrail.api.v1.DoneResponse"> & {
+  /**
+   * The criteria of the rubric and the solution, if the task has one.
+   *
+   * @generated from field: novatrail.api.v1.SolvedTask solved = 1;
+   */
+  solved?: SolvedTask | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.DoneResponse.
+ * Use `create(DoneResponseSchema)` to create a new message.
+ */
+export declare const DoneResponseSchema: GenMessage<DoneResponse>;
+
+/**
+ * A request for the words of a rung.
+ *
+ * @generated from message novatrail.api.v1.GetRungWordsRequest
+ */
+export declare type GetRungWordsRequest = Message<"novatrail.api.v1.GetRungWordsRequest"> & {
+  /**
+   * The profile whose attempt it is.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The attempt.
+   *
+   * @generated from field: string attempt_id = 2;
+   */
+  attemptId: string;
+
+  /**
+   * The idempotency key of this request.
+   *
+   * @generated from field: string idempotency_key = 3;
+   */
+  idempotencyKey: string;
+
+  /**
+   * How many wrong answers the attempt had when the submission came that the words are asked for:
+   * the `wrong_answers` of its answer.
+   *
+   * @generated from field: optional int32 wrong_answers = 4;
+   */
+  wrongAnswers?: number | undefined;
+
+  /**
+   * The work of that submission again: absent when the task's answer slots are bound `choice`
+   * alone.
+   *
+   * @generated from field: novatrail.api.v1.Work work = 5;
+   */
+  work?: Work | undefined;
+
+  /**
+   * The learner's own key and its provider: with a profile of its owner.
+   *
+   * @generated from field: novatrail.api.v1.OwnKey own_key = 6;
+   */
+  ownKey?: OwnKey | undefined;
+
+  /**
+   * The offset of the device's clock from UTC, in minutes: with a request on platform AI alone.
+   *
+   * @generated from field: optional int32 clock_offset_minutes = 7;
+   */
+  clockOffsetMinutes?: number | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetRungWordsRequest.
+ * Use `create(GetRungWordsRequestSchema)` to create a new message.
+ */
+export declare const GetRungWordsRequestSchema: GenMessage<GetRungWordsRequest>;
+
+/**
+ * The words of a rung.
+ *
+ * @generated from message novatrail.api.v1.GetRungWordsResponse
+ */
+export declare type GetRungWordsResponse = Message<"novatrail.api.v1.GetRungWordsResponse"> & {
+  /**
+   * The rung, from 1 to 3.
+   *
+   * @generated from field: int32 rung = 1;
+   */
+  rung: number;
+
+  /**
+   * The tutor's words, whole, once they passed the leak check and the form check, or the rung's
+   * fallback text.
+   *
+   * @generated from field: string words = 2;
+   */
+  words: string;
+
+  /**
+   * The tutor's marks that the words come with, on the tutor's layer of the work sent.
+   *
+   * @generated from field: repeated novatrail.api.v1.Mark marks = 3;
+   */
+  marks: Mark[];
+
+  /**
+   * Why the words are the fallback text, when a call of AI came to an outcome. Absent when the
+   * model's words came, or when they failed a check.
+   *
+   * @generated from field: novatrail.api.v1.Outcome outcome = 4;
+   */
+  outcome?: Outcome | undefined;
+
+  /**
+   * The answer of a repeat, or of a request for the same wrong answer: the words the attempt keeps,
+   * without marks, which the server does not keep.
+   *
+   * @generated from field: bool repeated = 5;
+   */
+  repeated: boolean;
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetRungWordsResponse.
+ * Use `create(GetRungWordsResponseSchema)` to create a new message.
+ */
+export declare const GetRungWordsResponseSchema: GenMessage<GetRungWordsResponse>;
+
+/**
+ * A request for the words after a correct answer.
+ *
+ * @generated from message novatrail.api.v1.GetCorrectAnswerWordsRequest
+ */
+export declare type GetCorrectAnswerWordsRequest = Message<"novatrail.api.v1.GetCorrectAnswerWordsRequest"> & {
+  /**
+   * The profile whose attempt it is.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The attempt, which the correct answer has just closed.
+   *
+   * @generated from field: string attempt_id = 2;
+   */
+  attemptId: string;
+
+  /**
+   * The idempotency key of this request.
+   *
+   * @generated from field: string idempotency_key = 3;
+   */
+  idempotencyKey: string;
+
+  /**
+   * The work of the correct submission again: absent when the task's answer slots are bound
+   * `choice` alone.
+   *
+   * @generated from field: novatrail.api.v1.Work work = 4;
+   */
+  work?: Work | undefined;
+
+  /**
+   * The learner's own key and its provider: with a profile of its owner.
+   *
+   * @generated from field: novatrail.api.v1.OwnKey own_key = 5;
+   */
+  ownKey?: OwnKey | undefined;
+
+  /**
+   * The offset of the device's clock from UTC, in minutes: with a request on platform AI alone.
+   *
+   * @generated from field: optional int32 clock_offset_minutes = 6;
+   */
+  clockOffsetMinutes?: number | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetCorrectAnswerWordsRequest.
+ * Use `create(GetCorrectAnswerWordsRequestSchema)` to create a new message.
+ */
+export declare const GetCorrectAnswerWordsRequestSchema: GenMessage<GetCorrectAnswerWordsRequest>;
+
+/**
+ * The words after a correct answer.
+ *
+ * @generated from message novatrail.api.v1.GetCorrectAnswerWordsResponse
+ */
+export declare type GetCorrectAnswerWordsResponse = Message<"novatrail.api.v1.GetCorrectAnswerWordsResponse"> & {
+  /**
+   * The tutor's words, whole, once they passed the leak check and the form check: absent when a
+   * call of AI gave none, or they failed a check.
+   *
+   * @generated from field: optional string words = 1;
+   */
+  words?: string | undefined;
+
+  /**
+   * What the call of AI came to, when it gave no words.
+   *
+   * @generated from field: novatrail.api.v1.Outcome outcome = 2;
+   */
+  outcome?: Outcome | undefined;
+
+  /**
+   * The answer of a repeat with the same idempotency key, which holds no words: the server keeps
+   * none.
+   *
+   * @generated from field: bool repeated = 3;
+   */
+  repeated: boolean;
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetCorrectAnswerWordsResponse.
+ * Use `create(GetCorrectAnswerWordsResponseSchema)` to create a new message.
+ */
+export declare const GetCorrectAnswerWordsResponseSchema: GenMessage<GetCorrectAnswerWordsResponse>;
+
+/**
+ * "Explain differently".
+ *
+ * @generated from message novatrail.api.v1.ExplainDifferentlyRequest
+ */
+export declare type ExplainDifferentlyRequest = Message<"novatrail.api.v1.ExplainDifferentlyRequest"> & {
+  /**
+   * The profile whose attempt it is.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The attempt.
+   *
+   * @generated from field: string attempt_id = 2;
+   */
+  attemptId: string;
+
+  /**
+   * The idempotency key of this action of the learner.
+   *
+   * @generated from field: string idempotency_key = 3;
+   */
+  idempotencyKey: string;
+
+  /**
+   * The learner's own key and its provider: with a profile of its owner.
+   *
+   * @generated from field: novatrail.api.v1.OwnKey own_key = 4;
+   */
+  ownKey?: OwnKey | undefined;
+
+  /**
+   * The offset of the device's clock from UTC, in minutes: with a request on platform AI alone.
+   *
+   * @generated from field: optional int32 clock_offset_minutes = 5;
+   */
+  clockOffsetMinutes?: number | undefined;
+
+  /**
+   * How many wrong answers the attempt had when the words that the learner reads came: the
+   * `wrong_answers` of the submission whose rung they are.
+   *
+   * @generated from field: optional int32 wrong_answers = 6;
+   */
+  wrongAnswers?: number | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.ExplainDifferentlyRequest.
+ * Use `create(ExplainDifferentlyRequestSchema)` to create a new message.
+ */
+export declare const ExplainDifferentlyRequestSchema: GenMessage<ExplainDifferentlyRequest>;
+
+/**
+ * The words of the same rung, in other words.
+ *
+ * @generated from message novatrail.api.v1.ExplainDifferentlyResponse
+ */
+export declare type ExplainDifferentlyResponse = Message<"novatrail.api.v1.ExplainDifferentlyResponse"> & {
+  /**
+   * The tutor's words, whole, once they passed the leak check and the form check, or the rung's
+   * fallback text.
+   *
+   * @generated from field: string words = 1;
+   */
+  words: string;
+
+  /**
+   * What the call came to, when the words are not the model's: a failure of AI, a refusal of the own
+   * key, or `CAUSE_NO_OTHER_WORDS` when they are the words the learner reads already.
+   *
+   * @generated from field: novatrail.api.v1.Outcome outcome = 2;
+   */
+  outcome?: Outcome | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.ExplainDifferentlyResponse.
+ * Use `create(ExplainDifferentlyResponseSchema)` to create a new message.
+ */
+export declare const ExplainDifferentlyResponseSchema: GenMessage<ExplainDifferentlyResponse>;
+
+/**
+ * "Hint".
+ *
+ * @generated from message novatrail.api.v1.GetHintRequest
+ */
+export declare type GetHintRequest = Message<"novatrail.api.v1.GetHintRequest"> & {
+  /**
+   * The profile whose attempt it is.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The attempt.
+   *
+   * @generated from field: string attempt_id = 2;
+   */
+  attemptId: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetHintRequest.
+ * Use `create(GetHintRequestSchema)` to create a new message.
+ */
+export declare const GetHintRequestSchema: GenMessage<GetHintRequest>;
+
+/**
+ * What a hint asked for gives. "What is known and what to find" `app` shows from the open view of
+ * the task: they are open, and the server records nothing of them.
+ *
+ * @generated from message novatrail.api.v1.GetHintResponse
+ */
+export declare type GetHintResponse = Message<"novatrail.api.v1.GetHintResponse"> & {
+  /**
+   * Before the first wrong answer, and on a task with a rubric, the task's techniques; after it, the
+   * current rung's words.
+   *
+   * @generated from oneof novatrail.api.v1.GetHintResponse.hint
+   */
+  hint: {
+    /**
+     * The task's techniques.
+     *
+     * @generated from field: novatrail.api.v1.Techniques techniques = 1;
+     */
+    value: Techniques;
+    case: "techniques";
+  } | {
+    /**
+     * The current rung's words.
+     *
+     * @generated from field: novatrail.api.v1.RungHint rung = 2;
+     */
+    value: RungHint;
+    case: "rung";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetHintResponse.
+ * Use `create(GetHintResponseSchema)` to create a new message.
+ */
+export declare const GetHintResponseSchema: GenMessage<GetHintResponse>;
+
+/**
+ * The techniques of a task, which the server records as given at a step or on request.
+ *
+ * @generated from message novatrail.api.v1.Techniques
+ */
+export declare type Techniques = Message<"novatrail.api.v1.Techniques"> & {
+  /**
+   * The IDs of the techniques, local IDs of the module's technique catalog: empty when the task
+   * names none, which is the answer that there is nothing to hint.
+   *
+   * @generated from field: repeated string technique_ids = 1;
+   */
+  techniqueIds: string[];
+};
+
+/**
+ * Describes the message novatrail.api.v1.Techniques.
+ * Use `create(TechniquesSchema)` to create a new message.
+ */
+export declare const TechniquesSchema: GenMessage<Techniques>;
+
+/**
+ * A rung's words that a hint asked for gives again, with no AI.
+ *
+ * @generated from message novatrail.api.v1.RungHint
+ */
+export declare type RungHint = Message<"novatrail.api.v1.RungHint"> & {
+  /**
+   * The rung, from 1 to 3.
+   *
+   * @generated from field: int32 rung = 1;
+   */
+  rung: number;
+
+  /**
+   * The words the attempt keeps for the rung, or the rung's fallback text.
+   *
+   * @generated from field: string words = 2;
+   */
+  words: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.RungHint.
+ * Use `create(RungHintSchema)` to create a new message.
+ */
+export declare const RungHintSchema: GenMessage<RungHint>;
+
+/**
+ * The beginning of a solving step.
+ *
+ * @generated from message novatrail.api.v1.BeginStepRequest
+ */
+export declare type BeginStepRequest = Message<"novatrail.api.v1.BeginStepRequest"> & {
+  /**
+   * The profile whose attempt it is.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The attempt.
+   *
+   * @generated from field: string attempt_id = 2;
+   */
+  attemptId: string;
+
+  /**
+   * The step's place among the task's solving steps, from 1.
+   *
+   * @generated from field: int32 step = 3;
+   */
+  step: number;
+};
+
+/**
+ * Describes the message novatrail.api.v1.BeginStepRequest.
+ * Use `create(BeginStepRequestSchema)` to create a new message.
+ */
+export declare const BeginStepRequestSchema: GenMessage<BeginStepRequest>;
+
+/**
+ * What the beginning of a step gives.
+ *
+ * @generated from message novatrail.api.v1.BeginStepResponse
+ */
+export declare type BeginStepResponse = Message<"novatrail.api.v1.BeginStepResponse"> & {
+  /**
+   * The task's techniques.
+   *
+   * @generated from field: novatrail.api.v1.Techniques techniques = 1;
+   */
+  techniques?: Techniques | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.BeginStepResponse.
+ * Use `create(BeginStepResponseSchema)` to create a new message.
+ */
+export declare const BeginStepResponseSchema: GenMessage<BeginStepResponse>;
+
+/**
+ * A request to show the solution.
+ *
+ * @generated from message novatrail.api.v1.ShowSolutionRequest
+ */
+export declare type ShowSolutionRequest = Message<"novatrail.api.v1.ShowSolutionRequest"> & {
+  /**
+   * The profile whose attempt it is.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The attempt.
+   *
+   * @generated from field: string attempt_id = 2;
+   */
+  attemptId: string;
+
+  /**
+   * The idempotency key of this action.
+   *
+   * @generated from field: string idempotency_key = 3;
+   */
+  idempotencyKey: string;
+
+  /**
+   * Whose action it is.
+   *
+   * @generated from field: novatrail.api.v1.Action action = 4;
+   */
+  action: Action;
+};
+
+/**
+ * Describes the message novatrail.api.v1.ShowSolutionRequest.
+ * Use `create(ShowSolutionRequestSchema)` to create a new message.
+ */
+export declare const ShowSolutionRequestSchema: GenMessage<ShowSolutionRequest>;
+
+/**
+ * The solution shown.
+ *
+ * @generated from message novatrail.api.v1.ShowSolutionResponse
+ */
+export declare type ShowSolutionResponse = Message<"novatrail.api.v1.ShowSolutionResponse"> & {
+  /**
+   * The solved task.
+   *
+   * @generated from field: novatrail.api.v1.SolvedTask solved = 1;
+   */
+  solved?: SolvedTask | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.ShowSolutionResponse.
+ * Use `create(ShowSolutionResponseSchema)` to create a new message.
+ */
+export declare const ShowSolutionResponseSchema: GenMessage<ShowSolutionResponse>;
+
+/**
+ * The work for checking: a sheet's crop, or the crops of a workbook's filled boxes. Nothing of the
+ * writing history, of the context of the submission, of the groups of strokes or of the text of an
+ * item goes with it.
+ *
+ * @generated from message novatrail.api.v1.Work
+ */
+export declare type Work = Message<"novatrail.api.v1.Work"> & {
+  /**
+   * Where the work was written.
+   *
+   * @generated from oneof novatrail.api.v1.Work.surface
+   */
+  surface: {
+    /**
+     * A handwriting sheet.
+     *
+     * @generated from field: novatrail.api.v1.SheetWork sheet = 1;
+     */
+    value: SheetWork;
+    case: "sheet";
+  } | {
+    /**
+     * A page of a workbook.
+     *
+     * @generated from field: novatrail.api.v1.WorkbookWork workbook = 2;
+     */
+    value: WorkbookWork;
+    case: "workbook";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message novatrail.api.v1.Work.
+ * Use `create(WorkSchema)` to create a new message.
+ */
+export declare const WorkSchema: GenMessage<Work>;
+
+/**
+ * The work of a handwriting sheet.
+ *
+ * @generated from message novatrail.api.v1.SheetWork
+ */
+export declare type SheetWork = Message<"novatrail.api.v1.SheetWork"> & {
+  /**
+   * The PNG of the crop of the visible strokes, without its `sheet_box`.
+   *
+   * @generated from field: bytes crop = 1;
+   */
+  crop: Uint8Array;
+};
+
+/**
+ * Describes the message novatrail.api.v1.SheetWork.
+ * Use `create(SheetWorkSchema)` to create a new message.
+ */
+export declare const SheetWorkSchema: GenMessage<SheetWork>;
+
+/**
+ * The work of a page of a workbook.
+ *
+ * @generated from message novatrail.api.v1.WorkbookWork
+ */
+export declare type WorkbookWork = Message<"novatrail.api.v1.WorkbookWork"> & {
+  /**
+   * Each filled box, in the task's order. A box left empty sends nothing, and the draft, the
+   * writing outside the boxes, goes nowhere.
+   *
+   * @generated from field: repeated novatrail.api.v1.BoxCrop boxes = 1;
+   */
+  boxes: BoxCrop[];
+};
+
+/**
+ * Describes the message novatrail.api.v1.WorkbookWork.
+ * Use `create(WorkbookWorkSchema)` to create a new message.
+ */
+export declare const WorkbookWorkSchema: GenMessage<WorkbookWork>;
+
+/**
+ * The crop of one filled box.
+ *
+ * @generated from message novatrail.api.v1.BoxCrop
+ */
+export declare type BoxCrop = Message<"novatrail.api.v1.BoxCrop"> & {
+  /**
+   * The box, by its place.
+   *
+   * @generated from field: novatrail.observation.v1.AnswerSlotPlace answer_slot = 1;
+   */
+  answerSlot?: AnswerSlotPlace | undefined;
+
+  /**
+   * The PNG of the crop of the box's strokes.
+   *
+   * @generated from field: bytes crop = 2;
+   */
+  crop: Uint8Array;
+};
+
+/**
+ * Describes the message novatrail.api.v1.BoxCrop.
+ * Use `create(BoxCropSchema)` to create a new message.
+ */
+export declare const BoxCropSchema: GenMessage<BoxCrop>;
+
+/**
+ * An option the learner tapped.
+ *
+ * @generated from message novatrail.api.v1.TappedChoice
+ */
+export declare type TappedChoice = Message<"novatrail.api.v1.TappedChoice"> & {
+  /**
+   * The answer slot bound `choice`.
+   *
+   * @generated from field: novatrail.observation.v1.AnswerSlotPlace answer_slot = 1;
+   */
+  answerSlot?: AnswerSlotPlace | undefined;
+
+  /**
+   * The text of the option tapped, as the open view of the task writes it.
+   *
+   * @generated from field: string value = 2;
+   */
+  value: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.TappedChoice.
+ * Use `create(TappedChoiceSchema)` to create a new message.
+ */
+export declare const TappedChoiceSchema: GenMessage<TappedChoice>;
+
+/**
+ * The learner's own key at its provider, which the server holds in the memory of the request alone.
+ *
+ * @generated from message novatrail.api.v1.OwnKey
+ */
+export declare type OwnKey = Message<"novatrail.api.v1.OwnKey"> & {
+  /**
+   * The provider, by its code in the admission table: "openai", "anthropic".
+   *
+   * @generated from field: string provider = 1;
+   */
+  provider: string;
+
+  /**
+   * The key, as the provider gave it.
+   *
+   * @generated from field: string key = 2;
+   */
+  key: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.OwnKey.
+ * Use `create(OwnKeySchema)` to create a new message.
+ */
+export declare const OwnKeySchema: GenMessage<OwnKey>;
+
+/**
+ * The verdict of an item.
+ *
+ * @generated from message novatrail.api.v1.ItemVerdict
+ */
+export declare type ItemVerdict = Message<"novatrail.api.v1.ItemVerdict"> & {
+  /**
+   * The item's verdict, made of its answer slots': "correct", "not_yet", "unreadable" or
+   * "unchecked".
+   *
+   * @generated from field: string verdict = 1;
+   */
+  verdict: string;
+
+  /**
+   * Every answer slot of the item, in order.
+   *
+   * @generated from field: repeated novatrail.api.v1.AnswerSlotVerdict answer_slots = 2;
+   */
+  answerSlots: AnswerSlotVerdict[];
+};
+
+/**
+ * Describes the message novatrail.api.v1.ItemVerdict.
+ * Use `create(ItemVerdictSchema)` to create a new message.
+ */
+export declare const ItemVerdictSchema: GenMessage<ItemVerdict>;
+
+/**
+ * The verdict of an answer slot, and what was read in it. The trap that a value shows is not here:
+ * the tutor's words alone get it, in `api`.
+ *
+ * @generated from message novatrail.api.v1.AnswerSlotVerdict
+ */
+export declare type AnswerSlotVerdict = Message<"novatrail.api.v1.AnswerSlotVerdict"> & {
+  /**
+   * The answer slot.
+   *
+   * @generated from field: novatrail.observation.v1.AnswerSlotPlace answer_slot = 1;
+   */
+  answerSlot?: AnswerSlotPlace | undefined;
+
+  /**
+   * "correct", "not_yet", "unreadable" or "unchecked".
+   *
+   * @generated from field: string verdict = 2;
+   */
+  verdict: string;
+
+  /**
+   * Why the verdict is "unreadable": "blank", "notation", "illegible", "ambiguous",
+   * "no_final_answer" or "several_final_answers". Empty beside the others.
+   *
+   * @generated from field: string reason = 3;
+   */
+  reason: string;
+
+  /**
+   * What was read in the slot, as the learner sees it, "Read: 6": the value of the observation, or
+   * the text of the option tapped. Absent when nothing was read.
+   *
+   * @generated from field: optional string value = 4;
+   */
+  value?: string | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.AnswerSlotVerdict.
+ * Use `create(AnswerSlotVerdictSchema)` to create a new message.
+ */
+export declare const AnswerSlotVerdictSchema: GenMessage<AnswerSlotVerdict>;
+
+/**
+ * What reaches the device once the task is solved: its attempt closed by a correct answer, by the
+ * solution shown, or by "Done".
+ *
+ * @generated from message novatrail.api.v1.SolvedTask
+ */
+export declare type SolvedTask = Message<"novatrail.api.v1.SolvedTask"> & {
+  /**
+   * The key of each answer slot that has one, in the task's order: a slot whose check is a
+   * predicate or a rubric has none.
+   *
+   * @generated from field: repeated novatrail.api.v1.AnswerSlotKey keys = 1;
+   */
+  keys: AnswerSlotKey[];
+
+  /**
+   * The task's solution, the value of its field `solution` as JSON of the module format, of the
+   * instance when the task is a template: empty when the task has none.
+   *
+   * @generated from field: bytes solution = 2;
+   */
+  solution: Uint8Array;
+
+  /**
+   * The version of the module format the solution is written in, MAJOR.MINOR.
+   *
+   * @generated from field: string module_format_version = 3;
+   */
+  moduleFormatVersion: string;
+
+  /**
+   * The criteria of a rubric, each its text, in order: on a task with a rubric alone, without the
+   * marks of the assessment.
+   *
+   * @generated from field: repeated string criteria = 4;
+   */
+  criteria: string[];
+};
+
+/**
+ * Describes the message novatrail.api.v1.SolvedTask.
+ * Use `create(SolvedTaskSchema)` to create a new message.
+ */
+export declare const SolvedTaskSchema: GenMessage<SolvedTask>;
+
+/**
+ * The key of an answer slot.
+ *
+ * @generated from message novatrail.api.v1.AnswerSlotKey
+ */
+export declare type AnswerSlotKey = Message<"novatrail.api.v1.AnswerSlotKey"> & {
+  /**
+   * The answer slot.
+   *
+   * @generated from field: novatrail.observation.v1.AnswerSlotPlace answer_slot = 1;
+   */
+  answerSlot?: AnswerSlotPlace | undefined;
+
+  /**
+   * The key as the module format writes it, of the instance when the task is a template.
+   *
+   * @generated from field: string key = 2;
+   */
+  key: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.AnswerSlotKey.
+ * Use `create(AnswerSlotKeySchema)` to create a new message.
+ */
+export declare const AnswerSlotKeySchema: GenMessage<AnswerSlotKey>;
+
+/**
+ * A mark of the tutor on its layer of the canvas, over the learner's work. The program places it;
+ * `app` gives it its name, which a screen reader reads, and it belongs to the words that bring it.
+ *
+ * @generated from message novatrail.api.v1.Mark
+ */
+export declare type Mark = Message<"novatrail.api.v1.Mark"> & {
+  /**
+   * What the mark is.
+   *
+   * @generated from field: novatrail.api.v1.MarkKind kind = 1;
+   */
+  kind: MarkKind;
+
+  /**
+   * Where the mark stands. A group's label comes only if the frames of the groups go with the work
+   * (repositories 8, Т-31).
+   *
+   * @generated from oneof novatrail.api.v1.Mark.place
+   */
+  place: {
+    /**
+     * An answer slot by its place: on a workbook, the box, framed with its strokes.
+     *
+     * @generated from field: novatrail.observation.v1.AnswerSlotPlace answer_slot = 2;
+     */
+    value: AnswerSlotPlace;
+    case: "answerSlot";
+  } | {
+    /**
+     * A box on the crop the device sent, in whole thousandths: on a handwriting sheet alone.
+     *
+     * @generated from field: novatrail.observation.v1.CropBox crop_box = 3;
+     */
+    value: CropBox;
+    case: "cropBox";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message novatrail.api.v1.Mark.
+ * Use `create(MarkSchema)` to create a new message.
+ */
+export declare const MarkSchema: GenMessage<Mark>;
+
+/**
+ * How a submission of an essay ended.
+ *
+ * @generated from enum novatrail.api.v1.SubmissionEnd
+ */
+export enum SubmissionEnd {
+  /**
+   * Not named: never sent.
+   *
+   * @generated from enum value: SUBMISSION_END_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * The essay was read and assessed by its rubric: the learner gets feedback.
+   *
+   * @generated from enum value: SUBMISSION_END_FEEDBACK = 1;
+   */
+  FEEDBACK = 1,
+
+  /**
+   * The sheet is blank, or the essay cannot be read as a whole: it does not reach the assessment.
+   *
+   * @generated from enum value: SUBMISSION_END_UNREADABLE = 2;
+   */
+  UNREADABLE = 2,
+
+  /**
+   * No check: a call of AI gave nothing, or the assessment assessed no criterion.
+   *
+   * @generated from enum value: SUBMISSION_END_UNCHECKED = 3;
+   */
+  UNCHECKED = 3,
+}
+
+/**
+ * Describes the enum novatrail.api.v1.SubmissionEnd.
+ */
+export declare const SubmissionEndSchema: GenEnum<SubmissionEnd>;
+
+/**
+ * Whose action a request is: the server tells kinds of action apart, not people (R04 api).
+ *
+ * @generated from enum novatrail.api.v1.Action
+ */
+export enum Action {
+  /**
+   * Not named: never sent.
+   *
+   * @generated from enum value: ACTION_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * A learning action, by the learner's session.
+   *
+   * @generated from enum value: ACTION_LEARNING = 1;
+   */
+  LEARNING = 1,
+
+  /**
+   * An action of an adult, behind the PIN of the section for adults.
+   *
+   * @generated from enum value: ACTION_ADULT = 2;
+   */
+  ADULT = 2,
+}
+
+/**
+ * Describes the enum novatrail.api.v1.Action.
+ */
+export declare const ActionSchema: GenEnum<Action>;
+
+/**
+ * What a mark is.
+ *
+ * @generated from enum novatrail.api.v1.MarkKind
+ */
+export enum MarkKind {
+  /**
+   * Not named: never sent.
+   *
+   * @generated from enum value: MARK_KIND_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * A frame round the place.
+   *
+   * @generated from enum value: MARK_KIND_FRAME = 1;
+   */
+  FRAME = 1,
+}
+
+/**
+ * Describes the enum novatrail.api.v1.MarkKind.
+ */
+export declare const MarkKindSchema: GenEnum<MarkKind>;
+
+/**
+ * The requests on an attempt of a task, as a learner and an adult act on it. Every method names
+ * the profile and the attempt; one of another profile, or none, gets `CAUSE_NOT_FOUND`, and a
+ * profile that is not the account's `CAUSE_NO_PROFILE`. A request whose form the contract refuses
+ * — a field it needs left out, a place the task does not have, a method the task's kind does not
+ * take — gets the code `invalid_argument` with no `Refusal`.
+ *
+ * @generated from service novatrail.api.v1.AttemptService
+ */
+export declare const AttemptService: GenService<{
+  /**
+   * Sends the work of a task with a verdict for checking: the handwriting, the options tapped, or
+   * both. The answer is the verdict of every item and answer slot, on the whole observation, and
+   * what was read. Refusals: `CAUSE_ATTEMPT_CLOSED`, `CAUSE_KEY_NOT_FOR_PROFILE`,
+   * `CAUSE_KEY_ALREADY_USED` and `CAUSE_STILL_GOING`. A call of AI that gives no reading is no
+   * refusal: its slots get "unchecked", and the answer names the outcome. A repeat with the same
+   * idempotency key gets the verdicts and the reading recorded, with no AI.
+   *
+   * @generated from rpc novatrail.api.v1.AttemptService.SubmitWork
+   */
+  submitWork: {
+    methodKind: "unary";
+    input: typeof SubmitWorkRequestSchema;
+    output: typeof SubmitWorkResponseSchema;
+  },
+  /**
+   * Sends the sheet of a task with a rubric, an essay, for its feedback: one request, reading and
+   * assessment both. Refusals: `CAUSE_ATTEMPT_CLOSED`, before any call of AI,
+   * `CAUSE_KEY_NOT_FOR_PROFILE`, `CAUSE_KEY_ALREADY_USED` and `CAUSE_STILL_GOING`. A repeat with
+   * the same idempotency key gets how the submission ended, without the text read and the words of
+   * the feedback: they are nowhere on the server.
+   *
+   * @generated from rpc novatrail.api.v1.AttemptService.SubmitEssay
+   */
+  submitEssay: {
+    methodKind: "unary";
+    input: typeof SubmitEssayRequestSchema;
+    output: typeof SubmitEssayResponseSchema;
+  },
+  /**
+   * "Done" on a task with a rubric: the learner ends the attempt, which is closed
+   * `CLOSE_REASON_DONE`, and the task is solved. Refusals: `CAUSE_NO_SUBMISSION` and
+   * `CAUSE_ATTEMPT_CLOSED` with another close reason; a repeat on an attempt closed by "Done" gets the
+   * same answer. It carries no idempotency key: it repeats by the attempt's state.
+   *
+   * @generated from rpc novatrail.api.v1.AttemptService.Done
+   */
+  done: {
+    methodKind: "unary";
+    input: typeof DoneRequestSchema;
+    output: typeof DoneResponseSchema;
+  },
+  /**
+   * Asks for the words of the rung that a wrong answer gave, sending the work again: the server
+   * keeps no crop. Refusals: `CAUSE_NOT_CURRENT`, `CAUSE_NO_RUNG`, `CAUSE_NO_MORE_WORDS`,
+   * `CAUSE_ATTEMPT_CLOSED`, `CAUSE_KEY_NOT_FOR_PROFILE`, `CAUSE_KEY_ALREADY_USED` and
+   * `CAUSE_STILL_GOING`. A call of AI that gives no words is no refusal: the answer holds the
+   * rung's fallback text and names the outcome. A repeat with the same idempotency key, or a request
+   * for the same wrong answer, gets the words the attempt keeps, with no AI and no marks.
+   *
+   * @generated from rpc novatrail.api.v1.AttemptService.GetRungWords
+   */
+  getRungWords: {
+    methodKind: "unary";
+    input: typeof GetRungWordsRequestSchema;
+    output: typeof GetRungWordsResponseSchema;
+  },
+  /**
+   * Asks for the tutor's words after a correct answer, sending the work again, once, on the attempt
+   * that the answer has just closed. Refusals: `CAUSE_NO_MORE_WORDS`, also on an attempt that no
+   * correct answer closed, `CAUSE_KEY_NOT_FOR_PROFILE`,
+   * `CAUSE_KEY_ALREADY_USED` and `CAUSE_STILL_GOING`. A repeat with the same idempotency key gets
+   * an answer without words: the server keeps none.
+   *
+   * @generated from rpc novatrail.api.v1.AttemptService.GetCorrectAnswerWords
+   */
+  getCorrectAnswerWords: {
+    methodKind: "unary";
+    input: typeof GetCorrectAnswerWordsRequestSchema;
+    output: typeof GetCorrectAnswerWordsResponseSchema;
+  },
+  /**
+   * "Explain differently": the words of the same rung in other words, one call of AI on a rung,
+   * without the work, for the wrong answer it names. Refusals: `CAUSE_NOT_CURRENT`,
+   * `CAUSE_ALREADY_ASKED`, `CAUSE_NO_RUNG`, `CAUSE_ATTEMPT_CLOSED`, `CAUSE_KEY_NOT_FOR_PROFILE`,
+   * `CAUSE_KEY_ALREADY_USED` and `CAUSE_STILL_GOING`; on platform AI, `CAUSE_QUOTA`,
+   * `CAUSE_PLATFORM_LIMIT` and `CAUSE_NOT_ADMITTED` too: it makes no call without the reserve of the
+   * quota, and the right to it on the rung stays. A repeat with the same idempotency key gets the
+   * words the attempt keeps, with no AI.
+   *
+   * @generated from rpc novatrail.api.v1.AttemptService.ExplainDifferently
+   */
+  explainDifferently: {
+    methodKind: "unary";
+    input: typeof ExplainDifferentlyRequestSchema;
+    output: typeof ExplainDifferentlyResponseSchema;
+  },
+  /**
+   * "Hint", a hint the learner asks for, without the work and with no AI: before the first wrong
+   * answer, and on a task with a rubric, the IDs of the task's techniques; after it, the words of the
+   * current rung. Refusals: `CAUSE_ATTEMPT_CLOSED`. It carries no idempotency key: it repeats by
+   * the attempt's state.
+   *
+   * @generated from rpc novatrail.api.v1.AttemptService.GetHint
+   */
+  getHint: {
+    methodKind: "unary";
+    input: typeof GetHintRequestSchema;
+    output: typeof GetHintResponseSchema;
+  },
+  /**
+   * Begins a step of the task's solving steps whose `gives` gives techniques, in the mode "by
+   * steps": the answer is the IDs of the task's techniques. "Step done" sends no request. Refusals:
+   * `CAUSE_ATTEMPT_CLOSED`. It carries no idempotency key: it repeats by the attempt's state.
+   *
+   * @generated from rpc novatrail.api.v1.AttemptService.BeginStep
+   */
+  beginStep: {
+    methodKind: "unary";
+    input: typeof BeginStepRequestSchema;
+    output: typeof BeginStepResponseSchema;
+  },
+  /**
+   * Shows the solution, by a learning action or by an action of an adult, and closes the attempt
+   * `CLOSE_REASON_SOLUTION_SHOWN`. A learning action needs the right `can_learn`, and an action of
+   * an adult `can_manage`: a request without it gets the code `permission_denied`. The PIN of the
+   * section for adults is a barrier of the interface, not of the server (R04 api). Refusals:
+   * `CAUSE_ADULT_NEEDED`, `CAUSE_LADDER_NOT_PASSED`, by either kind of action,
+   * `CAUSE_NO_SHOWING`, `CAUSE_ATTEMPT_CLOSED`, `CAUSE_KEY_ALREADY_USED` and
+   * `CAUSE_STILL_GOING`. A repeat with the same idempotency key gets the solution again.
+   *
+   * @generated from rpc novatrail.api.v1.AttemptService.ShowSolution
+   */
+  showSolution: {
+    methodKind: "unary";
+    input: typeof ShowSolutionRequestSchema;
+    output: typeof ShowSolutionResponseSchema;
+  },
+}>;
+