Stay organized with collections
Save and categorize content based on your preferences.
Document AI's v1beta2 API is now deprecated in favor of the
v1 API.
Unlike v1beta2, Document AI v1
is a stateful API, meaning you need to create a Processor
before you can send requests to Process
and BatchProcess
documents.
NOTE: This deprecation only affects the version of the API used to call any processor.
It does not affect the availability of any processor.
The major areas of v1 API backward incompatibility with v1beta2 API are discussed
later in this document.
Creating a processor
To migrate to v1 for processor creation, first create a Processor. The following table serves as a general guideline for choosing an appropriate
ProcessorType
to create, but you can consult the full processor list.
For a step-by-step guide to creating a processor, view the
guide.
Processing documents
Document AI v1 has two APIs to accept documents: Process and BatchProcess.
Each of these methods corresponds to a method from v1beta2. The methods and
their differences are highlighted:
In addition to accepting individual documents on Cloud Storage, v1 supports a Cloud Storage prefix to process many documents at once.
Client libraries
If using the Client Libraries to interact with
Document AI, switch from using the DocumentUnderstandingService to the
DocumentProcessorService. For a detailed example of using the client libraries
for v1, see client libraries.
[[["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-09-03 UTC."],[[["\u003cp\u003eThe Document AI \u003ccode\u003ev1beta2\u003c/code\u003e API is deprecated and users should migrate to the \u003ccode\u003ev1\u003c/code\u003e API.\u003c/p\u003e\n"],["\u003cp\u003eUnlike \u003ccode\u003ev1beta2\u003c/code\u003e, the \u003ccode\u003ev1\u003c/code\u003e API is stateful and requires the creation of a \u003ccode\u003eProcessor\u003c/code\u003e before processing documents.\u003c/p\u003e\n"],["\u003cp\u003eWhen migrating to \u003ccode\u003ev1\u003c/code\u003e, the method to process documents is either \u003ccode\u003eProcess\u003c/code\u003e or \u003ccode\u003eBatchProcess\u003c/code\u003e which each corresponds to a method from \u003ccode\u003ev1beta2\u003c/code\u003e respectively, but with some slight differences.\u003c/p\u003e\n"],["\u003cp\u003eTo migrate to \u003ccode\u003ev1\u003c/code\u003e for processor creation, you will first need to create a \u003ccode\u003eProcessor\u003c/code\u003e and use a \u003ccode\u003eProcessorType\u003c/code\u003e based on the document type.\u003c/p\u003e\n"],["\u003cp\u003eUsers of the Document AI client libraries must switch from \u003ccode\u003eDocumentUnderstandingService\u003c/code\u003e to \u003ccode\u003eDocumentProcessorService\u003c/code\u003e to use the \u003ccode\u003ev1\u003c/code\u003e API.\u003c/p\u003e\n"]]],[],null,["# Migrating from V1Beta2\n======================\n\nDocument AI's `v1beta2` API is now deprecated in favor of the\n[`v1`](/document-ai/docs/reference/rest/v1/projects.locations.processors) API.\n\nUnlike `v1beta2`, Document AI [`v1`](/document-ai/docs/reference/rest/v1/projects.locations.processors)\nis a stateful API, meaning you need to create a [`Processor`](/document-ai/docs/reference/rest/v1/projects.locations.processors#resource:-processor)\nbefore you can send requests to [`Process`](/document-ai/docs/reference/rest/v1/projects.locations.processors/process)\nand [`BatchProcess`](/document-ai/docs/reference/rest/v1/projects.locations.processors/batchProcess)\ndocuments.\n\nNOTE: This deprecation only affects the version of the API used to call any processor.\nIt does not affect the availability of any processor.\n\nThe major areas of v1 API backward incompatibility with v1beta2 API are discussed\nlater in this document.\n\n### Creating a processor\n\nTo migrate to `v1` for processor creation, first create a [`Processor`](/document-ai/docs/reference/rest/v1/projects.locations.processors#resource:-processor). The following table serves as a general guideline for choosing an appropriate\n[`ProcessorType`](/document-ai/docs/reference/rest/v1/projects.locations.processorTypes#resource:-processortype)\nto create, but you can consult the full [processor list](/document-ai/docs/processors-list).\n\nFor a step-by-step guide to creating a processor, view the\n[guide](/document-ai/docs/create-processor).\n\n### Processing documents\n\nDocument AI `v1` has two APIs to accept documents: [`Process`](/document-ai/docs/reference/rest/v1/projects.locations.processors/process) and [`BatchProcess`](/document-ai/docs/reference/rest/v1/projects.locations.processors/batchProcess).\nEach of these methods corresponds to a method from `v1beta2`. The methods and\ntheir differences are highlighted:\n\n### Client libraries\n\nIf using the [`Client Libraries`](/document-ai/docs/libraries) to interact with\nDocument AI, switch from using the `DocumentUnderstandingService` to the\n`DocumentProcessorService`. For a detailed example of using the client libraries\nfor `v1`, see [client libraries](/document-ai/docs/libraries)."]]
