pdf_survey.json
The contents of pdf_survey.json: the checked survey of one PDF.
pdf_survey.json
Section titled “pdf_survey.json”The contents of pdf_survey.json: the checked survey of one PDF.
checks(list of objects (checks[]); required): The result of each check, C1 to C7 in order.facts(object (facts); required): A copy of the measured facts the survey used.fingerprint(string; required):sha256:fingerprint of what the survey depends on; a matching file is reused.inputs(object (inputs); required): What the survey was made from.issues(list of objects (issues[]); required): One review issue per failure on the accepted answer.profile(object (profile); required): How the PDF’s pages are laid out, for later steps.proposal(object (proposal); required): The rest of the model’s answer.schema_version(string; required): The version of this file’s schema,"MAJOR.MINOR".
checks[]
Section titled “checks[]”The result of one check on the accepted answer.
attempts(integer; required): How many model answers were checked: 1 plus the retries used.failures(list of objects (checks[].failures[]); required): The problems the check found in the accepted answer.name(one oflabels,regions,rotation,page_numbering,artifacts,writing_direction,languages; required): The check.passed(boolean; required): Whether the accepted answer passed:failuresis empty.
Everything the probe measured.
bookmarks(list of objects (facts.bookmarks[]) or null; required): The bookmarks (outline).form(object (facts.form) or null; required): Which kinds of form the PDF holds.form_fields(list of objects (facts.form_fields[]) or null; required): The interactive form fields.page_numbering(list of objects (facts.page_numbering[]); required): Ranges of pages whose printed numbers follow their indexes.pages(list of objects (facts.pages[]); required): What was measured on each page.probe_errors(list of objects (facts.probe_errors[]); required): The facts that could not be read.repeated_lines(list of objects (facts.repeated_lines[]); required): Lines that repeat across pages, most frequent first.repeated_lines_truncated(boolean; required): Whether more repeated lines were found than are kept.structure(object (facts.structure) or null; required): What the structure tags cover.
inputs
Section titled “inputs”What a survey was made from.
facts_fingerprint(string; required): The fingerprint of thepdf_facts.jsonthe survey used.instructions(string or null; required): The user’s instructions, if any.languages(list of strings; required): The user’s languages, in standard form.model(string; required): The model, as<provider>:<model-id>.page_count(integer; required): The PDF’s number of pages.pdf_bytes(integer; required): The PDF’s size in bytes.pdf_name(string; required): The PDF’s file name.pdf_sha256(string; required): The PDF’s SHA-256 hex digest.prompt_version(integer; required): The version of the survey prompt.settings(object (inputs.settings); required): The survey settings used.
issues[]
Section titled “issues[]”A problem a person should review.
check(one oflabels,regions,rotation,page_numbering,artifacts,writing_direction,languagesor one ofrotation_differs,page_number_differs; required): The check or comparison that found the problem.details(map of string to any value; required): The values the problem is about, such as{"measured": 90, "profile": 0}.message(string; required): What is wrong.page_index(integer or null; required): The page the problem is on, orNonewhen no single page applies.step(one ofsurvey; required): The step whose check found the problem.
profile
Section titled “profile”What later steps depend on: how the PDF’s pages are laid out.
continuation_notes(list of strings; required): How content continues from one page to the next.labels(list of objects (profile.labels[]); required): The labels for this PDF’s content; always includesother.languages(list of strings; required): BCP-47 tags in standard form: the user’s languages, then the model’s.page_numbering(list of objects (profile.page_numbering[]); required): How printed page numbers relate to page indexes, by range of pages.rotation(list of objects (profile.rotation[]); required): The rotation that makes each range of pages upright; other pages need none.start_markers(list of objects (profile.start_markers[]); required): Text that marks where a new unit of content starts.user_instructions(string or null; required): The user’s instructions for this PDF, if any.writing_direction(object (profile.writing_direction); required): The writing direction of the pages.
proposal
Section titled “proposal”The model’s answer that is not part of the profile.
artifacts(list of objects (proposal.artifacts[]); required): Page furniture, with the repeated lines it accounts for.non_artifact_lines(list of objects (proposal.non_artifact_lines[]); required): Repeated lines that are content rather than page furniture.notes(list of strings; required): Anything else the model noticed about the layout.regions(list of objects (proposal.regions[]); required): Areas of single pages the model labeled.
checks[].failures[]
Section titled “checks[].failures[]”One problem a check found in the model’s answer.
details(map of string to any value; required): The proposed value and, where it applies, what it was checked against, such as{"proposed": 9, "page_count": 6}.message(string; required): What is wrong, starting with the check’s name.page_index(integer or null; required): The page the problem is on, orNonewhen no single page applies.
facts.bookmarks[]
Section titled “facts.bookmarks[]”One entry of the PDF’s bookmarks (outline).
level(integer; required): Nesting level, 1 for top-level bookmarks.page_index(integer or null; required): The page the bookmark points to, orNonewhen it points nowhere.title(string; required): The bookmark’s title.
facts.form
Section titled “facts.form”Which kinds of form the PDF holds.
has_acroform(boolean; required): Whether the PDF has an AcroForm (interactive form) dictionary.has_xfa(boolean; required): Whether the form also carries an XFA form.
facts.form_fields[]
Section titled “facts.form_fields[]”One interactive form field.
bbox(list of 4 numbers; required): The field’s box on the displayed page.checked(boolean or null; required): Whether a checkbox or radio button is on;Nonefor other fields.name(string; required): The field’s fully qualified name.options(list of strings; required): The choices of a combobox or listbox; empty for other fields.page_index(integer; required): The page the field is on.type(one oftext,checkbox,radio,combobox,listbox,signature,button; required): The field’s type.value(string or null; required): The field’s current value, if it has one.
facts.page_numbering[]
Section titled “facts.page_numbering[]”Consecutive measured pages whose printed numbers follow their page indexes.
first_page_index(integer; required): The first page of the range.last_page_index(integer; required): The last page of the range, inclusive.offset(integer; required): The printed number minus the page index, the same on every page measured.pages_measured(integer; required): How many pages in the range have a printed number.style(one ofarabic,roman; required): How the numbers are written.
facts.pages[]
Section titled “facts.pages[]”What the probe measured on one page.
direction(object (facts.pages[].direction); required): The writing direction.height_pt(number; required): The displayed page’s height in points.index(integer; required): The page’s index.orientation(object (facts.pages[].orientation); required): Which way the text runs.printed_number(object (facts.pages[].printed_number) or null; required): The page number printed on the page, if one was found.rotation_attribute(integer; required): The page’s rotation attribute in degrees, clockwise.text(object (facts.pages[].text); required): The text layer.width_pt(number; required): The displayed page’s width in points.
facts.probe_errors[]
Section titled “facts.probe_errors[]”A fact the probe could not read, because reading it failed.
fact(one ofbookmarks,form,structure; required): Which fact could not be read.message(string; required): What went wrong.
facts.repeated_lines[]
Section titled “facts.repeated_lines[]”A line that repeats across pages, such as a running header or footer.
band(one oftop,bottom,middle; required): Where the line usually sits on its pages.id(string; required): The line’s identifier,R1,R2and so on, most frequent first.normalized(string; required): The form lines are compared in: Unicode NFKC, case-folded, whitespace collapsed, each run of digits written as#.pages(list of integers; required): The pages the line appears on.text(string; required): The line as printed where it first appears.
facts.structure
Section titled “facts.structure”What the PDF’s structure tags (the tagged-PDF tree) cover.
element_count(integer; required): How many structure elements the tree has (up to the probe’s cap).marked(boolean; required): Whether the PDF declares itself a tagged PDF.pages_with_tagged_content(integer; required): How many pages have content linked to the tree.quality(one ofnone,poor,partial,good; required):nonewithout a tree;poorwith only grouping elements or very few;partialwhen tagged content covers too few of the pages with text;goodotherwise.tagged(boolean; required): Whether the PDF has a structure tree.truncated(boolean; required): Whether the probe stopped counting at its element cap.type_counts(map of string to integer; required): Elements by standard type, after the tree’s role map is applied.
inputs.settings
Section titled “inputs.settings”The survey settings a survey’s result depends on.
check_retries(integer; required): How many times the model could answer again after failing the checks.effort(one oflow,medium,high; required): How hard the model thought before answering.max_output_tokens(integer; required): The most tokens one model answer could contain, thinking included.
profile.labels[]
Section titled “profile.labels[]”A name for one kind of content in this PDF, with its role and allowed kinds.
description(string; required): What content gets this label.kinds(list of one ofcode,field,figure,formula,list,table,text; required): The kinds of item this label may be given to; at least one.name(string; required): The label’s name, unique in the PDF regardless of case.role(one ofartifact,aside,body,caption,footnote,heading,navigation; required): The role content with this label plays.
profile.page_numbering[]
Section titled “profile.page_numbering[]”Consecutive pages whose printed numbers follow one style and offset.
first_page_index(integer; required): The first page of the range (0-based).last_page_index(integer; required): The last page of the range, inclusive.offset(integer or null; required): The printed number minus the page index, orNonewhen the pages print no numbers that follow the page index.style(one ofarabic,roman,other,none; required): How the numbers are written.
profile.rotation[]
Section titled “profile.rotation[]”Consecutive pages whose content needs the same rotation to be upright.
degrees(one of0,90,180,270; required): The clockwise rotation that makes the displayed page’s content upright.first_page_index(integer; required): The first page of the range (0-based).last_page_index(integer; required): The last page of the range, inclusive.
profile.start_markers[]
Section titled “profile.start_markers[]”Text that marks where a new unit of content starts.
description(string; required): What starts where the text appears.text(string; required): The text, as printed.
profile.writing_direction
Section titled “profile.writing_direction”The writing direction of the PDF’s pages.
default(one ofltr,rtl,ttb; required): The direction of every page no range covers.ranges(list of objects (profile.writing_direction.ranges[]); required): Ranges of pages whose direction differs fromdefault.
proposal.artifacts[]
Section titled “proposal.artifacts[]”Page furniture the model identified, such as a running header or a stamp.
description(string; required): What the artifact is, in a few words.id(string; required): The artifact’s identifier, such asA1.position(one oftop,bottom,left,right,middle; required): Where the artifact sits on the displayed page.repeated_line_ids(list of strings; required): The IDs of the measured repeated lines (R1,R2and so on) that are this artifact; empty when no repeated line is.
proposal.non_artifact_lines[]
Section titled “proposal.non_artifact_lines[]”A measured repeated line that is not page furniture.
reason(string; required): Why the line is content rather than page furniture.repeated_line_id(string; required): The repeated line’s ID, such asR3.
proposal.regions[]
Section titled “proposal.regions[]”An area of one page the model labeled, with its box in points.
bbox(list of 4 numbers; required): The area on the displayed page, as[x0, y0, x1, y1]in points.label(string; required): The label of the area’s content.note(string; required): Why the area is worth marking; may be empty.page_index(integer; required): The page (0-based).
facts.pages[].direction
Section titled “facts.pages[].direction”The writing direction measured on a page.
inline(one ofltr,rtl,mixed,none; required):rtlorltrwhen right-to-left or left-to-right letters reach the dominant share of the page’s letters,mixedwhen neither does,nonewithout letters.vertical_share(number; required): The share of the page’s characters on lines in vertical writing mode.
facts.pages[].orientation
Section titled “facts.pages[].orientation”Which way the text runs on the displayed page.
chars_by_angle(map of string to integer; required): Characters on horizontal-mode lines, by baseline angle ("0","90","180","270", counterclockwise on the displayed page).confident(boolean; required): Whether there are enough characters and the dominant angle has a large enough share for the measurement to be relied on.dominant(one of0,90,180,270or null; required): The angle most characters run at, orNonewithout horizontal text.
facts.pages[].printed_number
Section titled “facts.pages[].printed_number”The page number printed on a page, or its page label.
source(one ofpage_label,text; required):page_labelfrom the PDF’s page labels, ortextfrom a line near the top or bottom of the page.style(one ofarabic,roman,label; required):arabicorromannumerals, orlabelfor any other page label.text(string; required): The number or label as printed.value(integer or null; required): The number’s value, orNonefor a label that is not a number.
facts.pages[].text
Section titled “facts.pages[].text”How much text a page’s text layer holds, and whether it is readable.
chars(integer; required): Characters other than whitespace.control_chars(integer; required): Control characters among them.private_use_chars(integer; required): Private-use characters among them.quality(one ofnone,good,garbled; required):nonewithout characters;garbledwhen control, private-use, unassigned and replacement characters reach the garbled share;goodotherwise.replacement_chars(integer; required): Replacement characters (U+FFFD) among them, for glyphs with no known character.unassigned_chars(integer; required): Characters Unicode does not assign, among them.
profile.writing_direction.ranges[]
Section titled “profile.writing_direction.ranges[]”Consecutive pages written in one direction.
direction(one ofltr,rtl,ttb; required): The writing direction on these pages.first_page_index(integer; required): The first page of the range (0-based).last_page_index(integer; required): The last page of the range, inclusive.