Struct google_api_proto::google::cloud::documentai::v1::ProcessRequest

pub struct ProcessRequest {
    pub name: String,
    pub skip_human_review: bool,
    pub field_mask: Option<FieldMask>,
    pub process_options: Option<ProcessOptions>,
    pub labels: BTreeMap<String, String>,
    pub imageless_mode: bool,
    pub source: Option<Source>,
}

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

Fields

name: String

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}

skip_human_review: bool

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

field_mask: Option<FieldMask>

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}.

process_options: Option<ProcessOptions>

Inference-time options for the process API

labels: BTreeMap<String, String>

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.

imageless_mode: bool

Optional. Option to remove images from the document.

source: Option<Source>

The document payload.

Trait Implementations

impl Clone for ProcessRequest

fn clone(&self) -> ProcessRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProcessRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProcessRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ProcessRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ProcessRequest

fn eq(&self, other: &ProcessRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProcessRequest