Note:
This documentation is for version1.3.0of the library.
Some samples may not work with other versions.
Installation
Install theGoogle.Cloud.DocumentAI.V1package from NuGet. Add it to
your project in the normal way (for example by right-clicking on the
project in Visual Studio and choosing "Manage NuGet Packages...").
Authentication
When running on Google Cloud Platform, no action needs to be taken to authenticate.
Otherwise, the simplest way of authenticating your API calls is to
download a service account JSON file then set theGOOGLE_APPLICATION_CREDENTIALSenvironment variable to refer to it.
The credentials will automatically be used to authenticate. See theGetting Started With
Authenticationguide for more details.
Create a client instance by calling the staticCreateorCreateAsyncmethods. Alternatively,
use the builder class associated with each client class (e.g. DocumentProcessorServiceClientBuilder for DocumentProcessorServiceClient)
as an easy way of specifying custom credentials, settings, or a custom endpoint. Clients are thread-safe,
and we recommend using a single instance across your entire application unless you have a particular need
to configure multiple client objects separately.
Note that if you wish to use processors other than in the US, you
must specify the endpoint when you construct the client. The
endpoint is of the form{location}-documentai.googleapis.com, e.g.eu-documentai.googleapis.com. The simplest way to specify the
endpoint is to useDocumentProcessorServiceClientBuilder:
DocumentProcessorServiceClient client = new DocumentProcessorServiceClientBuilder
{
Endpoint = "eu-documentai.googleapis.com"
}.Build();
// Now use the client to access EU document processors.
[[["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-04 UTC."],[[["\u003cp\u003eThis page documents version 1.3.0 of the \u003ccode\u003eGoogle.Cloud.DocumentAI.V1\u003c/code\u003e .NET client library for the Cloud Document AI API, and it lists links to documentation for numerous other library versions ranging from 1.0.0 to 3.19.0.\u003c/p\u003e\n"],["\u003cp\u003eThe library is available via NuGet package installation, and it simplifies authentication when running on Google Cloud Platform or by using a service account JSON file.\u003c/p\u003e\n"],["\u003cp\u003eThe primary interface for interacting with the Document AI API is the \u003ccode\u003eDocumentProcessorServiceClient\u003c/code\u003e, which can be created using the \u003ccode\u003eCreate\u003c/code\u003e or \u003ccode\u003eCreateAsync\u003c/code\u003e methods or through its builder class.\u003c/p\u003e\n"],["\u003cp\u003eUsers can access processors outside the US by specifying a region-specific endpoint (e.g., \u003ccode\u003eeu-documentai.googleapis.com\u003c/code\u003e) during client construction, making it possible to use processors from any region.\u003c/p\u003e\n"]]],[],null,[]]
