sliders-upModel Settings

Model Name and Cover Image

On the Model Settings page, you'll have the opportunity to modify the model name and the cover image. Feel free to set them up so that the Model will be easy to retrieve among all your other Models.

Model ID

In the Model Settings page, you can view and copy the Model ID.

You will need the Model ID in order to integrate the Mindee API.

The Mindee Support team may also request the Model ID to diagnose issues and provide solutions.

Processing Zone

The Processing Zone setting determines the geographic region where your document data will be processed. This option can impact compliance with data residency requirements (e.g., GDPR, CCPA).

Available options:

  • No Preference (Default) Mindee will automatically route your documents to the closest or most available processing region. This is the recommended default for optimal performance and availability, but your data may be processed in Europe and in the United States.

  • Europe Forces all data processing to occur exclusively within data centers located in Europe (EU). Recommended for organizations subject to GDPR or EU data residency policies.

  • United States Forces all data processing to occur exclusively within data centers located in the United States. Recommended for organizations subject to U.S. data governance or compliance policies.

circle-info

This is only a zone for processing, not extraction or analysis support.

You can send documents from any country to the Mindee API!

Storage Policy

The Storage Policy defines how long extracted data (i.e., the results of document processing) is retained in Mindee’s systems before being permanently deleted.

This section only applies when sending documents via API call.

Storage Duration

  • Defines the exact number of hours that extracted data is stored.

  • Default: 12 hours

  • Minimum: 1 hour

  • Maximum: 24 hours

Data is automatically deleted as soon as the storage duration expires.

During this time, you may make GET requests to retrieve the payload using its inference ID. After this period, any calls to the inference ID or job ID will result in a 404 error.

This setting helps balance between accessibility of results for your workflow and minimizing retention for privacy and compliance.

Delete Extracted Data When Fetched

When disabled, data will be retained until the configured Storage Duration elapses. (Default)

When enabled, extracted data is automatically and permanently deleted immediately after:

  • the inference is accessed using a GET request (usually when polling)

  • the inference is successfully sent to your server via a webhook

The data will be deleted regardless of the Storage Period setting.

Once the Storage Period is passed, the data will be deleted regardless of whether this option is enabled. Once the data are deleted, any calls to the inference ID will result in a 404 error.

This option is recommended for workflows where you only need the extracted data once and do not require retrieval beyond the initial API call.

Copying the Model

It can be useful to copy an existing model for some types of workflows.

You can have a base "template" model that is not called directly, but is used to make derivative models. This way you can have a common base and then modify the Data Schema to account for different providers, geographies, downstream users, etc. Each of these derivative models would be a copy of the "template" model.

You can also us this as way for testing changes to a model. For example you can copy a model used in production, modify the copy, and test the modifications in staging. Once the modifications are tested successfully, switch production over to the new model.

Locking the Data Schema

To prevent unintended changes once your data schema is finalized, you have the option to lock it. This ensures that the model remains stable and any modifications are controlled.

circle-exclamation

Deleting the Model

You can delete a model at any time.

triangle-exclamation

Last updated

Was this helpful?