{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/docs/ai/document-ai/using-results/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Reading Results

\n

A completed processing run can produce structured schema results, a generated document description, searchable content, and one or more result files.

\n

Review results in Shipwell

\n
    \n
  1. \nOpen a completed document.\n
    2. \n
  2. \nOpen the latest run.\n
    3. \n
  3. \nReview the document summary.\n
    4. \n
  4. \nOpen \nSchemas\n to review structured values.\n
    5. \n
  5. \nSelect a value to locate its source when source regions are available.\n
    6. \n
  6. \nIf the document was split, move between its result slices.\n
    7. \n
\n\n\n

Retrieve results for a run

\n

Use the run identifier with GET /document-store/documents/{id}/results?run_id={run_id} to retrieve every result created by that run.

\n

The response is paginated. Each result contains:

\n\n

Use the result id when downloading or inspecting a specific split result.

\n

Read schema results

\n

Each item in schemas corresponds to a schema in the processing configuration.

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"name\": \"purchase_order_number\",\n  \"value\": \"PO-10482\",\n  \"json_schema\": {\n    \"type\": [\"string\", \"null\"]\n  },\n  \"prompt\": \"Extract the purchase order number. Return null when absent.\",\n  \"source_regions\": [\n    {\n      \"left\": 0.12,\n      \"top\": 0.18,\n      \"width\": 0.21,\n      \"height\": 0.03\n    }\n  ],\n  \"scope\": \"document\",\n  \"result_cardinality\": \"single\"\n}
\n
\n

For application logic:

\n
    \n
  1. \nSelect results by \nname\n.\n
    2. \n
  2. \nValidate \nvalue\n against the schema contract your integration expects.\n
    3. \n
  3. \nHandle \nnull\n or missing results explicitly.\n
    4. \n
  4. \nUse \nsource_regions\n for review experiences, not as the extracted business value.\n
    5. \n
  5. \nIgnore response fields your integration does not use.\n
    6. \n
\n

Multiple results

\n

When result_cardinality is multiple, the schemas array can contain several entries with the same name. Do not assume schema names are unique within a result.

\n

When the schema's json_schema defines an array, one schema-result entry can itself contain an array value. That is different from result_cardinality: \"multiple\".

\n

Split documents

\n

When split is enabled and multiple logical documents are detected:

\n\n

Use the complete result list for the run. Do not rely on GET /documents/{id}/results/latest when you need every slice; that endpoint returns only the newest single result row.

\n\n

Generated descriptions

\n

When auto-description is enabled, a successful run updates the document's description. Retrieve the document to read the current description:

\n

Use GET /document-store/documents/{id} and read description.

\n

A later successful run with auto-description enabled can replace that description. Preserve a prior value in your own system if your workflow requires historical comparison.

\n

Inspect supporting content

\n

Use the read-only investigation endpoints when your application needs:

\n\n

See Inspecting Content and Signatures.

\n

Result handling recommendations

\n","headings":[{"value":"Reading Results","depth":1},{"value":"Review results in Shipwell","depth":2},{"value":"Retrieve results for a run","depth":2},{"value":"Read schema results","depth":2},{"value":"Multiple results","depth":2},{"value":"Split documents","depth":2},{"value":"Generated descriptions","depth":2},{"value":"Inspect supporting content","depth":2},{"value":"Result handling recommendations","depth":2}]},"contentItem":{"data":{"lastModified":"2026-07-17T16:00:10.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"0c3c1b5a-70f3-5298-8113-3a8cb8546aa6__redocly content/docs/ai/document-ai/using-results/","seo":{"title":"Reading Results","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"docs/ai/document-ai/using-results.md","pageBaseUrl":"/docs/ai/document-ai/using-results","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Reading Results","id":"reading-results"},{"depth":2,"value":"Review results in Shipwell","id":"review-results-in-shipwell"},{"depth":2,"value":"Retrieve results for a run","id":"retrieve-results-for-a-run"},{"depth":2,"value":"Read schema results","id":"read-schema-results"},{"depth":2,"value":"Multiple results","id":"multiple-results"},{"depth":2,"value":"Split documents","id":"split-documents"},{"depth":2,"value":"Generated descriptions","id":"generated-descriptions"},{"depth":2,"value":"Inspect supporting content","id":"inspect-supporting-content"},{"depth":2,"value":"Result handling recommendations","id":"result-handling-recommendations"}]},"data":{"title":"Reading Results"},"catalogInfo":null,"link":"/docs/ai/document-ai/using-results/","sidebarName":"developerPortal","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}