Index

_

__init__() (API method), [1] (BanList method) (BiasGroup method) (GlobalSettings method) (HighLevel method) (Idstore method) (ImagePreset method) (Keystore method) (LowLevel method) (NovelAIAPI method) (NovelAIError method) (NovelAIStory method) (NovelAIStoryStorage method) (Preset method) (PresetView method) (SchemaValidator method) (SentencePiece method)

A

add() (BanList method) (BiasGroup method) add_original_image (ImagePreset attribute) Aggressive (PhraseRepPen attribute) aimodules_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check) Anime_Curated (ImageModel attribute) Anime_Full (ImageModel attribute) Anime_v2 (ImageModel attribute) Anime_v3 (ImageModel attribute) Anime_v4_Curated (ImageModel attribute) Anime_v4_Full (ImageModel attribute)

Anime_v4_preview (ImageModel attribute) api (API attribute), [1] API (class in example.boilerplate) (class in tests.api.boilerplate) api (NovelAIStory attribute) (NovelAIStoryStorage attribute) api_handle() (in module tests.api.boilerplate) api_handle_sync() (in module tests.api.boilerplate) argon_hash() (in module novelai_api.utils) attach_session() (NovelAIAPI method) augment_image() (LowLevel method) auto_smea (ImagePreset attribute)

B

b64_to_tokens() (in module novelai_api.utils) ban_ambiguous_genji_tokens (GlobalSettings attribute) ban_brackets (GlobalSettings attribute) BanList (class in novelai_api.BanList) banlists (NovelAIStory attribute) BASE_ADDRESS (NovelAIAPI attribute) bias (BiasGroup attribute)

bias_dinkus_asterism (GlobalSettings attribute) biases (NovelAIStory attribute) BiasGroup (class in novelai_api.BiasGroup) bind_subscription() (LowLevel method) bos_token_id (Preset attribute) build_context() (NovelAIStory method) Building_Control (ControlNetModel attribute) buy_steps() (LowLevel method)

C

calculate_cost() (ImagePreset method) CFG (Order attribute) cfg_rescale (ImagePreset attribute) cfg_scale (Preset attribute) change_access_key() (LowLevel method) change_subscription() (LowLevel method) characters (ImagePreset attribute) choose() (NovelAIStory method) classify() (LowLevel method) Clio (Model attribute) collapse_model() (in module novelai_api.Preset) colorize() (HighLevel method)

compress_user_data() (in module novelai_api.utils) context_size (NovelAIStory attribute) controlnet_condition (ImagePreset attribute) controlnet_model (ImagePreset attribute) controlnet_strength (ImagePreset attribute) ControlNetModel (class in novelai_api.ImagePreset) cookies (NovelAIAPI attribute) copy() (GlobalSettings method) (ImagePreset method) (Preset method) create() (Idstore method) (Keystore method) (NovelAIStoryStorage method)

D

data (Keystore attribute) ddim (ImageSampler attribute) ddim_v3 (ImageSampler attribute) declutter() (HighLevel method) decode() (SentencePiece method) (Tokenizer class method) decompress_user_data() (in module novelai_api.utils) decrisper (ImagePreset attribute) decrypt() (Keystore method) decrypt_data() (in module novelai_api.utils) decrypt_user_data() (in module novelai_api.utils) default() (JSONEncoder method), [1] DEFAULT_MODEL (NovelAIStory attribute) DEFAULTS (Preset attribute) delete() (NovelAIStory method)

delete_account() (LowLevel method) delete_module() (LowLevel method) delete_object() (LowLevel method) deliberate_euler_ancestral_bug (ImagePreset attribute) detach_session() (NovelAIAPI method) diversity_penalty (Preset attribute) download_object() (LowLevel method) download_objects() (LowLevel method) download_user_modules() (HighLevel method) download_user_presets() (HighLevel method) download_user_shelves() (HighLevel method) download_user_stories() (HighLevel method) download_user_story_contents() (HighLevel method) dumps() (in module example.boilerplate) (in module tests.api.boilerplate)

E

