package anki.scheduler

Get desktop application:
View/edit binary Protocol Buffers messages

Implicitly includes any of the above methods that are not listed in the backend service.

• rpc ComputeFsrsParamsFromItems (ComputeFsrsParamsFromItemsRequest, ComputeFsrsParamsResponse)

  scheduler.proto:72

  message ComputeFsrsParamsFromItemsRequest

  scheduler.proto:372

  • repeated FsrsItem items = 1

• rpc ExportDataset (ExportDatasetRequest, generic.Empty)

  scheduler.proto:77

  Used for exporting revlogs for algorithm research.

  message ExportDatasetRequest

  scheduler.proto:384

  • uint32 min_entries = 1

  • string target_path = 2

• rpc FsrsBenchmark (FsrsBenchmarkRequest, FsrsBenchmarkResponse)

  scheduler.proto:75

  Generates parameters used for FSRS's scheduler benchmarks.

  message FsrsBenchmarkRequest

  scheduler.proto:376

  • repeated FsrsItem train_set = 1

  message FsrsBenchmarkResponse

  scheduler.proto:380

  • repeated float params = 1

• rpc AnswerCard (CardAnswer, collection.OpChanges)

  scheduler.proto:19

  message CardAnswer

  scheduler.proto:272

  • int64 card_id = 1

  • optional SchedulingState current_state = 2

  • optional SchedulingState new_state = 3

  • CardAnswer.Rating rating = 4

  • int64 answered_at_millis = 5

  • uint32 milliseconds_taken = 6

• rpc BuryOrSuspendCards (BuryOrSuspendCardsRequest, collection.OpChangesWithCount)

  scheduler.proto:30

  message BuryOrSuspendCardsRequest

  scheduler.proto:208

  • repeated int64 card_ids = 1

  • repeated int64 note_ids = 2

  • BuryOrSuspendCardsRequest.Mode mode = 3

• rpc ComputeFsrsParams (ComputeFsrsParamsRequest, ComputeFsrsParamsResponse)

  scheduler.proto:50

  message ComputeFsrsParamsRequest

  scheduler.proto:357

  • string search = 1

    / The search used to gather cards for training

  • repeated float current_params = 2

  • int64 ignore_revlogs_before_ms = 3

  • uint32 num_of_relearning_steps = 4

  • bool health_check = 5

• rpc ComputeMemoryState (cards.CardId, ComputeMemoryStateResponse)

  scheduler.proto:63

  message ComputeMemoryStateResponse

  scheduler.proto:472

  • optional cards.FsrsMemoryState state = 1

  • float desired_retention = 2

  • float decay = 3

• rpc ComputeOptimalRetention (SimulateFsrsReviewRequest, ComputeOptimalRetentionResponse)

  scheduler.proto:54

  message ComputeOptimalRetentionResponse

  scheduler.proto:430

  • float optimal_retention = 1

• rpc CongratsInfo (generic.Empty, CongratsInfoResponse)

  scheduler.proto:26

  message CongratsInfoResponse

  scheduler.proto:186

  • uint32 learn_remaining = 1

  • uint32 secs_until_next_learn = 2

  • bool review_remaining = 3

  • bool new_remaining = 4

  • bool have_sched_buried = 5

  • bool have_user_buried = 6

  • bool is_filtered_deck = 7

  • bool bridge_commands_supported = 8

  • string deck_description = 9

• rpc CountsForDeckToday (decks.DeckId, CountsForDeckTodayResponse)

  scheduler.proto:25

  message CountsForDeckTodayResponse

  scheduler.proto:181

  • int32 new = 1

  • int32 review = 2

• rpc CustomStudy (CustomStudyRequest, collection.OpChanges)

  scheduler.proto:46

  message CustomStudyRequest

  scheduler.proto:288

  • int64 deck_id = 1

  • oneof value

    • int32 new_limit_delta = 2

      increase new limit by x

    • int32 review_limit_delta = 3

      increase review limit by x

    • uint32 forgot_days = 4

      repeat cards forgotten in the last x days

    • uint32 review_ahead_days = 5

      review cards due in the next x days

    • uint32 preview_days = 6

      preview new cards added in the last x days

    • CustomStudyRequest.Cram cram = 7

