Note:
This documentation is for version 3.2.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"]],[["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-03-21 UTC."],[[["This page documents the .NET client library `Google.Cloud.DocumentAI.V1`, which facilitates interactions with the Cloud Document AI API, and the current documentation is specific to version 3.2.0 of the library."],["The latest version of the .NET client library for the Cloud Document AI API is version 3.19.0, with numerous earlier versions, from 3.18.0 down to 1.0.0, also available."],["Authentication for the API when running on Google Cloud Platform is automatic, while other environments require setting the `GOOGLE_APPLICATION_CREDENTIALS` environment variable using a service account JSON file."],["All operations are executed via `DocumentProcessorServiceClient`, which can be instantiated using static `Create` or `CreateAsync` methods, or through the `DocumentProcessorServiceClientBuilder` for custom configurations."],["To use document processors outside the US, you need to specify the correct endpoint (e.g., `eu-documentai.googleapis.com`) when creating the client, which can be done easily through the `DocumentProcessorServiceClientBuilder`."]]],[]]
