6000c654ce
- Fixed missing fields in BlockJson, SpanJson, ExtractionOptions initializations - Added feature gates to ocr_integration tests for conditional compilation - Fixed McpServerState::new calls to include audit writer argument - Fixed CCITTFaxDecoder::decode calls to use instance method - Fixed type casts for ObjRef::new calls - Fixed serde_json::Value method calls (is_some -> !is_null) - Fixed ProfileType test feature gates - Worked around lifetime issues in schema roundtrip tests These changes fix numerous compilation errors that were blocking the codebase from building. The main library and tests now compile successfully. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
648 lines
46 KiB
HTML
648 lines
46 KiB
HTML
<!DOCTYPE HTML>
|
||
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
<head>
|
||
<!-- Book generated using mdBook -->
|
||
<meta charset="UTF-8">
|
||
<title>JSON Schema Reference - pdftract User Documentation</title>
|
||
|
||
|
||
<!-- Custom HTML head -->
|
||
|
||
<meta name="description" content="">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<meta name="theme-color" content="#ffffff">
|
||
|
||
<link rel="icon" href="favicon-de23e50b.svg">
|
||
<link rel="shortcut icon" href="favicon-8114d1fc.png">
|
||
<link rel="stylesheet" href="css/variables-8adf115d.css">
|
||
<link rel="stylesheet" href="css/general-2459343d.css">
|
||
<link rel="stylesheet" href="css/chrome-ae938929.css">
|
||
<link rel="stylesheet" href="css/print-9e4910d8.css" media="print">
|
||
|
||
<!-- Fonts -->
|
||
<link rel="stylesheet" href="fonts/fonts-9644e21d.css">
|
||
|
||
<!-- Highlight.js Stylesheets -->
|
||
<link rel="stylesheet" id="mdbook-highlight-css" href="highlight-493f70e1.css">
|
||
<link rel="stylesheet" id="mdbook-tomorrow-night-css" href="tomorrow-night-4c0ae647.css">
|
||
<link rel="stylesheet" id="mdbook-ayu-highlight-css" href="ayu-highlight-3fdfc3ac.css">
|
||
|
||
<!-- Custom theme stylesheets -->
|
||
|
||
|
||
<!-- Provide site root and default themes to javascript -->
|
||
<script>
|
||
const path_to_root = "";
|
||
const default_light_theme = "light";
|
||
const default_dark_theme = "navy";
|
||
window.path_to_searchindex_js = "searchindex-fc6d8bf8.js";
|
||
</script>
|
||
<!-- Start loading toc.js asap -->
|
||
<script src="toc-d0f907c9.js"></script>
|
||
</head>
|
||
<body>
|
||
<div id="mdbook-help-container">
|
||
<div id="mdbook-help-popup">
|
||
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
||
<div>
|
||
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
||
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
||
<p>Press <kbd>?</kbd> to show this help</p>
|
||
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="mdbook-body-container">
|
||
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
<script>
|
||
try {
|
||
let theme = localStorage.getItem('mdbook-theme');
|
||
let sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
||
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
}
|
||
|
||
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
}
|
||
} catch (e) { }
|
||
</script>
|
||
|
||
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
<script>
|
||
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
||
let theme;
|
||
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
const html = document.documentElement;
|
||
html.classList.remove('light')
|
||
html.classList.add(theme);
|
||
html.classList.add("js");
|
||
</script>
|
||
|
||
<input type="checkbox" id="mdbook-sidebar-toggle-anchor" class="hidden">
|
||
|
||
<!-- Hide / unhide sidebar before it is displayed -->
|
||
<script>
|
||
let sidebar = null;
|
||
const sidebar_toggle = document.getElementById("mdbook-sidebar-toggle-anchor");
|
||
if (document.body.clientWidth >= 1080) {
|
||
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
sidebar = sidebar || 'visible';
|
||
} else {
|
||
sidebar = 'hidden';
|
||
sidebar_toggle.checked = false;
|
||
}
|
||
if (sidebar === 'visible') {
|
||
sidebar_toggle.checked = true;
|
||
} else {
|
||
html.classList.remove('sidebar-visible');
|
||
}
|
||
</script>
|
||
|
||
<nav id="mdbook-sidebar" class="sidebar" aria-label="Table of contents">
|
||
<!-- populated by js -->
|
||
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
||
<noscript>
|
||
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
|
||
</noscript>
|
||
<div id="mdbook-sidebar-resize-handle" class="sidebar-resize-handle">
|
||
<div class="sidebar-resize-indicator"></div>
|
||
</div>
|
||
</nav>
|
||
|
||
<div id="mdbook-page-wrapper" class="page-wrapper">
|
||
|
||
<div class="page">
|
||
<div id="mdbook-menu-bar-hover-placeholder"></div>
|
||
<div id="mdbook-menu-bar" class="menu-bar sticky">
|
||
<div class="left-buttons">
|
||
<label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"/></svg></span>
|
||
</label>
|
||
<button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M371.3 367.1c27.3-3.9 51.9-19.4 67.2-42.9L600.2 74.1c12.6-19.5 9.4-45.3-7.6-61.2S549.7-4.4 531.1 9.6L294.4 187.2c-24 18-38.2 46.1-38.4 76.1L371.3 367.1zm-19.6 25.4l-116-104.4C175.9 290.3 128 339.6 128 400c0 3.9 .2 7.8 .6 11.6c1.8 17.5-10.2 36.4-27.8 36.4H96c-17.7 0-32 14.3-32 32s14.3 32 32 32H240c61.9 0 112-50.1 112-112c0-2.5-.1-5-.2-7.5z"/></svg></span>
|
||
</button>
|
||
<ul id="mdbook-theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-default_theme">Auto</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-light">Light</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-rust">Rust</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-coal">Coal</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-navy">Navy</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-ayu">Ayu</button></li>
|
||
</ul>
|
||
<button id="mdbook-search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="mdbook-searchbar">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M416 208c0 45.9-14.9 88.3-40 122.7L502.6 457.4c12.5 12.5 12.5 32.8 0 45.3s-32.8 12.5-45.3 0L330.7 376c-34.4 25.2-76.8 40-122.7 40C93.1 416 0 322.9 0 208S93.1 0 208 0S416 93.1 416 208zM208 352c79.5 0 144-64.5 144-144s-64.5-144-144-144S64 128.5 64 208s64.5 144 144 144z"/></svg></span>
|
||
</button>
|
||
</div>
|
||
|
||
<h1 class="menu-title">pdftract User Documentation</h1>
|
||
|
||
<div class="right-buttons">
|
||
<a href="print.html" title="Print this book" aria-label="Print this book">
|
||
<span class=fa-svg id="print-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M128 0C92.7 0 64 28.7 64 64v96h64V64H354.7L384 93.3V160h64V93.3c0-17-6.7-33.3-18.7-45.3L400 18.7C388 6.7 371.7 0 354.7 0H128zM384 352v32 64H128V384 368 352H384zm64 32h32c17.7 0 32-14.3 32-32V256c0-35.3-28.7-64-64-64H64c-35.3 0-64 28.7-64 64v96c0 17.7 14.3 32 32 32H64v64c0 35.3 28.7 64 64 64H384c35.3 0 64-28.7 64-64V384zm-16-88c-13.3 0-24-10.7-24-24s10.7-24 24-24s24 10.7 24 24s-10.7 24-24 24z"/></svg></span>
|
||
</a>
|
||
<a href="https://github.com/jedarden/pdftract" title="Git repository" aria-label="Git repository">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg></span>
|
||
</a>
|
||
<a href="https://github.com/jedarden/pdftract/edit/main/docs/user-docs/src/src/json-schema-reference.md" title="Suggest an edit" aria-label="Suggest an edit" rel="edit">
|
||
<span class=fa-svg id="git-edit-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M421.7 220.3l-11.3 11.3-22.6 22.6-205 205c-6.6 6.6-14.8 11.5-23.8 14.1L30.8 511c-8.4 2.5-17.5 .2-23.7-6.1S-1.5 489.7 1 481.2L38.7 353.1c2.6-9 7.5-17.2 14.1-23.8l205-205 22.6-22.6 11.3-11.3 33.9 33.9 62.1 62.1 33.9 33.9zM96 353.9l-9.3 9.3c-.9 .9-1.6 2.1-2 3.4l-25.3 86 86-25.3c1.3-.4 2.5-1.1 3.4-2l9.3-9.3H112c-8.8 0-16-7.2-16-16V353.9zM453.3 19.3l39.4 39.4c25 25 25 65.5 0 90.5l-14.5 14.5-22.6 22.6-11.3 11.3-33.9-33.9-62.1-62.1L314.3 67.7l11.3-11.3 22.6-22.6 14.5-14.5c25-25 65.5-25 90.5 0z"/></svg></span>
|
||
</a>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div id="mdbook-search-wrapper" class="hidden">
|
||
<form id="mdbook-searchbar-outer" class="searchbar-outer">
|
||
<div class="search-wrapper">
|
||
<input type="search" id="mdbook-searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="mdbook-searchresults-outer" aria-describedby="searchresults-header">
|
||
<div class="spinner-wrapper">
|
||
<span class=fa-svg id="fa-spin"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M304 48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zm0 416c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM48 304c26.5 0 48-21.5 48-48s-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48zm464-48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM142.9 437c18.7-18.7 18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zm0-294.2c18.7-18.7 18.7-49.1 0-67.9S93.7 56.2 75 75s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zM369.1 437c18.7 18.7 49.1 18.7 67.9 0s18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9z"/></svg></span>
|
||
</div>
|
||
</div>
|
||
</form>
|
||
<div id="mdbook-searchresults-outer" class="searchresults-outer hidden">
|
||
<div id="mdbook-searchresults-header" class="searchresults-header"></div>
|
||
<ul id="mdbook-searchresults">
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
<script>
|
||
document.getElementById('mdbook-sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
document.getElementById('mdbook-sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
Array.from(document.querySelectorAll('#mdbook-sidebar a')).forEach(function(link) {
|
||
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
});
|
||
</script>
|
||
|
||
<div id="mdbook-content" class="content">
|
||
<main>
|
||
<h1 id="json-schema-reference"><a class="header" href="#json-schema-reference">JSON Schema Reference</a></h1>
|
||
<blockquote>
|
||
<p><strong>Schema version:</strong> 1.0<br><strong>Schema URL:</strong> https://pdftract.com/schema/v1.0/pdftract.schema.json<br><strong>Source of truth:</strong> <code>docs/schema/v1.0/pdftract.schema.json</code></p>
|
||
</blockquote>
|
||
<p>This page provides a human-readable rendering of the pdftract output schema. The JSON Schema is the authoritative definition (per <a href="../plan/plan.html">INV-11</a>), validated in CI for all test fixtures.</p>
|
||
<h2 id="top-level-structure"><a class="header" href="#top-level-structure">Top-Level Structure</a></h2>
|
||
<pre><code class="language-json">{
|
||
"fingerprint": "pdftract-v1:a7f3c8d9...",
|
||
"pages": [...],
|
||
"metadata": {...},
|
||
"signatures": [...],
|
||
"form_fields": [...]
|
||
}
|
||
</code></pre>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>fingerprint</code></td><td>string</td><td>Yes</td><td>Phase 1.7 fingerprint of the source PDF. Format: <code>"pdftract-v1:" + hex(SHA-256)</code>. Used for receipt verification.</td></tr>
|
||
<tr><td><code>pages</code></td><td>array</td><td>Yes</td><td>Extracted pages, each containing spans and blocks.</td></tr>
|
||
<tr><td><code>metadata</code></td><td>object</td><td>Yes</td><td>ExtractionMetadata object with page count, diagnostics, receipts mode, etc.</td></tr>
|
||
<tr><td><code>signatures</code></td><td>array</td><td>Yes</td><td>Digital signatures extracted from the document. Empty when no signature fields exist.</td></tr>
|
||
<tr><td><code>form_fields</code></td><td>array</td><td>Yes</td><td>Interactive form fields from AcroForm/XFA. Empty when no form fields exist.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h2 id="document-metadata"><a class="header" href="#document-metadata">Document Metadata</a></h2>
|
||
<p>The <code>metadata</code> object contains extraction-level information:</p>
|
||
<pre><code class="language-json">{
|
||
"page_count": 10,
|
||
"span_count": 842,
|
||
"block_count": 156,
|
||
"error_count": 0,
|
||
"receipts_mode": "off",
|
||
"diagnostics": ["WARN: page 3: low coverage (54%) - possible scanned content"],
|
||
"cache_status": "hit",
|
||
"cache_age_seconds": 1240,
|
||
"reading_order_algorithm": "robust-topo"
|
||
}
|
||
</code></pre>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Field</th><th>Type</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>page_count</code></td><td>integer</td><td>Total number of pages in the document.</td></tr>
|
||
<tr><td><code>span_count</code></td><td>integer</td><td>Number of spans extracted across all pages.</td></tr>
|
||
<tr><td><code>block_count</code></td><td>integer</td><td>Number of blocks extracted across all pages.</td></tr>
|
||
<tr><td><code>error_count</code></td><td>integer</td><td>Number of pages that failed to extract.</td></tr>
|
||
<tr><td><code>receipts_mode</code></td><td>string</td><td>Receipts mode used: <code>"off"</code>, <code>"lite"</code>, or <code>"svg"</code>.</td></tr>
|
||
<tr><td><code>diagnostics</code></td><td>array</td><td>Diagnostic messages emitted during extraction (coverage warnings, etc.).</td></tr>
|
||
<tr><td><code>cache_status</code></td><td>string/null</td><td>Cache status: <code>"hit"</code>, <code>"miss"</code>, or <code>"skipped"</code>.</td></tr>
|
||
<tr><td><code>cache_age_seconds</code></td><td>integer/null</td><td>Cache entry age in seconds (only present when <code>cache_status == "hit"</code>).</td></tr>
|
||
<tr><td><code>reading_order_algorithm</code></td><td>string/null</td><td>Reading order algorithm used for this extraction.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h2 id="page-result"><a class="header" href="#page-result">Page Result</a></h2>
|
||
<p>Each page in the <code>pages</code> array contains:</p>
|
||
<pre><code class="language-json">{
|
||
"index": 0,
|
||
"spans": [...],
|
||
"blocks": [...],
|
||
"tables": [...],
|
||
"error": null
|
||
}
|
||
</code></pre>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>index</code></td><td>integer</td><td>Yes</td><td>Zero-based page index. This is the canonical identifier for programmatic use.</td></tr>
|
||
<tr><td><code>spans</code></td><td>array</td><td>Yes</td><td>Extracted spans (text fragments with consistent styling).</td></tr>
|
||
<tr><td><code>blocks</code></td><td>array</td><td>Yes</td><td>Extracted blocks (semantic units like paragraphs, headings).</td></tr>
|
||
<tr><td><code>tables</code></td><td>array</td><td>Yes</td><td>Extracted tables with cell-level structure. Empty when no tables detected.</td></tr>
|
||
<tr><td><code>error</code></td><td>string/null</td><td>Yes</td><td>Error message if extraction failed for this page.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h3 id="span"><a class="header" href="#span">Span</a></h3>
|
||
<p>A span is the smallest unit of extracted text, representing a contiguous run of text with consistent font and styling.</p>
|
||
<pre><code class="language-json">{
|
||
"text": "The quick brown fox",
|
||
"bbox": [72.0, 612.0, 245.5, 624.3],
|
||
"font": "Helvetica-Bold",
|
||
"size": 12.0,
|
||
"column": 0,
|
||
"confidence": 0.98,
|
||
"receipt": null
|
||
}
|
||
</code></pre>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>text</code></td><td>string</td><td>Yes</td><td>The extracted text content.</td></tr>
|
||
<tr><td><code>bbox</code></td><td>array</td><td>Yes</td><td>Bounding box in PDF user-space points. Format: <code>[x0, y0, x1, y1]</code> where (x0, y0) is the bottom-left corner and (x1, y1) is the top-right corner. Units are 1/72 inch.</td></tr>
|
||
<tr><td><code>font</code></td><td>string</td><td>Yes</td><td>Font name or identifier.</td></tr>
|
||
<tr><td><code>size</code></td><td>number</td><td>Yes</td><td>Font size in points.</td></tr>
|
||
<tr><td><code>column</code></td><td>integer/null</td><td>No</td><td>Column index (0-based) assigned by Phase 4.3 column detection. Null for spans outside any detected column.</td></tr>
|
||
<tr><td><code>confidence</code></td><td>number/null</td><td>No</td><td>Confidence score (0.0 to 1.0). Present when OCR is used or extraction has uncertainty.</td></tr>
|
||
<tr><td><code>receipt</code></td><td>object/null</td><td>No</td><td>Cryptographic receipt for verification. Present when <code>--receipts=lite</code> or <code>--receipts=svg</code> is enabled.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h3 id="block"><a class="header" href="#block">Block</a></h3>
|
||
<p>A block is a higher-level semantic unit composed of one or more spans.</p>
|
||
<pre><code class="language-json">{
|
||
"kind": "paragraph",
|
||
"text": "The quick brown fox jumps over the lazy dog.",
|
||
"bbox": [72.0, 600.0, 540.0, 650.0],
|
||
"level": null,
|
||
"table_index": null
|
||
}
|
||
</code></pre>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>kind</code></td><td>string</td><td>Yes</td><td>The block kind/type. Common values: <code>"paragraph"</code>, <code>"heading"</code>, <code>"list"</code>, <code>"table"</code>, <code>"figure"</code>.</td></tr>
|
||
<tr><td><code>text</code></td><td>string</td><td>Yes</td><td>The concatenated text content of all spans in the block.</td></tr>
|
||
<tr><td><code>bbox</code></td><td>array</td><td>Yes</td><td>Bounding box in PDF user-space points. Same format as spans.</td></tr>
|
||
<tr><td><code>level</code></td><td>integer/null</td><td>No</td><td>Heading level (1-6) for <code>"heading"</code> kind blocks. Null for other block types.</td></tr>
|
||
<tr><td><code>table_index</code></td><td>integer/null</td><td>No</td><td>Table index for <code>"table"</code> kind blocks. Points to the corresponding entry in the page’s <code>tables</code> array.</td></tr>
|
||
<tr><td><code>receipt</code></td><td>object/null</td><td>No</td><td>Cryptographic receipt for verification. Present when receipts are enabled.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h4 id="block-kind-enum"><a class="header" href="#block-kind-enum">Block Kind Enum</a></h4>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Value</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>paragraph</code></td><td>A paragraph block.</td></tr>
|
||
<tr><td><code>heading</code></td><td>A heading block (with <code>level</code> field 1-6).</td></tr>
|
||
<tr><td><code>list</code></td><td>A list item block.</td></tr>
|
||
<tr><td><code>table</code></td><td>A table block (references <code>tables</code> array via <code>table_index</code>).</td></tr>
|
||
<tr><td><code>figure</code></td><td>A figure or image block.</td></tr>
|
||
<tr><td><code>code</code></td><td>A code block or monospace text.</td></tr>
|
||
<tr><td><code>formula</code></td><td>A mathematical formula.</td></tr>
|
||
<tr><td><code>header</code></td><td>A page header block.</td></tr>
|
||
<tr><td><code>footer</code></td><td>A page footer block.</td></tr>
|
||
<tr><td><code>watermark</code></td><td>A watermark block.</td></tr>
|
||
<tr><td><code>caption</code></td><td>A caption for a figure or table.</td></tr>
|
||
<tr><td><code>quote</code></td><td>A blockquote.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h3 id="table"><a class="header" href="#table">Table</a></h3>
|
||
<p>Tables provide detailed cell-level structure for table blocks.</p>
|
||
<pre><code class="language-json">{
|
||
"id": "table_0",
|
||
"page_index": 2,
|
||
"bbox": [72.0, 400.0, 540.0, 550.0],
|
||
"detection_method": "line_based",
|
||
"header_rows": 1,
|
||
"continued": false,
|
||
"continued_from_prev": false,
|
||
"rows": [...]
|
||
}
|
||
</code></pre>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>id</code></td><td>string</td><td>Yes</td><td>Unique identifier for this table (e.g., <code>"table_0"</code>).</td></tr>
|
||
<tr><td><code>page_index</code></td><td>integer</td><td>Yes</td><td>Zero-based page index where this table appears.</td></tr>
|
||
<tr><td><code>bbox</code></td><td>array</td><td>Yes</td><td>Bounding box in PDF user-space points.</td></tr>
|
||
<tr><td><code>detection_method</code></td><td>string</td><td>Yes</td><td>Detection method: <code>"line_based"</code> (ruling lines) or <code>"borderless"</code> (x0 alignment heuristics).</td></tr>
|
||
<tr><td><code>header_rows</code></td><td>integer</td><td>Yes</td><td>Number of contiguous header rows at the top of the table.</td></tr>
|
||
<tr><td><code>continued</code></td><td>boolean</td><td>Yes</td><td>Whether this table continues on the next page.</td></tr>
|
||
<tr><td><code>continued_from_prev</code></td><td>boolean</td><td>Yes</td><td>Whether this table is a continuation from the previous page.</td></tr>
|
||
<tr><td><code>rows</code></td><td>array</td><td>Yes</td><td>Rows in this table, ordered top-to-bottom.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h4 id="row"><a class="header" href="#row">Row</a></h4>
|
||
<p>Each row contains cells ordered left-to-right:</p>
|
||
<pre><code class="language-json">{
|
||
"bbox": [72.0, 520.0, 540.0, 540.0],
|
||
"is_header": true,
|
||
"cells": [...]
|
||
}
|
||
</code></pre>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>bbox</code></td><td>array</td><td>Yes</td><td>Bounding box in PDF user-space points.</td></tr>
|
||
<tr><td><code>is_header</code></td><td>boolean</td><td>Yes</td><td>Whether this row is a header row.</td></tr>
|
||
<tr><td><code>cells</code></td><td>array</td><td>Yes</td><td>Cells in this row, ordered left-to-right.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h4 id="cell"><a class="header" href="#cell">Cell</a></h4>
|
||
<pre><code class="language-json">{
|
||
"text": "Revenue",
|
||
"bbox": [72.0, 520.0, 180.0, 540.0],
|
||
"row": 0,
|
||
"col": 0,
|
||
"rowspan": 1,
|
||
"colspan": 1,
|
||
"is_header_row": true,
|
||
"spans": [0, 1]
|
||
}
|
||
</code></pre>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>text</code></td><td>string</td><td>Yes</td><td>The concatenated text content of all spans in the cell.</td></tr>
|
||
<tr><td><code>bbox</code></td><td>array</td><td>Yes</td><td>Bounding box in PDF user-space points.</td></tr>
|
||
<tr><td><code>row</code></td><td>integer</td><td>Yes</td><td>Zero-based row index within the table.</td></tr>
|
||
<tr><td><code>col</code></td><td>integer</td><td>Yes</td><td>Zero-based column index within the table.</td></tr>
|
||
<tr><td><code>rowspan</code></td><td>integer</td><td>Yes</td><td>Number of rows this cell spans (default 1).</td></tr>
|
||
<tr><td><code>colspan</code></td><td>integer</td><td>Yes</td><td>Number of columns this cell spans (default 1).</td></tr>
|
||
<tr><td><code>is_header_row</code></td><td>boolean</td><td>Yes</td><td>Whether this cell is in a header row.</td></tr>
|
||
<tr><td><code>spans</code></td><td>array</td><td>Yes</td><td>References to spans in the page’s <code>spans</code> array (indices).</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h2 id="form-fields-phase-74"><a class="header" href="#form-fields-phase-74">Form Fields (Phase 7.4)</a></h2>
|
||
<p>Form fields represent interactive form fields from the PDF’s AcroForm or XFA data.</p>
|
||
<blockquote>
|
||
<p><strong>Note:</strong> Phase 7 placeholders are documented here for forward-compatibility. Fields are present in the schema but return empty arrays until Phase 7 implementation.</p>
|
||
</blockquote>
|
||
<pre><code class="language-json">{
|
||
"name": "employer_signature",
|
||
"type": "text",
|
||
"value": "John Doe",
|
||
"default": null,
|
||
"read_only": false,
|
||
"required": true,
|
||
"page_index": 2,
|
||
"rect": [72.0, 400.0, 288.0, 420.0],
|
||
"multiline": true,
|
||
"max_length": 100
|
||
}
|
||
</code></pre>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>name</code></td><td>string</td><td>Yes</td><td>The absolute (dot-joined) field name from the AcroForm.</td></tr>
|
||
<tr><td><code>type</code></td><td>string</td><td>Yes</td><td>Field type: <code>"text"</code>, <code>"button"</code>, <code>"choice"</code>, or <code>"signature"</code>.</td></tr>
|
||
<tr><td><code>value</code></td><td>varies</td><td>Yes</td><td>The current value (structure varies by <code>type</code>).</td></tr>
|
||
<tr><td><code>default</code></td><td>varies</td><td>No</td><td>The default value (<code>/DV</code> entry).</td></tr>
|
||
<tr><td><code>read_only</code></td><td>boolean</td><td>Yes</td><td>Whether this field is read-only (bit 1 of <code>/Ff</code> flags).</td></tr>
|
||
<tr><td><code>required</code></td><td>boolean</td><td>Yes</td><td>Whether this field is required (bit 2 of <code>/Ff</code> flags).</td></tr>
|
||
<tr><td><code>page_index</code></td><td>integer/null</td><td>No</td><td>Zero-based page index where this field’s widget appears.</td></tr>
|
||
<tr><td><code>rect</code></td><td>array/null</td><td>No</td><td>Bounding box in PDF user-space points.</td></tr>
|
||
<tr><td><code>multiline</code></td><td>boolean/null</td><td>No</td><td>Whether this text field supports multiple lines (text fields only).</td></tr>
|
||
<tr><td><code>max_length</code></td><td>integer/null</td><td>No</td><td>Maximum length for text fields (<code>/MaxLen</code> entry).</td></tr>
|
||
<tr><td><code>multi_select</code></td><td>boolean/null</td><td>No</td><td>Whether this choice field supports multiple selections.</td></tr>
|
||
<tr><td><code>options</code></td><td>array/null</td><td>No</td><td>Available options for choice fields (<code>[export_value, display_name]</code> pairs).</td></tr>
|
||
<tr><td><code>radio</code></td><td>boolean/null</td><td>No</td><td>Whether this button is a radio button (button fields only).</td></tr>
|
||
<tr><td><code>pushbutton</code></td><td>boolean/null</td><td>No</td><td>Whether this button is a pushbutton (button fields only).</td></tr>
|
||
<tr><td><code>selected</code></td><td>boolean/null</td><td>No</td><td>Selected state for button fields.</td></tr>
|
||
<tr><td><code>state_name</code></td><td>string/null</td><td>No</td><td>Appearance state name for button fields (e.g., <code>"Yes"</code>, <code>"Off"</code>).</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h2 id="signatures-phase-73"><a class="header" href="#signatures-phase-73">Signatures (Phase 7.3)</a></h2>
|
||
<p>Digital signatures extracted from signature fields.</p>
|
||
<pre><code class="language-json">{
|
||
"field_name": "employer_signature",
|
||
"signer_name": "Jane Corporation",
|
||
"signing_date": "2024-03-15T14:23:51Z",
|
||
"location": "New York, NY",
|
||
"reason": "Contract approval",
|
||
"sub_filter": "adbe.pkcs7.detached",
|
||
"byte_range": [0, 12345, 67890, 456],
|
||
"coverage_fraction": 0.95,
|
||
"validation_status": "not_checked"
|
||
}
|
||
</code></pre>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>field_name</code></td><td>string</td><td>Yes</td><td>The absolute (dot-joined) field name from the AcroForm.</td></tr>
|
||
<tr><td><code>signer_name</code></td><td>string</td><td>Yes</td><td>The signer’s name from the <code>/Name</code> entry. Empty string if absent.</td></tr>
|
||
<tr><td><code>validation_status</code></td><td>string</td><td>Yes</td><td>Validation status — always <code>"not_checked"</code> in v1. Future versions may add <code>"valid"</code>, <code>"invalid"</code>, <code>"indeterminate"</code>.</td></tr>
|
||
<tr><td><code>signing_date</code></td><td>string/null</td><td>No</td><td>The signing date as an ISO 8601 string (RFC 3339 format).</td></tr>
|
||
<tr><td><code>location</code></td><td>string/null</td><td>No</td><td>The location of signing from the <code>/Location</code> entry.</td></tr>
|
||
<tr><td><code>reason</code></td><td>string/null</td><td>No</td><td>The reason for signing from the <code>/Reason</code> entry.</td></tr>
|
||
<tr><td><code>sub_filter</code></td><td>string/null</td><td>No</td><td>The signature format/filter from the <code>/SubFilter</code> entry.</td></tr>
|
||
<tr><td><code>byte_range</code></td><td>array/null</td><td>No</td><td>The <code>/ByteRange</code> array defining which bytes of the file are signed.</td></tr>
|
||
<tr><td><code>coverage_fraction</code></td><td>number/null</td><td>No</td><td>Fraction of the file covered by the signature (0.0 to 1.0).</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h2 id="receipts-phase-68"><a class="header" href="#receipts-phase-68">Receipts (Phase 6.8)</a></h2>
|
||
<p>Visual citation receipts provide cryptographic proof that extracted text originated from a specific region in a specific PDF.</p>
|
||
<pre><code class="language-json">{
|
||
"pdf_fingerprint": "pdftract-v1:a7f3c8d9...",
|
||
"page_index": 14,
|
||
"bbox": [220.0, 412.0, 412.0, 432.0],
|
||
"content_hash": "sha256:9b21c4e5...",
|
||
"extraction_version": "1.0.0",
|
||
"svg_clip": null
|
||
}
|
||
</code></pre>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>pdf_fingerprint</code></td><td>string</td><td>Yes</td><td>Phase 1.7 fingerprint of the source PDF.</td></tr>
|
||
<tr><td><code>page_index</code></td><td>integer</td><td>Yes</td><td>Zero-based page index in the source PDF.</td></tr>
|
||
<tr><td><code>bbox</code></td><td>array</td><td>Yes</td><td>Bounding box in PDF user-space points.</td></tr>
|
||
<tr><td><code>content_hash</code></td><td>string</td><td>Yes</td><td>SHA-256 hash of the NFC-normalized text content. Format: <code>"sha256:" + hex(SHA-256)</code>.</td></tr>
|
||
<tr><td><code>extraction_version</code></td><td>string</td><td>Yes</td><td>The pdftract version that produced this receipt (semver string).</td></tr>
|
||
<tr><td><code>svg_clip</code></td><td>string/null</td><td>No</td><td>SVG clip rendering the glyphs (present only in SVG mode).</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h3 id="receipts-mode"><a class="header" href="#receipts-mode">Receipts Mode</a></h3>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Mode</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>off</code></td><td>No receipts generated (default).</td></tr>
|
||
<tr><td><code>lite</code></td><td>Minimal receipts (~120 bytes each) with fingerprint, page index, bbox, and content hash.</td></tr>
|
||
<tr><td><code>svg</code></td><td>Extended receipts that include an SVG clip rendering the glyphs.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h2 id="phase-7-placeholders"><a class="header" href="#phase-7-placeholders">Phase 7 Placeholders</a></h2>
|
||
<p>The following fields are included in the schema for forward compatibility but are not yet populated in Phase 6. They will be populated in Phase 7:</p>
|
||
<ul>
|
||
<li><strong><code>pages[].annotations</code></strong> - Highlights, stamps, notes, links from <code>/Annots</code> (Phase 7)</li>
|
||
<li><strong><code>attachments</code></strong> - From <code>/EmbeddedFiles</code> name tree (Phase 7.5)</li>
|
||
<li><strong><code>links</code></strong> - Document-scoped URI and internal destination links (Phase 7.6)</li>
|
||
<li><strong><code>threads</code></strong> - Article thread chains (Phase 7.7)</li>
|
||
</ul>
|
||
<p>These fields are present in the schema as empty arrays or null values, allowing consumers to pre-allocate space for future data without breaking when Phase 7 features are added.</p>
|
||
<h2 id="diagnostics"><a class="header" href="#diagnostics">Diagnostics</a></h2>
|
||
<p>Diagnostic messages provide visibility into extraction quality and issues:</p>
|
||
<div class="table-wrapper">
|
||
<table>
|
||
<thead>
|
||
<tr><th>Severity</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>WARN</code></td><td>Warning - extraction succeeded but with potential quality issues (e.g., low coverage suggesting scanned content).</td></tr>
|
||
<tr><td><code>ERROR</code></td><td>Error - extraction failed for a specific page or region.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p>Example diagnostics:</p>
|
||
<pre><code class="language-json">[
|
||
"WARN: page 3: low coverage (54%) - possible scanned content",
|
||
"ERROR: page 7: failed to extract - corrupt content stream"
|
||
]
|
||
</code></pre>
|
||
<h2 id="coordinate-system"><a class="header" href="#coordinate-system">Coordinate System</a></h2>
|
||
<p>All <code>bbox</code> values use PDF user-space coordinates:</p>
|
||
<ul>
|
||
<li><strong>Units:</strong> PDF points (1/72 inch, approximately 0.353 mm)</li>
|
||
<li><strong>Origin:</strong> Lower-left corner of the page (x=0, y=0)</li>
|
||
<li><strong>Format:</strong> <code>[x0, y0, x1, y1]</code> where (x0, y0) is bottom-left and (x1, y1) is top-right</li>
|
||
</ul>
|
||
<p>Example: For a US Letter page (8.5 × 11 inches):</p>
|
||
<ul>
|
||
<li>Width: 612 points (8.5 × 72)</li>
|
||
<li>Height: 792 points (11 × 72)</li>
|
||
<li>Full page bbox: <code>[0, 0, 612, 792]</code></li>
|
||
</ul>
|
||
<h2 id="schema-validation"><a class="header" href="#schema-validation">Schema Validation</a></h2>
|
||
<p>Per <a href="../plan/plan.html">INV-11</a>, all JSON output must validate against the schema. CI runs a schema validation step on every fixture:</p>
|
||
<pre><code class="language-bash"># Python validation example
|
||
pip install jsonschema
|
||
jsonschema -i output.json docs/schema/v1.0/pdftract.schema.json
|
||
</code></pre>
|
||
<h2 id="plan-references"><a class="header" href="#plan-references">Plan References</a></h2>
|
||
<ul>
|
||
<li><strong>Phase 6.1</strong> (lines 2018-2051): JSON output full schema implementation</li>
|
||
<li><strong>Phase 6.8</strong> (lines 2400+): Visual citation receipts</li>
|
||
<li><strong>Phase 7.3</strong> (lines 2750+): Digital signatures</li>
|
||
<li><strong>Phase 7.4</strong> (lines 2800+): Form fields</li>
|
||
<li><strong>INV-11</strong> (line 841): Schema validation invariant</li>
|
||
</ul>
|
||
<p>For the complete field-by-field rationale, see the <a href="../research/extraction-output-schema.html">extraction output schema research doc</a>.</p>
|
||
|
||
</main>
|
||
|
||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
<!-- Mobile navigation buttons -->
|
||
<a rel="prev" href="cli/mcp.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="schema/index.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<div style="clear: both"></div>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
|
||
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
<a rel="prev" href="cli/mcp.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="schema/index.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
|
||
</a>
|
||
</nav>
|
||
|
||
</div>
|
||
|
||
<template id=fa-eye><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M288 32c-80.8 0-145.5 36.8-192.6 80.6C48.6 156 17.3 208 2.5 243.7c-3.3 7.9-3.3 16.7 0 24.6C17.3 304 48.6 356 95.4 399.4C142.5 443.2 207.2 480 288 480s145.5-36.8 192.6-80.6c46.8-43.5 78.1-95.4 93-131.1c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C433.5 68.8 368.8 32 288 32zM432 256c0 79.5-64.5 144-144 144s-144-64.5-144-144s64.5-144 144-144s144 64.5 144 144zM288 192c0 35.3-28.7 64-64 64c-11.5 0-22.3-3-31.6-8.4c-.2 2.8-.4 5.5-.4 8.4c0 53 43 96 96 96s96-43 96-96s-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6z"/></svg></span></template>
|
||
<template id=fa-eye-slash><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M38.8 5.1C28.4-3.1 13.3-1.2 5.1 9.2S-1.2 34.7 9.2 42.9l592 464c10.4 8.2 25.5 6.3 33.7-4.1s6.3-25.5-4.1-33.7L525.6 386.7c39.6-40.6 66.4-86.1 79.9-118.4c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C465.5 68.8 400.8 32 320 32c-68.2 0-125 26.3-169.3 60.8L38.8 5.1zM223.1 149.5C248.6 126.2 282.7 112 320 112c79.5 0 144 64.5 144 144c0 24.9-6.3 48.3-17.4 68.7L408 294.5c5.2-11.8 8-24.8 8-38.5c0-53-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6c0 10.2-2.4 19.8-6.6 28.3l-90.3-70.8zm223.1 298L373 389.9c-16.4 6.5-34.3 10.1-53 10.1c-79.5 0-144-64.5-144-144c0-6.9 .5-13.6 1.4-20.2L83.1 161.5C60.3 191.2 44 220.8 34.5 243.7c-3.3 7.9-3.3 16.7 0 24.6c14.9 35.7 46.2 87.7 93 131.1C174.5 443.2 239.2 480 320 480c47.8 0 89.9-12.9 126.2-32.5z"/></svg></span></template>
|
||
<template id=fa-copy><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M502.6 70.63l-61.25-61.25C435.4 3.371 427.2 0 418.7 0H255.1c-35.35 0-64 28.66-64 64l.0195 256C192 355.4 220.7 384 256 384h192c35.2 0 64-28.8 64-64V93.25C512 84.77 508.6 76.63 502.6 70.63zM464 320c0 8.836-7.164 16-16 16H255.1c-8.838 0-16-7.164-16-16L239.1 64.13c0-8.836 7.164-16 16-16h128L384 96c0 17.67 14.33 32 32 32h47.1V320zM272 448c0 8.836-7.164 16-16 16H63.1c-8.838 0-16-7.164-16-16L47.98 192.1c0-8.836 7.164-16 16-16H160V128H63.99c-35.35 0-64 28.65-64 64l.0098 256C.002 483.3 28.66 512 64 512h192c35.2 0 64-28.8 64-64v-32h-47.1L272 448z"/></svg></span></template>
|
||
<template id=fa-play><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M73 39c-14.8-9.1-33.4-9.4-48.5-.9S0 62.6 0 80V432c0 17.4 9.4 33.4 24.5 41.9s33.7 8.1 48.5-.9L361 297c14.3-8.7 23-24.2 23-41s-8.7-32.2-23-41L73 39z"/></svg></span></template>
|
||
<template id=fa-clock-rotate-left><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M75 75L41 41C25.9 25.9 0 36.6 0 57.9V168c0 13.3 10.7 24 24 24H134.1c21.4 0 32.1-25.9 17-41l-30.8-30.8C155 85.5 203 64 256 64c106 0 192 86 192 192s-86 192-192 192c-40.8 0-78.6-12.7-109.7-34.4c-14.5-10.1-34.4-6.6-44.6 7.9s-6.6 34.4 7.9 44.6C151.2 495 201.7 512 256 512c141.4 0 256-114.6 256-256S397.4 0 256 0C185.3 0 121.3 28.7 75 75zm181 53c-13.3 0-24 10.7-24 24V256c0 6.4 2.5 12.5 7 17l72 72c9.4 9.4 24.6 9.4 33.9 0s9.4-24.6 0-33.9l-65-65V152c0-13.3-10.7-24-24-24z"/></svg></span></template>
|
||
|
||
|
||
|
||
<script>
|
||
window.playground_copyable = true;
|
||
</script>
|
||
|
||
|
||
<script src="elasticlunr-ef4e11c1.min.js"></script>
|
||
<script src="mark-09e88c2c.min.js"></script>
|
||
<script src="searcher-c2a407aa.js"></script>
|
||
|
||
<script src="clipboard-1626706a.min.js"></script>
|
||
<script src="highlight-abc7f01d.js"></script>
|
||
<script src="book-a0b12cfe.js"></script>
|
||
|
||
<!-- Custom JS scripts -->
|
||
|
||
|
||
|
||
</div>
|
||
</body>
|
||
</html>
|