• rpc CustomStudyDefaults (CustomStudyDefaultsRequest, CustomStudyDefaultsResponse)

  scheduler.proto:47

  message CustomStudyDefaultsRequest

  scheduler.proto:331

  • int64 deck_id = 1

  message CustomStudyDefaultsResponse

  scheduler.proto:335

  • repeated CustomStudyDefaultsResponse.Tag tags = 1

  • uint32 extend_new = 2

  • uint32 extend_review = 3

  • uint32 available_new = 4

  • uint32 available_review = 5

  • uint32 available_new_in_children = 6

    in v3, counts for children are provided separately

  • uint32 available_review_in_children = 7

• rpc DescribeNextStates (SchedulingStates, generic.StringList)

  scheduler.proto:43

• rpc EmptyFilteredDeck (decks.DeckId, collection.OpChanges)

  scheduler.proto:32

• rpc EvaluateParams (EvaluateParamsRequest, EvaluateParamsResponse)

  scheduler.proto:60

  message EvaluateParamsRequest

  scheduler.proto:455

  • string search = 1

  • int64 ignore_revlogs_before_ms = 2

  • uint32 num_of_relearning_steps = 3

• rpc EvaluateParamsLegacy (EvaluateParamsLegacyRequest, EvaluateParamsResponse)

  scheduler.proto:61

  message EvaluateParamsLegacyRequest

  scheduler.proto:461

  • repeated float params = 1

  • string search = 2

  • int64 ignore_revlogs_before_ms = 3

• rpc ExtendLimits (ExtendLimitsRequest, generic.Empty)

  scheduler.proto:24

  message ExtendLimitsRequest

  scheduler.proto:175

  • int64 deck_id = 1

  • int32 new_delta = 2

  • int32 review_delta = 3

• rpc FuzzDelta (FuzzDeltaRequest, FuzzDeltaResponse)

  scheduler.proto:66

  The number of days the calculated interval was fuzzed by on the previous review (if any). Utilized by the FSRS add-on.

  message FuzzDeltaRequest

  scheduler.proto:478

  • int64 card_id = 1

  • uint32 interval = 2

  message FuzzDeltaResponse

  scheduler.proto:483

  • sint32 delta_days = 1

• rpc GetOptimalRetentionParameters (GetOptimalRetentionParametersRequest, GetOptimalRetentionParametersResponse)

  scheduler.proto:52

  message GetOptimalRetentionParametersRequest

  scheduler.proto:434

  • string search = 1

  message GetOptimalRetentionParametersResponse

  scheduler.proto:438

  • uint32 deck_size = 1

  • uint32 learn_span = 2

  • float max_cost_perday = 3

  • float max_ivl = 4

  • repeated float first_rating_prob = 5

  • repeated float review_rating_prob = 6

  • float loss_aversion = 7

  • uint32 learn_limit = 8

  • uint32 review_limit = 9

  • repeated float learning_step_transitions = 10

  • repeated float relearning_step_transitions = 11

  • repeated float state_rating_costs = 12

  • uint32 learning_step_count = 13

  • uint32 relearning_step_count = 14

• rpc GetQueuedCards (GetQueuedCardsRequest, QueuedCards)

  scheduler.proto:18

  message GetQueuedCardsRequest

  scheduler.proto:153

  • uint32 fetch_limit = 1

  • bool intraday_learning_only = 2

  message QueuedCards

  scheduler.proto:134

  • repeated QueuedCards.QueuedCard cards = 1

  • uint32 new_count = 2

  • uint32 learning_count = 3

  • uint32 review_count = 4

• rpc GetSchedulingStates (cards.CardId, SchedulingStates)

  scheduler.proto:42

• rpc GradeNow (GradeNowRequest, collection.OpChanges)

  scheduler.proto:39

  message GradeNowRequest

  scheduler.proto:246

  • repeated int64 card_ids = 1

  • CardAnswer.Rating rating = 2

• rpc RebuildFilteredDeck (decks.DeckId, collection.OpChangesWithCount)

  scheduler.proto:33

• rpc RepositionDefaults (generic.Empty, RepositionDefaultsResponse)

  scheduler.proto:49

  message RepositionDefaultsResponse

  scheduler.proto:352

  • bool random = 1

  • bool shift = 2

• rpc RestoreBuriedAndSuspendedCards (cards.CardIds, collection.OpChanges)

  scheduler.proto:27

• rpc SchedTimingToday (generic.Empty, SchedTimingTodayResponse)

  scheduler.proto:20

