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

Choosing a Configuration

\n

A processing configuration defines what Document AI should do with a document and which structured values it should return.

\n

Configuration choices

\n

Document AI supports three ways to choose processing behavior:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ChoiceBest forReusable
Platform-managed configurationCommon Shipwell document workflowsYes
Custom named configurationA repeatable workflow owned by your companyYes
One-time custom settingsTesting or a request-specific extractionNo
\n

For uploads, you can also choose Upload only to store files without creating a processing run.

\n

What a configuration controls

\n

A configuration can control:

\n\n\n

Named configurations

\n

Named configurations are selected with processing_config_id.

\n

The list visible to your account includes:

\n\n

Only enabled configurations can be selected for uploads or manual processing.

\n

The selected configuration is used as a complete snapshot for the new run. Document AI does not merge it with another configuration or automatically add extraction schemas.

\n

Use GET /document-store/configs/processing-configs to list the configurations visible to your account.

\n

The is_platform_managed field distinguishes read-only Shipwell configurations from company-owned configurations.

\n

One-time custom settings

\n

One-time settings are supplied as pipeline_config on an upload or reprocessing request. They are useful while testing an extraction schema, but they are not saved for later selection.

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"pipeline_config\": {\n    \"schemas\": [\n      {\n        \"name\": \"purchase_order_number\",\n        \"prompt\": \"Extract the purchase order number.\",\n        \"json_schema\": {\"type\": \"string\"},\n        \"scope\": \"document\",\n        \"result_cardinality\": \"single\",\n        \"include_source_regions\": true\n      }\n    ],\n    \"split\": false,\n    \"embed\": true,\n    \"describe\": {\n      \"enabled\": true,\n      \"key_facts\": true\n    }\n  }\n}
\n
\n

Do not provide pipeline_config and processing_config_id in the same request.

\n

Which option should I use?

\n

Use a platform-managed configuration when its documented purpose matches the documents you process.

\n

Create a custom named configuration when:

\n\n

Use one-time custom settings when:

\n\n

Learn more

\n","headings":[{"value":"Choosing a Configuration","depth":1},{"value":"Configuration choices","depth":2},{"value":"What a configuration controls","depth":2},{"value":"Named configurations","depth":2},{"value":"One-time custom settings","depth":2},{"value":"Which option should I use?","depth":2},{"value":"Learn more","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":"88b7fc2b-e0fb-5899-879e-f70d18690a0f__redocly content/docs/ai/document-ai/processing-configurations/","seo":{"title":"Choosing a Configuration","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"docs/ai/document-ai/processing-configurations.md","pageBaseUrl":"/docs/ai/document-ai/processing-configurations","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Choosing a Configuration","id":"choosing-a-configuration"},{"depth":2,"value":"Configuration choices","id":"configuration-choices"},{"depth":2,"value":"What a configuration controls","id":"what-a-configuration-controls"},{"depth":2,"value":"Named configurations","id":"named-configurations"},{"depth":2,"value":"One-time custom settings","id":"one-time-custom-settings"},{"depth":2,"value":"Which option should I use?","id":"which-option-should-i-use"},{"depth":2,"value":"Learn more","id":"learn-more"}]},"data":{"title":"Choosing a Configuration"},"catalogInfo":null,"link":"/docs/ai/document-ai/processing-configurations/","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"]}