edit() (NovelAIStory method) emotion() (HighLevel method) enabled (BanList attribute) (BiasGroup attribute) encode() (SentencePiece method) (Tokenizer class method) encoder_no_repeat_ngram_size (Preset attribute) encrypt() (Keystore method) encrypt_data() (in module novelai_api.utils) encrypt_user_data() (in module novelai_api.utils) encryption_key (API property), [1] ensure_sequence_finish (BiasGroup attribute) enum_contains() (in module novelai_api.Preset) enum_member_values (Model attribute) eos_token_id (Preset attribute) Erato (Model attribute) error_handler() (in module tests.api.boilerplate) Euterpe (Model attribute) example.boilerplate module example.download_modules module example.download_presets module example.download_shelves module

example.download_stories_and_content module example.generate_controlnet_masks module example.generate_image module example.generate_image_test_samplers module example.generate_image_with_controlnet module example.generate_image_with_img2img module example.generate_text module example.generate_voice module example.login module example.login_with_proxy module example.suggest_tags module example.upscale_image module extract_preset_data() (in module novelai_api.utils)

F

flatten() (NovelAIStory method) Form_Lock (ControlNetModel attribute) from_data() (BiasGroup class method) from_default() (Preset class method) from_default_config() (ImagePreset class method) from_file() (ImagePreset class method) (Preset class method) from_official() (Preset class method)

from_preset_data() (Preset class method) from_v1_config() (ImagePreset class method) from_v2_config() (ImagePreset class method) from_v3_config() (ImagePreset class method) from_v3_furry_config() (ImagePreset class method) from_v4_config() (ImagePreset class method) Furry (ImageModel attribute) Furry_v3 (ImageModel attribute)

G

gather_asyncgenerator() (in module novelai_api.utils) generate() (HighLevel method) (LowLevel method) (NovelAIStory method) generate_controlnet_mask() (LowLevel method) generate_image() (HighLevel method) (LowLevel method) generate_once (BiasGroup attribute) generate_prompt() (LowLevel method) generate_stream() (HighLevel method) generate_until_sentence (GlobalSettings attribute) generate_voice() (LowLevel method) Genji (Model attribute) get_access_key() (in module novelai_api.utils) get_current_tree() (NovelAIStory method) get_data() (LowLevel method) get_decrypted_user_data() (in module novelai_api.utils)

get_encryption_key() (in module novelai_api.utils) get_hidden_states (Preset attribute) get_information() (LowLevel method) get_keystore() (HighLevel method) (LowLevel method) get_max_n_samples() (ImagePreset method) get_priority() (LowLevel method) get_settings() (LowLevel method) get_subscription() (LowLevel method) get_tokenized_entries() (BanList method) (BiasGroup method) get_tokenizer_name() (Tokenizer class method) get_trained_module() (LowLevel method) get_trained_modules() (LowLevel method) global_settings (NovelAIStory attribute) (NovelAIStoryStorage attribute) GlobalSettings (class in novelai_api.GlobalSettings)

H

headers (NovelAIAPI attribute) high_level (NovelAIAPI attribute)

HighLevel (class in novelai_api._high_level) HypeBot (Model attribute)

I

Idstore (class in novelai_api.Idstore) idstore (NovelAIStoryStorage attribute) image (ImagePreset attribute) ImageGenerationType (class in novelai_api.ImagePreset) ImageModel (class in novelai_api.ImagePreset) ImagePreset (class in novelai_api.ImagePreset) ImageResolution (class in novelai_api.ImagePreset) ImageSampler (class in novelai_api.ImagePreset) IMG2IMG (ImageGenerationType attribute) Inline (Model attribute) INPAINTING (ImageGenerationType attribute) Inpainting_Anime_Curated (ImageModel attribute) Inpainting_Anime_Full (ImageModel attribute)

Inpainting_Anime_v3 (ImageModel attribute) Inpainting_Anime_v4_Curated (ImageModel attribute) Inpainting_Anime_v4_Full (ImageModel attribute) Inpainting_Furry (ImageModel attribute) Inpainting_Furry_v3 (ImageModel attribute) is_model_curated() (ImagePreset class method) is_model_furry() (ImagePreset class method) is_model_inpainting() (ImagePreset class method) is_model_v1() (ImagePreset class method) is_model_v2() (ImagePreset class method) is_model_v3() (ImagePreset class method) is_model_v4() (ImagePreset class method) is_reachable() (LowLevel method) is_schema_validation_enabled (LowLevel attribute)

