Skip to main content

DocumentInput

Struct DocumentInput 

Source
pub struct DocumentInput {
    pub file: DocumentHandle,
    pub pages: Option<Pages>,
    pub deliver_as: Option<Delivery>,
}
Expand description

A stored file handed to an AI operation, together with what should be done with it.

A PDF travels to the model as a PDF, because the model reads one: its tables, its layout and its figures survive the trip, and none of them survive being turned into text. Asking for text is therefore opt-in.

let contract = DocumentInput {
    file: DocumentHandle {
        file_hash: "9f2c…".into(),
        filename: "contract.pdf".into(),
        mime_type: "application/pdf".into(),
        size: 1_048_576,
        storage_path: "acme/documents/9f/2c/9f2c….pdf".into(),
    },
    pages: Some(Pages::new(1, 3)),
    deliver_as: Some(Delivery::Text),
};

let read: Execution<String> =
    ai::summarize(json!(contract), "Say what it commits us to.", Options::default())?;

The pages and the delivery are two questions, asked in that order. The pages say WHICH DOCUMENT the call is about: they are taken out of the PDF first, and everything after that is about them and nothing else. The delivery then says how that document should reach the model.

Refused by the engine, before the file is read or anything is spent:

  • pages on anything that is not a PDF;
  • a range that runs past the end of the document, or one whose last page precedes its first;
  • Delivery::Text on an image, which is not read as text;
  • Delivery::Document on a Word, Excel, PowerPoint, CSV, RTF or text file, which only ever travels as text.

A page the platform cannot read as text sends the pages asked for as a PDF instead, so an answer is never built on text with a hole in it.

Pages asked for as text arrive numbered from 1, because by then they are a document of their own. A line above them says which pages of which document they were, rather than the numbers being rewritten inside the text: a page number printed in a header or a cross-reference cannot be told apart from a page label, so editing them would corrupt the document’s own words.

Fields§

§file: DocumentHandle

The stored file, as the upload or the record that holds it answered with.

§pages: Option<Pages>

Which pages of the PDF to send. Unset sends the whole document.

§deliver_as: Option<Delivery>

How the document reaches the model. Unset sends it the way its type is sent by default.

Trait Implementations§

Source§

impl Clone for DocumentInput

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 DocumentInput

Source§

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

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

impl Default for DocumentInput

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for DocumentInput

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for DocumentInput

Source§

impl PartialEq for DocumentInput

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 Serialize for DocumentInput

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for DocumentInput

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.