Cloud Document AI v1 API - Class ProcessRequest (3.8.0)

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

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

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

Inheritance

object > ProcessRequest

Implements

IMessage ProcessRequest, IEquatable ProcessRequest, IDeepCloneable ProcessRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Constructors

ProcessRequest()

public ProcessRequest()

ProcessRequest(ProcessRequest)

public ProcessRequest(ProcessRequest other)

Parameter
Name	Description
`other`	`ProcessRequest`

Properties

FieldMask

public FieldMask FieldMask { get; set; }

Specifies which fields to include in the [ProcessResponse.document][google.cloud.documentai.v1.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
Type	Description
`FieldMask`

GcsDocument

public GcsDocument GcsDocument { get; set; }

A raw document on Google Cloud Storage.

Property Value
Type	Description
`GcsDocument`

InlineDocument

public Document InlineDocument { get; set; }

An inline document proto.

Property Value
Type	Description
`Document`

Name

public string Name { get; set; }

Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Property Value
Type	Description
`string`

ProcessOptions

public ProcessOptions ProcessOptions { get; set; }

Inference-time options for the process API

Property Value
Type	Description
`ProcessOptions`

RawDocument

public RawDocument RawDocument { get; set; }

A raw document content (bytes).

Property Value
Type	Description
`RawDocument`

ResourceName

public IResourceName ResourceName { get; set; }

IResourceName-typed view over the Name resource name property.

Property Value
Type	Description
`IResourceName`

SkipHumanReview

public bool SkipHumanReview { get; set; }

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

Property Value
Type	Description
`bool`

SourceCase

public ProcessRequest.SourceOneofCase SourceCase { get; }

Property Value
Type	Description
`ProcessRequestSourceOneofCase`