Stay organized with collections
Save and categorize content based on your preferences.
Before you begin
You need to be the administrator of your project to configure the web
application.
Follow the quick start guide to set
up necessary APIs, grant permissions, and provision the instances for your
project.
To get access to the web application, complete the following
form.
Configure the project with Google Cloud console
In the Document AI Warehouse settings view, which is the final view after
provisioning, click Show Details.
Go to the third step. Select Yes.
If your project is provisioned with the document-level access control
mode, you need to create a service account and key:
Click Create to create a service account.
After the service account is created, click Create to create a
service account key.
You can click the download button to save the key credentials. Then
click Grant to grant your account and the service account the
Content Warehouse Admin role.
Click Save Config to save the config.
If your project uses the universal access mode, directly click Save
Config:
After the config is saved, then go to the last step to open the link.
In the opened window, be sure to log in.
Give Document AI Warehouse access to your Google Cloud data by checking the first
checkbox.
If you're getting CODE 400 (invalid argument) or 401 (insufficient authentication scopes), log out by clicking on the user section at the top right, and log in again to be sure you have OAuth permissions.
If you cannot open the project as expected, refresh the page after
3 to 5 minutes. The saved configuration takes time to propagate.
Set up project-level access controls
Grant project-level access controls (ACLs) to users. There are four
Document AI Warehouse roles, including Document Creator, Document Viewer,
Document Editor, and Document Admin. The following information about the
roles is important:
The Document Creator role is typically granted to all users, which lets
the users create documents.
We recommend that you assign this role to a group of users, such as Doc
Owners, who are expected to create documents in Document AI Warehouse and manage
the group.
The creator is automatically granted the document-level Document Admin
role on documents they create by default.
The Document Viewer, Document Editor, and Document Admin roles must be
used with caution and granted only to select administrators. It is
recommended to grant operators temporarily for cleanup or audit needs. As
with these roles, the users have permissions to view, edit, share, or delete
all documents in the project.
Document level ACLs can be granted later by Document Admin of each
document.
Configure schemas
Configure the schema for documents and folders. A document schema is used to
define the document structure in Document AI Warehouse. For more information about
document schemas, see Manage document
schemas.
(Optional) Process documents using Document AI
Customers can map the Document AI
processors to the Document AI Warehouse schema, and use
Document AI processors to extract text and data. By doing so,
when documents are uploaded with specific Document AI Warehouse schema,
Document AI Warehouse uses the corresponding Document AI
processor to extract the document properties based on the mapping. For this to
work, here are the requirements and recommendations:
This requires the Document AI processors in the same project.
To make uploaded documents full-text-searchable, we recommend using the
Document AI OCR processor for PDF doc-types that don't
have specialized processors. They are then full-text searchable in
Document AI Warehouse.
Multiple processors can be mapped to a schema, the user can specify which
processor to use for extraction when uploading documents.
The throughput quota for Document AI processors is lower
(around 10 qps). Therefore, the batch pipelines or multiple concurrent user
upload scenarios run slower than typical ingests throughput that is
supported by Document AI Warehouse Create API.
If you need to use custom models for classification and extraction, convert
the extracted data into a Document AI Warehouse API JSON format and ingest the data using
the Create API.
Troubleshooting
For non-admin users to access to the Document AI Warehouse web application,
ask your admin to add you to the allowlist group.
If you see messages like "you do not have access to Partner Dash", follow
this step to resolve the
issue.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eDocument AI Warehouse is being deprecated and will be unavailable on Google Cloud after January 16, 2025, requiring users to migrate their data to an alternative service like Cloud Storage before this date to avoid data loss.\u003c/p\u003e\n"],["\u003cp\u003eAccess to the Document AI Warehouse web application requires admin configuration, including setting up necessary APIs, permissions, and instances, as well as completing a form for access.\u003c/p\u003e\n"],["\u003cp\u003eProject-level access controls in Document AI Warehouse are managed via four roles: \u003ccode\u003eDocument Creator\u003c/code\u003e, \u003ccode\u003eDocument Viewer\u003c/code\u003e, \u003ccode\u003eDocument Editor\u003c/code\u003e, and \u003ccode\u003eDocument Admin\u003c/code\u003e, with specific guidelines for assigning each role.\u003c/p\u003e\n"],["\u003cp\u003eDocument schemas must be configured to define the structure of documents in Document AI Warehouse, and Document AI processors can optionally be mapped to these schemas for automated text and data extraction.\u003c/p\u003e\n"],["\u003cp\u003ePre-GA features in Document AI Warehouse are available "as is", meaning they may have limited support, and are subject to specific terms in the General Service Terms section.\u003c/p\u003e\n"]]],[],null,["# Configure the web application\n\n| **Caution** : Document AI Warehouse is deprecated and will no longer be available on Google Cloud after January 16, 2025. To safeguard your data, migrate any documents currently saved in Document AI Warehouse to an alternative like Cloud Storage. Verify that your data migration is completed before the discontinuation date to prevent any data loss. See [Deprecations](/document-warehouse/docs/deprecations) for details.\n\n\u003cbr /\u003e\n\n|\n| **Preview**\n|\n|\n| This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nBefore you begin\n----------------\n\n1. You need to be the administrator of your project to configure the web\n application.\n\n2. Follow the [quick start](/document-warehouse/docs/quickstart) guide to set\n up necessary APIs, grant permissions, and provision the instances for your\n project.\n\n3. To get access to the web application, complete the following\n [**form**](https://docs.google.com/forms/d/e/1FAIpQLSf9cFpbtyWESSBUl_SQQhLxctS75ko36ArK6R6OucQH26QqYA/viewform).\n\nConfigure the project with Google Cloud console\n-----------------------------------------------\n\n1. In the Document AI Warehouse settings view, which is the final view after\n provisioning, click **Show Details**.\n\n2. Go to the third step. Select **Yes**.\n\n 1. If your project is provisioned with the document-level access control\n mode, you need to create a service account and key:\n\n 1. Click **Create** to create a service account.\n\n 2. After the service account is created, click **Create** to create a\n service account key.\n\n 3. You can click the download button to save the key credentials. Then\n click **Grant** to grant your account and the service account the\n Content Warehouse Admin role.\n\n 4. Click **Save Config** to save the config.\n\n 2. If your project uses the universal access mode, directly click **Save\n Config**:\n\n3. After the config is saved, then go to the last step to open the link.\n\n4. In the opened window, be sure to log in.\n\n5. Give Document AI Warehouse access to your Google Cloud data by checking the first\n checkbox.\n\n6. If you're getting CODE 400 (invalid argument) or 401 (insufficient authentication scopes), log out by clicking on the user section at the top right, and log in again to be sure you have OAuth permissions.\n\n7. If you cannot open the project as expected, refresh the page after\n 3 to 5 minutes. The saved configuration takes time to propagate.\n\nSet up project-level access controls\n------------------------------------\n\n| **Note:** Document AI Warehouse users and groups are authenticated by Cloud Identity. All Document AI Warehouse users and groups must be in Cloud Identity. IAM supports synchronizing users and groups from customer's LDAP and Active Directory. For more information, see [Federating Google Cloud\n| with Active\n| Directory](https://cloud.google.com/architecture/identity/federating-gcp-with-active-directory-introduction).\n\nGrant project-level access controls (ACLs) to users. There are four\nDocument AI Warehouse roles, including `Document Creator`, `Document Viewer`,\n`Document Editor`, and `Document Admin`. The following information about the\nroles is important:\n\n- The `Document Creator` role is typically granted to all users, which lets\n the users create documents.\n\n - We recommend that you assign this role to a group of users, such as `Doc\n Owners`, who are expected to create documents in Document AI Warehouse and manage the group.\n - The creator is automatically granted the document-level `Document Admin` role on documents they create by default.\n- The `Document Viewer`, `Document Editor`, and `Document Admin` roles must be\n used with caution and granted only to select administrators. It is\n recommended to grant operators temporarily for cleanup or audit needs. As\n with these roles, the users have permissions to view, edit, share, or delete\n all documents in the project.\n\n- Document level ACLs can be granted later by `Document Admin` of each\n document.\n\n| **Note:** Be sure to grant your account the project-level **Document Admin** access in the **Access** tab.\n\nConfigure schemas\n-----------------\n\nConfigure the **schema** for documents and folders. A document schema is used to\ndefine the document structure in Document AI Warehouse. For more information about\ndocument schemas, see [Manage document\nschemas](https://cloud.google.com/document-warehouse/docs/manage-document-schemas).\n\n### (Optional) Process documents using Document AI\n\nCustomers can map the Document AI\nprocessors to the Document AI Warehouse schema, and use\nDocument AI processors to extract text and data. By doing so,\nwhen documents are uploaded with specific Document AI Warehouse schema,\nDocument AI Warehouse uses the corresponding Document AI\nprocessor to extract the document properties based on the mapping. For this to\nwork, here are the requirements and recommendations:\n\n- This requires the Document AI processors in the same project.\n\n- To make uploaded documents full-text-searchable, we recommend using the\n Document AI OCR processor for PDF doc-types that don't\n have specialized processors. They are then full-text searchable in\n Document AI Warehouse.\n\n- Multiple processors can be mapped to a schema, the user can specify which\n processor to use for extraction when uploading documents.\n\n- The throughput quota for Document AI processors is lower\n (around 10 qps). Therefore, the batch pipelines or multiple concurrent user\n upload scenarios run slower than typical ingests throughput that is\n supported by Document AI Warehouse Create API.\n\n- If you need to use custom models for classification and extraction, convert\n the extracted data into a Document AI Warehouse API JSON format and ingest the data using\n the `Create` API.\n\nTroubleshooting\n---------------\n\n- For non-admin users to access to the Document AI Warehouse web application,\n ask your admin to add you to the allowlist group.\n\n- If you see messages like \"you do not have access to Partner Dash\", follow\n this [step to resolve the\n issue](https://support.google.com/partnerdash#6010264).\n\nNext steps\n----------\n\nFor more information, learn how to [upload\ndocuments](/document-warehouse/docs/upload-documents)."]]
