Welcome to illustration’s documentation!

Contents:

• illustration
  • BeatSelection
  • Budget
  • Candidate
  • CurateDependencyError
  • CurationResult
  • Grade
  • IllustrationError
  • ImageResult
  • InspectReport
  • IterationRecord
  • MissingCredentialError
  • PrefilterReport
  • PrefilterResult
  • ProviderError
  • RateLimitError
  • RerankDependencyError
  • RetrievalSource
  • RubricScore
  • SearchCache
  • SelectionBody
  • SequenceResult
  • SequenceSelection
  • SourceInfo
  • SourcesView
  • UnknownSourceError
  • blur_check()
  • brightness_check()
  • cache_dir()
  • check_requirements()
  • check_rerank_requirements()
  • curate()
  • curate_sequence()
  • default_search_store()
  • default_sources()
  • expand_query()
  • export_otio()
  • get_source()
  • hamming_distance()
  • inspect_candidate()
  • judge_candidate()
  • license_allowlist()
  • list_sources()
  • make_param_translator()
  • make_phash_hasher()
  • make_siglip_scorer()
  • normalize_license()
  • nsfw_check()
  • package_version()
  • persist_sequence()
  • phash()
  • prefilter()
  • record_override()
  • refine_query()
  • register_source()
  • render_sequence_video()
  • requires_credentials()
  • rerank()
  • resolve_api_key()
  • resolve_selection()
  • resolved_selections()
  • score_grade()
  • search()
  • search_cache_key()
  • select_sequence()
  • to_search_hit()
  • to_walkthru_document()
  • unregister_source()
  • using_credentials()
• illustration.__main__
  • main()
• illustration._imageio
  • DFLT_IMAGE_FIELD
  • fetch_image()
  • fetch_image_bytes()
  • image_for_result()
• illustration.base
  • RetrievalSource
  • SourceInfo
• illustration.caching
  • SearchCache
  • default_search_store()
  • search_cache_key()
• illustration.cli
  • COMMANDS
  • curate()
  • curate_sequence()
  • info()
  • search()
  • sources()
• illustration.config
  • DFLT_LICENSE_ALLOWLIST
  • DFLT_N
  • DFLT_SOURCES
  • HTTP_TIMEOUT
  • MAX_PAGES
  • SEARCH_CACHE_SCHEMA
  • cache_dir()
  • config_dir()
  • data_dir()
  • package_version()
  • user_agent()
• illustration.credentials
  • PROVIDER_CONSOLE_URLS
  • PROVIDER_ENV_VARS
  • check_requirements()
  • current_credentials()
  • requires_credentials()
  • resolve_api_key()
  • using_credentials()
• illustration.curation
  • Budget
  • Candidate
  • CurationResult
  • DFLT_CURATE_N
  • Grade
  • Grader
  • IterationRecord
  • curate()
  • score_grade()
• illustration.errors
  • CurateDependencyError
  • IllustrationError
  • MissingCredentialError
  • ProviderError
  • RateLimitError
  • RerankDependencyError
  • UnknownSourceError
• illustration.expansion
  • DFLT_N_EXPANSIONS
  • Expander
  • Refiner
  • expand_query()
  • make_query_expander()
  • make_query_refiner()
  • refine_query()
• illustration.facade
  • search()
• illustration.inspection
  • CORE_CHECKS
  • Check
  • CheckOutcome
  • DEFAULT_CHECKS
  • DFLT_CAPTION_MAX_TOKENS
  • Describe
  • InspectReport
  • PrefilterReport
  • PrefilterResult
  • RubricScore
  • SafetyGateDisabledWarning
  • aspect_ratio_check()
  • blur_check()
  • brightness_check()
  • default_checks()
  • inspect_candidate()
  • judge_candidate()
  • min_dimension_check()
  • nsfw_check()
  • prefilter()
• illustration.licensing
  • LICENSE_ALIASES
  • RESTRICTION_TOKENS
  • normalize_license()
• illustration.persistence
  • SELECTIONS_TIER
  • SELECTION_SCHEMA_URI
  • SelectionBody
  • export_otio()
  • persist_sequence()
  • record_override()
  • resolve_selection()
  • resolved_selections()
• illustration.providers
  • OpenverseSource
  • PexelsSource
  • PixabaySource
  • WikimediaSource
• illustration.providers.openverse
  • OpenverseSource
• illustration.providers.pexels
  • PexelsSource
• illustration.providers.pixabay
  • PixabaySource
• illustration.providers.wikimedia
  • WikimediaSource
• illustration.registry
  • SourcesView
  • default_sources()
  • get_source()
  • list_sources()
  • register_source()
  • sources
  • unregister_source()
• illustration.reranking
  • DFLT_RERANK_MODEL
  • Scorer
  • SiglipScorer
  • check_rerank_requirements()
  • default_scorer()
  • embed_images()
  • make_siglip_scorer()
  • rerank()
• illustration.schema
  • ImageResult
  • RIGHTS_FIELDS
  • license_allowlist()
  • to_search_hit()
• illustration.sequence
  • BeatSelection
  • DFLT_ALPHA
  • DFLT_BETA
  • DFLT_PHASH_THRESHOLD
  • DFLT_SEQUENCE_N
  • SequenceResult
  • SequenceSelection
  • curate_sequence()
  • hamming_distance()
  • make_phash_hasher()
  • phash()
  • select_sequence()
• illustration.translation
  • ParamTranslator
  • make_param_translator()
• illustration.video
  • DFLT_FPS
  • DFLT_PANEL_DURATION_S
  • render_sequence_video()
  • to_walkthru_document()

Indices and tables

• Index

• Module Index

• Search Page

Release: 0.0.5

Last change: Aug 26, 2026