• rpc ScheduleCardsAsNew (ScheduleCardsAsNewRequest, collection.OpChanges)

  scheduler.proto:34

  message ScheduleCardsAsNewRequest

  scheduler.proto:219

  • repeated int64 card_ids = 1

  • bool log = 2

  • bool restore_position = 3

  • bool reset_counts = 4

  • optional ScheduleCardsAsNewRequest.Context context = 5

• rpc ScheduleCardsAsNewDefaults (ScheduleCardsAsNewDefaultsRequest, ScheduleCardsAsNewDefaultsResponse)

  scheduler.proto:36

  message ScheduleCardsAsNewDefaultsRequest

  scheduler.proto:231

  • ScheduleCardsAsNewRequest.Context context = 1

  message ScheduleCardsAsNewDefaultsResponse

  scheduler.proto:235

  • bool restore_position = 1

  • bool reset_counts = 2

• rpc SetDueDate (SetDueDateRequest, collection.OpChanges)

  scheduler.proto:38

  message SetDueDateRequest

  scheduler.proto:240

  • repeated int64 card_ids = 1

  • string days = 2

  • optional config.OptionalStringConfigKey config_key = 3

• rpc SimulateFsrsReview (SimulateFsrsReviewRequest, SimulateFsrsReviewResponse)

  scheduler.proto:56

  message SimulateFsrsReviewResponse

  scheduler.proto:416

  • repeated float accumulated_knowledge_acquisition = 1

  • repeated uint32 daily_review_count = 2

  • repeated uint32 daily_new_count = 3

  • repeated float daily_time_cost = 4

• rpc SimulateFsrsWorkload (SimulateFsrsReviewRequest, SimulateFsrsWorkloadResponse)

  scheduler.proto:58

  message SimulateFsrsWorkloadResponse

  scheduler.proto:423

  • map<uint32, float> cost = 1

  • float reviewless_end_memorized = 2

  • map<uint32, float> memorized = 3

  • map<uint32, uint32> review_count = 4

• rpc SortCards (SortCardsRequest, collection.OpChangesWithCount)

  scheduler.proto:40

  message SortCardsRequest

  scheduler.proto:251

  • repeated int64 card_ids = 1

  • uint32 starting_from = 2

  • uint32 step_size = 3

  • bool randomize = 4

  • bool shift_existing = 5

• rpc SortDeck (SortDeckRequest, collection.OpChangesWithCount)

  scheduler.proto:41

  message SortDeckRequest

  scheduler.proto:259

  • int64 deck_id = 1

  • bool randomize = 2

• rpc StateIsLeech (SchedulingState, generic.Bool)

  scheduler.proto:44

• rpc StudiedToday (generic.Empty, generic.String)

  scheduler.proto:21

• rpc StudiedTodayMessage (StudiedTodayMessageRequest, generic.String)

  scheduler.proto:22

  message StudiedTodayMessageRequest

  scheduler.proto:163

  • uint32 cards = 1

  • double seconds = 2

• rpc UnburyDeck (UnburyDeckRequest, collection.OpChanges)

  scheduler.proto:29

  message UnburyDeckRequest

  scheduler.proto:198

  • int64 deck_id = 1

  • UnburyDeckRequest.Mode mode = 2

• rpc UpdateStats (UpdateStatsRequest, generic.Empty)

  scheduler.proto:23

  message UpdateStatsRequest

  scheduler.proto:168

  • int64 deck_id = 1

  • int32 new_delta = 2

  • int32 review_delta = 4

  • int32 millisecond_delta = 5

• rpc UpgradeScheduler (generic.Empty, generic.Empty)

  scheduler.proto:45

Used in: BuryOrSuspendCardsRequest

• SUSPEND = 0

• BURY_SCHED = 1

• BURY_USER = 2

Used in: CardAnswer, GradeNowRequest

• AGAIN = 0

• HARD = 1

• GOOD = 2

• EASY = 3

Used as response type in: BackendSchedulerService.ComputeFsrsParamsFromItems, SchedulerService.ComputeFsrsParams

• repeated float params = 1

• uint32 fsrs_items = 2

• optional bool health_check_passed = 3

Used in: CustomStudyDefaultsResponse

• string name = 1

• bool include = 2

• bool exclude = 3

Used in: CustomStudyRequest

• Cram.CramKind kind = 1

• uint32 card_limit = 2

  the maximum number of cards

