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.
message
scheduler.proto:365repeated items = 1
rpc FsrsBenchmark (, )
scheduler.proto:71Generates parameters used for FSRS's scheduler benchmarks.
message
scheduler.proto:369repeated train_set = 1
message
scheduler.proto:373repeated float params = 1
rpc ExportDataset (, )
scheduler.proto:73Used for exporting revlogs for algorithm research.
message
scheduler.proto:377uint32 min_entries = 1
string target_path = 2
rpc GetQueuedCards (, )
scheduler.proto:18message
scheduler.proto:149uint32 fetch_limit = 1
bool intraday_learning_only = 2
message
scheduler.proto:130repeated cards = 1
uint32 new_count = 2
uint32 learning_count = 3
uint32 review_count = 4
rpc AnswerCard (, )
scheduler.proto:19message
scheduler.proto:268int64 card_id = 1
optional current_state = 2
optional new_state = 3
CardAnswer.Rating rating = 4
int64 answered_at_millis = 5
uint32 milliseconds_taken = 6
optional bool from_queue = 7
rpc SchedTimingToday (, )
scheduler.proto:20rpc StudiedToday (, )
scheduler.proto:21message
scheduler.proto:159uint32 cards = 1
double seconds = 2
rpc UpdateStats (, )
scheduler.proto:23message
scheduler.proto:164int64 deck_id = 1
int32 new_delta = 2
int32 review_delta = 4
int32 millisecond_delta = 5
rpc ExtendLimits (, )
scheduler.proto:24message
scheduler.proto:171int64 deck_id = 1
int32 new_delta = 2
int32 review_delta = 3
rpc CountsForDeckToday (, )
scheduler.proto:25message
scheduler.proto:177int32 new = 1
int32 review = 2
rpc CongratsInfo (, )
scheduler.proto:26message
scheduler.proto:182uint32 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 UnburyDeck (, )
scheduler.proto:29message
scheduler.proto:194int64 deck_id = 1
UnburyDeckRequest.Mode mode = 2
rpc BuryOrSuspendCards (, )
scheduler.proto:30message
scheduler.proto:204repeated int64 card_ids = 1
repeated int64 note_ids = 2
BuryOrSuspendCardsRequest.Mode mode = 3
rpc EmptyFilteredDeck (, )
scheduler.proto:32rpc ScheduleCardsAsNew (, )
scheduler.proto:34message
scheduler.proto:215repeated int64 card_ids = 1
bool log = 2
bool restore_position = 3
bool reset_counts = 4
optional ScheduleCardsAsNewRequest.Context context = 5
message
scheduler.proto:227ScheduleCardsAsNewRequest.Context context = 1
message
scheduler.proto:231bool restore_position = 1
bool reset_counts = 2
rpc SetDueDate (, )
scheduler.proto:38message
scheduler.proto:236repeated int64 card_ids = 1
string days = 2
optional config_key = 3
rpc GradeNow (, )
scheduler.proto:39message
scheduler.proto:242repeated int64 card_ids = 1
CardAnswer.Rating rating = 2
rpc SortCards (, )
scheduler.proto:40message
scheduler.proto:247repeated int64 card_ids = 1
uint32 starting_from = 2
uint32 step_size = 3
bool randomize = 4
bool shift_existing = 5
rpc SortDeck (, )
scheduler.proto:41message
scheduler.proto:255int64 deck_id = 1
bool randomize = 2
rpc DescribeNextStates (, )
scheduler.proto:43rpc StateIsLeech (, )
scheduler.proto:44rpc UpgradeScheduler (, )
scheduler.proto:45rpc CustomStudy (, )
scheduler.proto:46message
scheduler.proto:285int64 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
cram = 7
message
scheduler.proto:326int64 deck_id = 1
message
scheduler.proto:330repeated 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 RepositionDefaults (, )
scheduler.proto:49message
scheduler.proto:347bool random = 1
bool shift = 2
rpc ComputeFsrsParams (, )
scheduler.proto:50message
scheduler.proto:352string 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
message
scheduler.proto:417string search = 1
message
scheduler.proto:421uint32 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
message
scheduler.proto:413float optimal_retention = 1
rpc SimulateFsrsReview (, )
scheduler.proto:56message
scheduler.proto:406repeated float accumulated_knowledge_acquisition = 1
repeated uint32 daily_review_count = 2
repeated uint32 daily_new_count = 3
repeated float daily_time_cost = 4
rpc EvaluateParams (, )
scheduler.proto:58message
scheduler.proto:438repeated float params = 1
string search = 2
int64 ignore_revlogs_before_ms = 3
message
scheduler.proto:444float log_loss = 1
float rmse_bins = 2
rpc ComputeMemoryState (, )
scheduler.proto:59message
scheduler.proto:449optional state = 1
float desired_retention = 2
rpc FuzzDelta (, )
scheduler.proto:62The number of days the calculated interval was fuzzed by on the previous review (if any). Utilized by the FSRS add-on.
message
scheduler.proto:454int64 card_id = 1
uint32 interval = 2
message
scheduler.proto:459sint32 delta_days = 1
Used in:
SUSPEND = 0
BURY_SCHED = 1
BURY_USER = 2
Used in: ,
AGAIN = 0
HARD = 1
GOOD = 2
EASY = 3
message
scheduler.proto:360Used as response type in: BackendSchedulerService.ComputeFsrsParamsFromItems, SchedulerService.ComputeFsrsParams
repeated float params = 1
uint32 fsrs_items = 2
message
scheduler.proto:331Used in:
string name = 1
bool include = 2
bool exclude = 3
message
scheduler.proto:286Used in:
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_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
message
scheduler.proto:382Used in: ,
repeated reviews = 1
message
scheduler.proto:386Used in:
uint32 rating = 1
uint32 delta_t = 2
Used in:
NEW = 0
LEARNING = 1
REVIEW = 2
message
scheduler.proto:136Used in:
optional card = 1
Queue queue = 2
optional states = 3
optional context = 4
message
scheduler.proto:154Used as response type in: ankidroid.BackendAnkidroidService.SchedTimingTodayLegacy, SchedulerService.SchedTimingToday
uint32 days_elapsed = 1
int64 next_day_at = 2
Used in: ,
BROWSER = 0
REVIEWER = 1
message
scheduler.proto:321Used in: ,
string deck_name = 1
uint64 seed = 2
message
scheduler.proto:76Used as request type in: SchedulerService.StateIsLeech
Used as field type in: ,
oneof kind
normal = 1
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.
message
scheduler.proto:113Used in:
oneof kind
preview = 1
rescheduling = 2
message
scheduler.proto:80Used in: ,
uint32 remaining_steps = 1
uint32 scheduled_secs = 2
uint32 elapsed_secs = 3
optional memory_state = 6
message
scheduler.proto:77Used in:
uint32 position = 1
message
scheduler.proto:98Used in: ,
oneof kind
new = 1
learning = 2
review = 3
relearning = 4
message
scheduler.proto:106Used in:
uint32 scheduled_secs = 1
bool finished = 2
message
scheduler.proto:94Used in:
optional review = 1
optional learning = 2
message
scheduler.proto:110Used in:
optional original_state = 1
message
scheduler.proto:86Used in: ,
uint32 scheduled_days = 1
uint32 elapsed_days = 2
float ease_factor = 3
uint32 lapses = 4
bool leeched = 5
optional memory_state = 6
message
scheduler.proto:260Used as request type in: SchedulerService.DescribeNextStates
Used as response type in: SchedulerService.GetSchedulingStates
Used as field type in: , ,
optional current = 1
optional again = 2
optional hard = 3
optional good = 4
optional easy = 5
message
scheduler.proto:391Used as request type in: SchedulerService.ComputeOptimalRetention, SchedulerService.SimulateFsrsReview
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
Used in:
ALL = 0
SCHED_ONLY = 1
USER_ONLY = 2