Skip to main content
Version: 0.0.6 (stable)

agrag.common.data_models.evidence.FetchOutcome

Bases: BaseModel

The result of fetching one evidence id.

Attributes:

  • evidence_id (str) – The id that was requested, as given.
  • status (FetchStatus) – The outcome of the fetch.
  • text (str | None) – The returned text, or None when no text is returned.
  • reference (EvidenceReference | None) – The decoded reference, or None for a malformed id.
  • document_key (str | None) – The key of the document, when the document is readable.
  • title (str | None) – Stored document title, when readable.
  • uri (str | None) – Valid HTTP(S) source URL, when available.
  • location (EvidenceLocation | None) – Passage location, including page provenance when available.
  • content_hash (str | None) – The full content hash of the version the text came from.
  • status_of_version (VersionStatus | None) – Whether that version is current, when text is returned.
  • observed_activation_seq (int | None) – The document activation sequence observed in the same read as the text, including for a superseded version.
  • covered_range (tuple[int, int] | None) – The offsets of the returned text, when it is a text range. A partial range gives the covered part only.
  • partial (bool) – True when the requested range was not fully covered by chunks.
  • detail (str | None) – A short message for a malformed or failed id. It is None for an unavailable id, because the reason stays on the server side.
  • citation_markdown (str | None) – Escaped source reference for a complete fetch, or None. Absolute HTTP(S) source URIs become links; other sources display as text.

citation_markdown​

citation_markdown: str | None

Return a readable source reference only for complete fetched evidence.

content_hash​

content_hash: str | None = None

covered_range​

covered_range: tuple[int, int] | None = None

detail​

detail: str | None = None

document_key​

document_key: str | None = None

evidence_id​

evidence_id: str

location​

location: EvidenceLocation | None = None

observed_activation_seq​

observed_activation_seq: int | None = None

partial​

partial: bool = False

reference​

reference: EvidenceReference | None = None

status​

status: FetchStatus

status_of_version​

status_of_version: VersionStatus | None = None

text​

text: str | None = None

title​

title: str | None = None

uri​

uri: str | None = None