Note:
This documentation is for version 1.4.0 of the library.
Some samples may not work with other versions.
Installation
Install the Google.Cloud.DocumentAI.V1 package 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 the GOOGLE_APPLICATION_CREDENTIALS environment variable to refer to it.
The credentials will automatically be used to authenticate. See the Getting Started With
Authentication guide for more details.
Create a client instance by calling the static Create or CreateAsync methods. 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 use DocumentProcessorServiceClientBuilder:
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"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-19 UTC."],[[["\u003cp\u003eThe latest version of the .NET client library for the Cloud Document AI API is 3.19.0, although this documentation is specifically for version 1.4.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGoogle.Cloud.DocumentAI.V1\u003c/code\u003e library facilitates interaction with the Cloud Document AI API within .NET applications and is available for installation via NuGet.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication on Google Cloud Platform is automatic, while other environments require setting the \u003ccode\u003eGOOGLE_APPLICATION_CREDENTIALS\u003c/code\u003e environment variable to point to a service account JSON file.\u003c/p\u003e\n"],["\u003cp\u003eAll API operations are conducted through the \u003ccode\u003eDocumentProcessorServiceClient\u003c/code\u003e, which can be created via static \u003ccode\u003eCreate\u003c/code\u003e or \u003ccode\u003eCreateAsync\u003c/code\u003e methods, and it's best to use a single instance.\u003c/p\u003e\n"],["\u003cp\u003eIf you're using processors in a region other than US, you'll need to specify the correct endpoint of the form \u003ccode\u003e{location}-documentai.googleapis.com\u003c/code\u003e during the client creation, and this can be done easily using the builder class.\u003c/p\u003e\n"]]],[],null,[]]
