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:
pageson 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::Texton an image, which is not read as text;Delivery::Documenton 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: DocumentHandleThe 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.