J

JSONEncoder (class in example.boilerplate) (class in tests.api.boilerplate)

K

k_dpm_2 (ImageSampler attribute) k_dpm_2_ancestral (ImageSampler attribute) k_dpm_adaptive (ImageSampler attribute) k_dpm_fast (ImageSampler attribute) k_dpmpp_2m (ImageSampler attribute) k_dpmpp_2m_sde (ImageSampler attribute) k_dpmpp_2s_ancestral (ImageSampler attribute) k_dpmpp_sde (ImageSampler attribute) k_euler (ImageSampler attribute)

k_euler_ancestral (ImageSampler attribute) k_heun (ImageSampler attribute) k_lms (ImageSampler attribute) Kayra (Model attribute) key (NovelAIStory attribute) Keystore (class in novelai_api.Keystore) keystore (NovelAIStory attribute) (NovelAIStoryStorage attribute) keystore_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check) Krake (Model attribute)

L

Landscaper (ControlNetModel attribute) Large_Landscape (ImageResolution attribute) Large_Landscape_v2 (ImageResolution attribute) Large_Landscape_v3 (ImageResolution attribute) Large_Landscape_v4 (ImageResolution attribute) Large_Portrait (ImageResolution attribute) Large_Portrait_v2 (ImageResolution attribute) Large_Portrait_v3 (ImageResolution attribute) Large_Portrait_v4 (ImageResolution attribute) Large_Square (ImageResolution attribute) Large_Square_v2 (ImageResolution attribute) Large_Square_v3 (ImageResolution attribute) Large_Square_v4 (ImageResolution attribute) last_seed (ImagePreset attribute) legacy_v3_extend (ImagePreset attribute) length_penalty (Preset attribute)

LIB_ROOT (NovelAIAPI attribute) Light (PhraseRepPen attribute) line_art() (HighLevel method) link_content_to_story() (in module novelai_api.utils) load() (NovelAIStoryStorage method) load_from_remote() (NovelAIStoryStorage method) loads() (NovelAIStoryStorage method) logger (API attribute), [1] (NovelAIAPI attribute) login() (HighLevel method) (LowLevel method) login_from_key() (HighLevel method) login_with_token() (HighLevel method) low_level (NovelAIAPI attribute) LowLevel (class in novelai_api._low_level) LowLevel.SubscriptionTier (class in novelai_api._low_level)

M

mask (ImagePreset attribute) math1_quad (Preset attribute) math1_quad_entropy_scale (Preset attribute) math1_temp (Preset attribute) max_length (Preset attribute) max_time (Preset attribute) Medium (PhraseRepPen attribute) message (NovelAIError attribute) min_length (Preset attribute) Min_p (Order attribute) min_p (Preset attribute) Mirostat (Order attribute) mirostat_lr (Preset attribute) mirostat_tau (Preset attribute) Model (class in novelai_api.Preset) model (NovelAIStory attribute) (Preset attribute) (PresetView attribute) module example.boilerplate example.download_modules example.download_presets example.download_shelves example.download_stories_and_content example.generate_controlnet_masks example.generate_image example.generate_image_test_samplers example.generate_image_with_controlnet example.generate_image_with_img2img example.generate_text example.generate_voice example.login example.login_with_proxy example.suggest_tags example.upscale_image novelai_api._high_level novelai_api._low_level novelai_api.BanList novelai_api.BiasGroup novelai_api.GlobalSettings novelai_api.Idstore novelai_api.ImagePreset novelai_api.Keystore novelai_api.NovelAI_API novelai_api.NovelAIError novelai_api.Preset novelai_api.SchemaValidator novelai_api.StoryHandler novelai_api.Tokenizer novelai_api.utils tests.api.boilerplate tests.api.test_decrypt_encrypt_integrity_check tests.api.test_imagegen_samplers tests.api.test_sync_gen tests.api.test_textgen_presets

