Cloud Document AI v1beta3 API - Class BatchProcessRequest (2.0.0-beta18)

public sealed class BatchProcessRequest : IMessage<BatchProcessRequest>, IEquatable<BatchProcessRequest>, IDeepCloneable<BatchProcessRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Document AI v1beta3 API class BatchProcessRequest.

Request message for [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].

Inheritance

object > BatchProcessRequest

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Constructors

BatchProcessRequest()

public BatchProcessRequest()

BatchProcessRequest(BatchProcessRequest)

public BatchProcessRequest(BatchProcessRequest other)
Parameter
NameDescription
otherBatchProcessRequest

Properties

DocumentOutputConfig

public DocumentOutputConfig DocumentOutputConfig { get; set; }

The output configuration for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.

Property Value
TypeDescription
DocumentOutputConfig

InputConfigs

[Obsolete]
public RepeatedField<BatchProcessRequest.Types.BatchInputConfig> InputConfigs { get; }

The input config for each single document in the batch process.

Property Value
TypeDescription
RepeatedFieldBatchProcessRequestTypesBatchInputConfig

InputDocuments

public BatchDocumentsInputConfig InputDocuments { get; set; }

The input documents for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.

Property Value
TypeDescription
BatchDocumentsInputConfig

Labels

public MapField<string, string> Labels { get; }

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

Property Value
TypeDescription
MapFieldstringstring

Name

public string Name { get; set; }

Required. The resource name of [Processor][google.cloud.documentai.v1beta3.Processor] or [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Property Value
TypeDescription
string

OutputConfig

[Obsolete]
public BatchProcessRequest.Types.BatchOutputConfig OutputConfig { get; set; }

The overall output config for batch process.

Property Value
TypeDescription
BatchProcessRequestTypesBatchOutputConfig

ProcessOptions

public ProcessOptions ProcessOptions { get; set; }

Inference-time options for the process API

Property Value
TypeDescription
ProcessOptions

ResourceName

public IResourceName ResourceName { get; set; }

IResourceName-typed view over the Name resource name property.

Property Value
TypeDescription
IResourceName

SkipHumanReview

public bool SkipHumanReview { get; set; }

Whether human review should be skipped for this request. Default to false.

Property Value
TypeDescription
bool