Google.Cloud.DocumentAI.V1Beta3 is a.NET client library for the Cloud Document AI API.
Note:
This documentation is for version 2.0.0-beta26 of the library.
Some samples may not work with other versions.
Installation
Install the Google.Cloud.DocumentAI.V1Beta3 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...").
Please ensure you enable pre-release packages (for example, in the
Visual Studio NuGet user interface, check the "Include prerelease"
box). Some of the following samples might only work with the latest
pre-release version (2.0.0-beta26) of Google.Cloud.DocumentAI.V1Beta3.
Authentication
When running on Google Cloud, no action needs to be taken to authenticate.
Otherwise, the simplest way of authenticating your API calls is to
set up Application Default Credentials.
The credentials will automatically be used to authenticate. See
Set up Application Default Credentials for more details.
Getting started
All operations are performed through the following client classes:
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.
Using the REST (HTTP/1.1) transport
This library defaults to performing RPCs using gRPC using the binary Protocol Buffer wire format.
However, it also supports HTTP/1.1 and JSON, for situations where gRPC doesn't work as desired. (This is typically due to an incompatible proxy
or other network issue.) To create a client using HTTP/1.1, specify a RestGrpcAdapter reference for the GrpcAdapter property in the client builder.
Sample code:
var client = new DocumentProcessorServiceClientBuilder
{
GrpcAdapter = RestGrpcAdapter.Default
}.Build();
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-08-28 UTC."],[[["\u003cp\u003e\u003ccode\u003eGoogle.Cloud.DocumentAI.V1Beta3\u003c/code\u003e is a .NET client library for the Cloud Document AI API, with version \u003ccode\u003e2.0.0-beta23\u003c/code\u003e being the latest.\u003c/p\u003e\n"],["\u003cp\u003eInstallation of the library is done via NuGet, with pre-release packages needing to be enabled to access the most up-to-date version.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication when using Google Cloud services is automatic, and for other environments, Application Default Credentials can be set up for ease of use.\u003c/p\u003e\n"],["\u003cp\u003eThe library offers two primary client classes, \u003ccode\u003eDocumentProcessorServiceClient\u003c/code\u003e and \u003ccode\u003eDocumentServiceClient\u003c/code\u003e, to perform operations.\u003c/p\u003e\n"],["\u003cp\u003eWhile it defaults to gRPC, HTTP/1.1 and JSON support are also available for scenarios where gRPC is not feasible, and an example is given on how to set this up.\u003c/p\u003e\n"]]],[],null,["Version latestkeyboard_arrow_down\n\n- [2.0.0-beta26 (latest)](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest)\n- [2.0.0-beta25](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/2.0.0-beta25)\n- [1.0.0-beta04](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/1.0.0-beta04) \n\nGoogle.Cloud.DocumentAI.V1Beta3\n===============================\n\n`Google.Cloud.DocumentAI.V1Beta3` is a.NET client library for the [Cloud Document AI API](https://cloud.google.com/solutions/document-ai).\n\nNote:\nThis documentation is for version `2.0.0-beta26` of the library.\nSome samples may not work with other versions.\n\nInstallation\n------------\n\nInstall the `Google.Cloud.DocumentAI.V1Beta3` package from NuGet. Add it to\nyour project in the normal way (for example by right-clicking on the\nproject in Visual Studio and choosing \"Manage NuGet Packages...\").\nPlease ensure you enable pre-release packages (for example, in the\nVisual Studio NuGet user interface, check the \"Include prerelease\"\nbox). Some of the following samples might only work with the latest\npre-release version (`2.0.0-beta26`) of `Google.Cloud.DocumentAI.V1Beta3`.\n\nAuthentication\n--------------\n\nWhen running on Google Cloud, no action needs to be taken to authenticate.\n\nOtherwise, the simplest way of authenticating your API calls is to\nset up Application Default Credentials.\nThe credentials will automatically be used to authenticate. See\n[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc) for more details.\n\nGetting started\n---------------\n\nAll operations are performed through the following client classes:\n\n- [DocumentProcessorServiceClient](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.DocumentProcessorServiceClient)\n- [DocumentServiceClient](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.DocumentServiceClient)\n\nCreate a client instance by calling the static `Create` or `CreateAsync` methods. Alternatively,\nuse the builder class associated with each client class (e.g. DocumentProcessorServiceClientBuilder for DocumentProcessorServiceClient)\nas an easy way of specifying custom credentials, settings, or a custom endpoint. Clients are thread-safe,\nand we recommend using a single instance across your entire application unless you have a particular need\nto configure multiple client objects separately.\n\n### Using the REST (HTTP/1.1) transport\n\nThis library defaults to performing RPCs using [gRPC](https://grpc.io/) using the binary [Protocol Buffer](https://protobuf.dev) wire format.\nHowever, it also supports HTTP/1.1 and JSON, for situations where gRPC doesn't work as desired. (This is typically due to an incompatible proxy\nor other network issue.) To create a client using HTTP/1.1, specify a `RestGrpcAdapter` reference for the `GrpcAdapter` property in the client builder.\nSample code: \n\n var client = new DocumentProcessorServiceClientBuilder\n {\n GrpcAdapter = RestGrpcAdapter.Default\n }.Build();\n\nFor more details, see the [transport selection](https://cloud.google.com/dotnet/docs/reference/help/transports) page.\n\nNote that if you wish to use processors other than in the US, you\nmust specify the endpoint when you construct the client. The\nendpoint is of the form `{location}-documentai.googleapis.com`, e.g.\n`eu-documentai.googleapis.com`. The simplest way to specify the\nendpoint is to use `DocumentProcessorServiceClientBuilder`: \n\n DocumentProcessorServiceClient client = new DocumentProcessorServiceClientBuilder\n {\n Endpoint = \"eu-documentai.googleapis.com\"\n }.Build();\n // Now use the client to access EU document processors."]]
