Skip to main content

ConfidenceReport

Struct ConfidenceReport 

Source
pub struct ConfidenceReport {
    pub pages: BTreeMap<usize, PageConfidence>,
}
Expand description

The document-level report (docling’s ConfidenceReport): the four scores aggregated across pages, plus the per-page breakdown. Page keys are the real 1-based page numbers — the same numbering as the JSON export’s pages map (#171), --pages windows included. (docling keys by its 0-based internal page index; ours is the more useful spelling and the difference is documented in docs/MIGRATION.md.)

Fields§

§pages: BTreeMap<usize, PageConfidence>

Implementations§

Source§

impl ConfidenceReport

Source

pub fn from_pages(pages: BTreeMap<usize, PageConfidence>) -> Self

Build from per-page scores keyed by 1-based page number.

Source

pub fn layout_score(&self) -> Option<f64>

Document layout_score: mean of the per-page values.

Source

pub fn parse_score(&self) -> Option<f64>

Document parse_score: 10th percentile of the per-page values (docling: quantile here too, to emphasise problem pages).

Source

pub fn table_score(&self) -> Option<f64>

Document table_score: mean of the per-page values.

Source

pub fn ocr_score(&self) -> Option<f64>

Document ocr_score: mean of the per-page values.

Source

pub fn mean_score(&self) -> Option<f64>

Document mean_score: mean of the per-page mean scores.

Source

pub fn low_score(&self) -> Option<f64>

Document low_score: mean (sic — docling’s override uses nanmean, not a quantile) of the per-page low scores.

Source

pub fn mean_grade(&self) -> QualityGrade

Source

pub fn low_grade(&self) -> QualityGrade

Source

pub fn to_json(&self) -> Value

The full report as JSON — docling’s ConfidenceReport dump shape (unset scores as null, grades as lowercase strings, pages keyed by stringified page number).

Source

pub fn summary_json(&self) -> Value

The document-level scores/grades only (no pages) — compact enough for a response header.

Trait Implementations§

Source§

impl Clone for ConfidenceReport

Source§

fn clone(&self) -> ConfidenceReport

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ConfidenceReport

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ConfidenceReport

Source§

fn default() -> ConfidenceReport

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ConfidenceReport

Source§

fn eq(&self, other: &ConfidenceReport) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ConfidenceReport

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.