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

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

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

Request message for the [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument] method.

Inheritance

object > ProcessRequest

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Constructors

ProcessRequest()

public ProcessRequest()

ProcessRequest(ProcessRequest)

public ProcessRequest(ProcessRequest other)
Parameter
NameDescription
otherProcessRequest

Properties

Document

[Obsolete]
public Document Document { get; set; }

The document payload, the [content][google.cloud.documentai.v1beta3.Document.content] and [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must be set.

Property Value
TypeDescription
Document

FieldMask

public FieldMask FieldMask { get; set; }

Specifies which fields to include in the [ProcessResponse.document][google.cloud.documentai.v1beta3.ProcessResponse.document] output. Only supports top-level document and pages field, so it must be in the form of {document_field_name} or pages.{page_field_name}.

Property Value
TypeDescription
FieldMask

GcsDocument

public GcsDocument GcsDocument { get; set; }

A raw document on Google Cloud Storage.

Property Value
TypeDescription
GcsDocument

InlineDocument

public Document InlineDocument { get; set; }

An inline document proto.

Property Value
TypeDescription
Document

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 the [Processor][google.cloud.documentai.v1beta3.Processor] or [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to use for processing. If a [Processor][google.cloud.documentai.v1beta3.Processor] is specified, the server will use its [default version][google.cloud.documentai.v1beta3.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Property Value
TypeDescription
string

ProcessOptions

public ProcessOptions ProcessOptions { get; set; }

Inference-time options for the process API

Property Value
TypeDescription
ProcessOptions

RawDocument

public RawDocument RawDocument { get; set; }

A raw document content (bytes).

Property Value
TypeDescription
RawDocument

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

SourceCase

public ProcessRequest.SourceOneofCase SourceCase { get; }
Property Value
TypeDescription
ProcessRequestSourceOneofCase