Nuggets¶
A judge's create_nuggets() returns NuggetBanks — per-topic containers of questions and claims. NuggetDocEntry/TopicNuggetDocs carry the document-grounded variant.
NuggetBanks¶
autojudge_base.nugget_data.NuggetBanks
pydantic-model
¶
Bases: BaseModel
Container for multiple NuggetBanks, keyed by query_id.
Access banks directly via the banks field:
banks.banks["topic-1"]
banks.banks.get("topic-1")
for qid, bank in banks.banks.items(): ...
Fields:
-
format_version(str) -
banks(Dict[str, NuggetBank])
get_bank_model
classmethod
¶
get_bank_model() -> Type[NuggetBank]
Return the bank model class for this container type.
Source code in src/autojudge_base/nugget_data/nugget_banks.py
29 30 31 32 | |
from_banks_list
classmethod
¶
from_banks_list(banks: List[NuggetBank], overwrite: bool = False) -> NuggetBanks
Create from list of banks.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
banks
|
List[NuggetBank]
|
List of NuggetBank instances |
required |
overwrite
|
bool
|
If False (default), raise error on duplicate query_id |
False
|
Raises:
| Type | Description |
|---|---|
ValueError
|
If bank has no query_id, or duplicate query_id without overwrite |
Source code in src/autojudge_base/nugget_data/nugget_banks.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 | |
verify ¶
Verify nugget banks against expected topic IDs.
Source code in src/autojudge_base/nugget_data/nugget_banks.py
58 59 60 61 | |
autojudge_base.nugget_data.NuggetBanksProtocol ¶
Bases: Protocol
Protocol for multi-topic nugget bank containers.
Implementations: NuggetBanks, NuggetizerNuggetBanks
get_bank_model
classmethod
¶
get_bank_model() -> Type[NuggetBankProtocol]
Return the bank model class for this container type (required for generic I/O).
Source code in src/autojudge_base/nugget_data/protocols.py
28 29 30 31 | |
from_banks_list
classmethod
¶
from_banks_list(banks: List[NuggetBankProtocol], overwrite: bool = False) -> NuggetBanksProtocol
Create container from list of banks.
Source code in src/autojudge_base/nugget_data/protocols.py
33 34 35 36 37 38 | |
verify ¶
Verify nugget banks against expected topic IDs.
Source code in src/autojudge_base/nugget_data/protocols.py
40 41 42 | |
Nugget documents¶
autojudge_base.nugget_doc_models.NuggetDocEntry
pydantic-model
¶
Bases: BaseModel
A nugget question with its relevant document IDs.
Fields:
-
question(str) -
doc_ids(List[str]) -
aggregator(str) -
answer_type(str)
to_collaborator_value ¶
to_collaborator_value() -> list
Serialize to collaborator format: ["OR", {"OPEN_ENDED_ANSWER": [...]}]
Source code in src/autojudge_base/nugget_doc_models.py
24 25 26 | |
autojudge_base.nugget_doc_models.TopicNuggetDocs
pydantic-model
¶
Bases: BaseModel
All nugget-document mappings for a single topic.
Fields:
-
topic_id(str) -
entries(List[NuggetDocEntry])
to_collaborator_dict ¶
to_collaborator_dict() -> dict
Serialize to collaborator format: {question: ["OR", {...}], ...}
Source code in src/autojudge_base/nugget_doc_models.py
35 36 37 | |
autojudge_base.nugget_doc_models.write_nugget_docs_collaborator ¶
write_nugget_docs_collaborator(topics: Dict[str, TopicNuggetDocs], output_dir: Path) -> None
Write one nuggets_{topic_id}.json per topic in collaborator format.
Source code in src/autojudge_base/nugget_doc_models.py
40 41 42 43 44 45 46 47 48 49 | |