Welcome to ir’s documentation!

Contents:

ir
- Artifact
- Chunked
- Corpus
- CorpusGraph
- CorpusSource
- CorpusStore
- Disclosure
- DiscoveryResult
- GraphStore
- IndexPlan
- IndexingStrategy
- Package
- Passage
- Record
- SearchHit
- Selection
- Skill
- Surface
- WalkPolicy
- WalkState
- WholeText
- as_retriever()
- build()
- build_corpus()
- canonical_node_id()
- collapsed_tree_policy()
- corpora()
- default_edge_extractor()
- disclose()
- discover()
- expand()
- fuse_hits()
- make_llm_formulator()
- make_llm_synthesizer()
- open_corpus()
- parent_policy()
- records_for_artifact()
- register()
- retriever_for()
- retrievers()
- search()
- select()
- sentence_window_policy()
- tag_source()
- traverse()
- with_synopsis()
ir.__main__
- main()
ir.base
- Artifact
- FilterFields
- IndexPlan
- POINTER_KEYS
- Record
- SearchHit
- Surface
- best_per_artifact()
- ledger_key()
- storage_key()
- tag_source()
ir.cli
- build()
- calibrate_min_score()
- discover()
- eval()
- eval_gen()
- eval_select()
- info()
- ls()
- register()
- rm()
- search()
- sweep_select()
ir.config
- cache_dir()
- config_dir()
- corpus_dir()
- data_dir()
- embeddings_cache_dir()
- registry_path()
- safe_name()
ir.embed
- make_embedder()
ir.eval
- Design stance (retrieval-centric, reuse ef)
- DFLT_CALIB_SENSITIVITY_WEIGHT
- DFLT_CURVE_MODE
- DFLT_DISTRACTOR_SIZES
- DFLT_K_VALUES
- DFLT_METRICS
- DFLT_MODE
- DFLT_SWEEP_MAX_K
- DFLT_SWEEP_MIN_SCORE
- DFLT_SWEEP_OBJECTIVE
- DFLT_SWEEP_REL
- DiscoveryCase
- DiscoveryReport
- MinScoreCalibration
- SWEEP_METRICS
- SelectionGridPoint
- SelectionReport
- SelectionSweep
- as_doc_retriever()
- calibrate_min_score()
- corpus_artifact_ids()
- distractor_curve_from_cases()
- distractor_robustness_curve()
- evaluate_discovery()
- evaluate_selection()
- load_calibration()
- load_cases()
- retrieval_report()
- save_cases()
- sweep_selector()
- to_qrels()
- validate_cases()
ir.eval_gen
- AbstentionGenerator
- DFLT_ABSTENTION_FRAC
- DFLT_ABSTENTION_THEME
- DFLT_MIN_DESCRIPTION_CHARS
- DFLT_QUERIES_PER_ARTIFACT
- NAME_PLACEHOLDER
- QueryGenerator
- build_eval_set()
- corpus_signature()
- generate_abstention_cases()
- generate_cases()
- make_oa_abstention_generator()
- make_oa_query_generator()
- mask_name()
ir.expand
- DFLT_MIN_STITCH_OVERLAP
- DFLT_WINDOW
- NeighborhoodPolicy
- Passage
- SeedNotFound
- expand()
- parent_policy()
- sentence_window_policy()
ir.formulate
- FORMULATION_PROMPT
- Formulator
- identity_formulator()
- make_llm_formulator()
ir.graph
- CHILD
- CorpusGraph
- EdgeExtractor
- GraphStore
- NEXT
- NodeId
- PARENT
- PREV
- REF
- canonical_node_id()
- default_edge_extractor()
ir.index
- Corpus
- build()
- open_corpus()
ir.registry
- get()
- register()
- registered()
- retriever_for()
- retrievers()
- source_for()
- source_from_entry()
- unregister()
ir.retrieve
- DFLT_BLEND_ALPHA
- DFLT_BM25_SAT_K
- DFLT_RRF_K
- FUSIONS
- Identity
- MODES
- NoLedgerEntry
- Retriever
- as_retriever()
- fuse_hits()
- records_for_artifact()
- search()
ir.select
- BodyLoader
- DFLT_FETCH_K
- DFLT_GAP_RATIO
- DFLT_MAX_BODY_CHARS
- DFLT_MAX_K
- DFLT_REL_THRESHOLD
- DISCLOSURE_LEVELS
- Disclosure
- DiscoveryResult
- ResourceStore
- Selection
- Selector
- abs_threshold()
- disclose()
- discover()
- make_llm_selector()
- rel_threshold()
- score_gap()
- select()
- top_k()
ir.sources
- CorpusSource
- content_hash_signal()
ir.store
- CorpusStore
ir.strategy
- Chunked
- IndexingStrategy
- Package
- Skill
- WholeText
- text_of()
ir.synopsis
- SYNOPSIS_KIND
- SYNOPSIS_PROMPT
- Synthesizer
- make_llm_synthesizer()
- with_synopsis()
ir.traverse
- DFLT_LEAF_KINDS
- DFLT_MAX_DEPTH
- DFLT_SEED_K
- DFLT_SUMMARY_KINDS
- WalkPolicy
- WalkState
- collapsed_tree_policy()
- traverse()

Indices and tables

Release: 0.1.21

Last change: Jun 13, 2026