Skip to main content

FileDelivery

Struct FileDelivery 

Source
pub struct FileDelivery {
    pub filename: String,
    pub delivered_as: DeliveredAs,
    pub pages: Option<Pages>,
    pub transcribed_pages: Vec<u32>,
    pub fallback: Option<DeliveryFallback>,
}
Expand description

How one file an operation carried reached the model.

A file asked for as text is not always sent as text. A page with no text of its own is read from its image, and when that reading fails the document is sent instead, so the answer is never built on text with a hole in it. This is how a caller finds out which happened, without reading a platform log.

Page numbers are the original document’s, whatever range was cut from it, so a page named here is the page a person would turn to.

let read = simple::ai::summarize(
    json!({
        "file_hash": "9f2c…",
        "filename": "contract.pdf",
        "mime_type": "application/pdf",
        "first_page": 40,
        "last_page": 52,
        "deliver_as": "text"
    }),
    "Say what it commits us to.",
    Options::default(),
)?;

for file in &read.metadata.delivery {
    if let Some(fallback) = &file.fallback {
        println!("{} was read as a PDF: {}", file.filename, fallback.message);
    }
}

let contract = &read.metadata.delivery[0];

assert_eq!(contract.delivered_as, DeliveredAs::Document);
assert_eq!(contract.pages, Some(Pages::new(40, 52)));

Fields§

§filename: String

The file’s name.

§delivered_as: DeliveredAs

How the file travelled.

§pages: Option<Pages>

The range the file was cut to, when one was asked for. Unset when the whole file travelled.

§transcribed_pages: Vec<u32>

The pages whose text was read from their images rather than from their text layer. Empty when none were.

§fallback: Option<DeliveryFallback>

Set only when text was asked for and the document travelled instead: which pages could not be read, and why.

Trait Implementations§

Source§

impl Clone for FileDelivery

Source§

fn clone(&self) -> Self

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 FileDelivery

Source§

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

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

impl Eq for FileDelivery

Source§

impl PartialEq for FileDelivery

Source§

fn eq(&self, other: &Self) -> 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 FileDelivery

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.