Interface DocumentMarkdownResult

Any supported upload, converted. The same shape whatever the file was.

interface DocumentMarkdownResult {
    agents: Agent[];
    failedPages: number[];
    markdown: string;
    pages: ConvertedDocumentPage[];
    totalCost: number;
    type: "pdf" | "docx" | "xlsx" | "text";
    warnings: string[];
}

Properties

agents: Agent[]

The conversion agents, for a caller that reads costs off them. Empty for anything but a PDF.

failedPages: number[]

PDF pages that could not be read. Always empty for other types.

markdown: string

The pages assembled with  markers.

totalCost: number

What the conversion cost. Zero for anything but a PDF.

type: "pdf" | "docx" | "xlsx" | "text"

warnings: string[]

What a reader should know was changed or left out.