• repeated string tags_to_include = 3

  cards must match one of these, if unempty

• repeated string tags_to_exclude = 4

  cards must not match any of these

Used in: Cram

• CRAM_KIND_DUE = 0

  due cards in due order

• CRAM_KIND_NEW = 1

  new cards in added order

• CRAM_KIND_REVIEW = 2

  review cards in random order

• CRAM_KIND_ALL = 3

  all cards in random order; no rescheduling

Used as response type in: SchedulerService.EvaluateParams, SchedulerService.EvaluateParamsLegacy

• float log_loss = 1

• float rmse_bins = 2

Used in: ComputeFsrsParamsFromItemsRequest, FsrsBenchmarkRequest

• repeated FsrsReview reviews = 1

Used in: FsrsItem

• uint32 rating = 1

• uint32 delta_t = 2

Used in: QueuedCard

• NEW = 0

• LEARNING = 1

• REVIEW = 2

Used in: QueuedCards

• optional cards.Card card = 1

• Queue queue = 2

• optional SchedulingStates states = 3

• optional SchedulingContext context = 4

Used as response type in: ankidroid.BackendAnkidroidService.SchedTimingTodayLegacy, SchedulerService.SchedTimingToday

• uint32 days_elapsed = 1

• int64 next_day_at = 2

Used in: ScheduleCardsAsNewDefaultsRequest, ScheduleCardsAsNewRequest

• BROWSER = 0

• REVIEWER = 1

Used in: frontend.SchedulingStatesWithContext, QueuedCards.QueuedCard

• string deck_name = 1

• uint64 seed = 2

• optional float decay = 3

• optional float desired_retention = 4

Used as request type in: SchedulerService.StateIsLeech

Used as field type in: CardAnswer, SchedulingStates

• oneof kind

  • SchedulingState.Normal normal = 1

  • SchedulingState.Filtered filtered = 2

• optional string custom_data = 3

  The backend does not populate this field in GetQueuedCards; the front-end is expected to populate it based on the provided Card. If it's not set when answering a card, the existing custom data will not be updated.

Used in: SchedulingState

• oneof kind

  • Preview preview = 1

  • ReschedulingFilter rescheduling = 2

Used in: Normal, Relearning

• uint32 remaining_steps = 1

• uint32 scheduled_secs = 2

• uint32 elapsed_secs = 3

• optional cards.FsrsMemoryState memory_state = 6

Used in: Normal

• uint32 position = 1

Used in: SchedulingState, ReschedulingFilter

• oneof kind

  • New new = 1

  • Learning learning = 2

  • Review review = 3

  • Relearning relearning = 4

Used in: Filtered

• uint32 scheduled_secs = 1

• bool finished = 2

Used in: Normal

• optional Review review = 1

• optional Learning learning = 2

Used in: Filtered

• optional Normal original_state = 1

Used in: Normal, Relearning

• uint32 scheduled_days = 1

• uint32 elapsed_days = 2

• float ease_factor = 3

• uint32 lapses = 4

• bool leeched = 5

• optional cards.FsrsMemoryState memory_state = 6

Used as request type in: SchedulerService.DescribeNextStates

Used as response type in: SchedulerService.GetSchedulingStates

Used as field type in: frontend.SchedulingStatesWithContext, frontend.SetSchedulingStatesRequest, QueuedCards.QueuedCard

• optional SchedulingState current = 1

• optional SchedulingState again = 2

• optional SchedulingState hard = 3

• optional SchedulingState good = 4

• optional SchedulingState easy = 5

Used as request type in: SchedulerService.ComputeOptimalRetention, SchedulerService.SimulateFsrsReview, SchedulerService.SimulateFsrsWorkload

• repeated float params = 1

• float desired_retention = 2

• uint32 deck_size = 3

• uint32 days_to_simulate = 4

• uint32 new_limit = 5

• uint32 review_limit = 6

• uint32 max_interval = 7

• string search = 8

• bool new_cards_ignore_review_limit = 9

• repeated float easy_days_percentages = 10

• deck_config.DeckConfig.Config.ReviewCardOrder review_order = 11

• optional uint32 suspend_after_lapse_count = 12

• float historical_retention = 13

• uint32 learning_step_count = 14

• uint32 relearning_step_count = 15

Used in: UnburyDeckRequest

• ALL = 0

• SCHED_ONLY = 1

• USER_ONLY = 2