N

n_samples (ImagePreset attribute) nai_smea (ImageSampler attribute) nai_smea_dyn (ImageSampler attribute) name (Preset attribute) NO_LOGPROBS (GlobalSettings attribute) no_repeat_ngram_size (Preset attribute) noise (ImagePreset attribute) noise_schedule (ImagePreset attribute) NORMAL (ImageGenerationType attribute) Normal_Landscape (ImageResolution attribute) Normal_Landscape_v2 (ImageResolution attribute) Normal_Landscape_v3 (ImageResolution attribute) Normal_Landscape_v4 (ImageResolution attribute) Normal_Portrait (ImageResolution attribute) Normal_Portrait_v2 (ImageResolution attribute) Normal_Portrait_v3 (ImageResolution attribute) Normal_Portrait_v4 (ImageResolution attribute) Normal_Square (ImageResolution attribute) Normal_Square_v2 (ImageResolution attribute) Normal_Square_v3 (ImageResolution attribute) Normal_Square_v4 (ImageResolution attribute) novelai_api._high_level module novelai_api._low_level module novelai_api.BanList module novelai_api.BiasGroup module

novelai_api.GlobalSettings module novelai_api.Idstore module novelai_api.ImagePreset module novelai_api.Keystore module novelai_api.NovelAI_API module novelai_api.NovelAIError module novelai_api.Preset module novelai_api.SchemaValidator module novelai_api.StoryHandler module novelai_api.Tokenizer module novelai_api.utils module NovelAIAPI (class in novelai_api.NovelAI_API) NovelAIError NovelAIStory (class in novelai_api.StoryHandler) NovelAIStoryStorage (class in novelai_api.StoryHandler) num_logprobs (GlobalSettings attribute) num_return_sequences (Preset attribute)

O

Off (PhraseRepPen attribute) OPUS (LowLevel.SubscriptionTier attribute)

Order (class in novelai_api.Preset) order (Preset attribute)

P

pad_token_id (Preset attribute) Palette_Swap (ControlNetModel attribute) PAPER (LowLevel.SubscriptionTier attribute) params_version (ImagePreset attribute) phrase_rep_pen (Preset attribute) PhraseRepPen (class in novelai_api.Preset) plms (ImageSampler attribute) PREAMBLE (in module novelai_api.Preset) prefer_brownian (ImagePreset attribute) prefix (NovelAIStory attribute) Preset (class in novelai_api.Preset) preset (NovelAIStory attribute)

Preset_Bad_Anatomy (UCPreset attribute) preset_from_default() (in module tests.api.test_textgen_presets) preset_from_official() (in module tests.api.test_textgen_presets) Preset_Heavy (UCPreset attribute) Preset_Light (UCPreset attribute) Preset_Low_Quality (UCPreset attribute) Preset_Low_Quality_Bad_Anatomy (UCPreset attribute) Preset_None (UCPreset attribute) presets_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check) PresetView (class in novelai_api.Preset) print_with_parameters() (in module novelai_api._low_level) proxy (NovelAIAPI attribute) proxy_auth (NovelAIAPI attribute)

Q

quality_toggle (ImagePreset attribute)

R

recover_account() (LowLevel method) redo() (NovelAIStory method) reference_image (ImagePreset attribute) reference_image_multiple (ImagePreset attribute) reference_information_extracted (ImagePreset attribute) reference_information_extracted_multiple (ImagePreset attribute) reference_strength (ImagePreset attribute) reference_strength_multiple (ImagePreset attribute) register() (HighLevel method) (Idstore method) (LowLevel method)

remove_background() (HighLevel method) rep_pen_whitelist (GlobalSettings attribute) repetition_penalty (Preset attribute) repetition_penalty_default_whitelist (Preset attribute) repetition_penalty_frequency (Preset attribute) repetition_penalty_presence (Preset attribute) repetition_penalty_range (Preset attribute) repetition_penalty_slope (Preset attribute) repetition_penalty_whitelist (Preset attribute) request() (LowLevel method) request_account_recovery() (LowLevel method) resolution (ImagePreset attribute)

S

sampler (ImagePreset attribute) sampling_options (Preset attribute) save() (NovelAIStory method) scale (ImagePreset attribute) SchemaValidator (class in novelai_api.SchemaValidator) Scribbler (ControlNetModel attribute) SCROLL (LowLevel.SubscriptionTier attribute) seed (ImagePreset attribute) select() (NovelAIStoryStorage method) send_email_verification() (LowLevel method) SentencePiece (class in novelai_api.Tokenizer) session (NovelAIAPI attribute) set() (Preset method) set_keystore() (HighLevel method) (LowLevel method) set_sampling_options_state() (Preset method) set_settings() (LowLevel method) shelves_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check) Sigurd (Model attribute) sketch() (HighLevel method) Small_Landscape (ImageResolution attribute) Small_Landscape_v2 (ImageResolution attribute)

Small_Landscape_v3 (ImageResolution attribute) Small_Landscape_v4 (ImageResolution attribute) Small_Portrait (ImageResolution attribute) Small_Portrait_v2 (ImageResolution attribute) Small_Portrait_v3 (ImageResolution attribute) Small_Portrait_v4 (ImageResolution attribute) Small_Square (ImageResolution attribute) Small_Square_v2 (ImageResolution attribute) Small_Square_v3 (ImageResolution attribute) Small_Square_v4 (ImageResolution attribute) smea (ImagePreset attribute) smea_dyn (ImagePreset attribute) Snek (Model attribute) status (NovelAIError attribute) steps (ImagePreset attribute) stories_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check) story (NovelAIStory attribute) storycontent (NovelAIStory attribute) storycontent_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check) strength (ImagePreset attribute) StrEnum (class in novelai_api.Preset) suggest_tags() (LowLevel method)

T

TABLET (LowLevel.SubscriptionTier attribute) tail_free_sampling (Preset attribute) Temperature (Order attribute) temperature (Preset attribute) test_presets() (in module tests.api.test_textgen_presets) tests.api.boilerplate module tests.api.test_decrypt_encrypt_integrity_check module tests.api.test_imagegen_samplers module tests.api.test_sync_gen module tests.api.test_textgen_presets module TEXT_GENERATION_SETTINGS_VERSION (NovelAIStory attribute) textGenerationSettingsVersion (Preset attribute) TFS (Order attribute) timeout (NovelAIAPI property) to_file() (ImagePreset method) (Preset method)

to_settings() (GlobalSettings method) (ImagePreset method) (Preset method) tokenize_if_not() (in module novelai_api.utils) Tokenizer (class in novelai_api.Tokenizer) tokens_to_b64() (in module novelai_api.utils) Top_A (Order attribute) top_a (Preset attribute) Top_G (Order attribute) Top_K (Order attribute) top_k (Preset attribute) Top_P (Order attribute) top_p (Preset attribute) train_module() (LowLevel method) trans_regex_str (SentencePiece attribute) trans_table_ids (SentencePiece attribute) trans_table_str (SentencePiece attribute) tree (NovelAIStory attribute) Typical_P (Order attribute) typical_p (Preset attribute)

U

uc (ImagePreset attribute) uc_preset (ImagePreset attribute) UCPreset (class in novelai_api.ImagePreset) uncond_scale (ImagePreset attribute) undo() (NovelAIStory method) Unified (Order attribute) unlink_content_from_story() (in module novelai_api.utils) unload() (NovelAIStoryStorage method)

update() (ImagePreset method) (Preset method) upload_object() (LowLevel method) upload_objects() (LowLevel method) upload_user_content() (HighLevel method) upload_user_contents() (HighLevel method) upscale_image() (LowLevel method) url (NovelAIError attribute) use_coords (ImagePreset attribute)

V

validate() (SchemaValidator class method) variety_plus (ImagePreset attribute)

verify_email() (LowLevel method) VeryAggressive (PhraseRepPen attribute) VeryLight (PhraseRepPen attribute)

W

Wallpaper_Landscape (ImageResolution attribute)

Wallpaper_Portrait (ImageResolution attribute)