Class: Google::Cloud::DocumentAI::V1beta3::ProcessRequest

Inherits:

Object

• Object
• Google::Cloud::DocumentAI::V1beta3::ProcessRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb

Overview

Request message for the ProcessDocument method.

Instance Attribute Summary

• #document ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document

  The document payload, the content and mime_type fields must be set.

• #field_mask ⇒ ::Google::Protobuf::FieldMask

  Specifies which fields to include in the ProcessResponse.document output.

• #gcs_document ⇒ ::Google::Cloud::DocumentAI::V1beta3::GcsDocument

  A raw document on Google Cloud Storage.

• #inline_document ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document

  An inline document proto.

• #name ⇒ ::String

  Required.

• #process_options ⇒ ::Google::Cloud::DocumentAI::V1beta3::ProcessOptions

  Inference-time options for the process API.

• #raw_document ⇒ ::Google::Cloud::DocumentAI::V1beta3::RawDocument

  A raw document content (bytes).

• #skip_human_review ⇒ ::Boolean

  Whether human review should be skipped for this request.

Instance Attribute Details

#document ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document

Returns The document payload, the content and mime_type fields must be set.

Returns:

• (::Google::Cloud::DocumentAI::V1beta3::Document) —

  The document payload, the content and mime_type fields must be set.

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 103

class ProcessRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#field_mask ⇒ ::Google::Protobuf::FieldMask

Returns Specifies which fields to include in the 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}.

Returns:

• (::Google::Protobuf::FieldMask) —

  Specifies which fields to include in the 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}.

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 103

class ProcessRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#gcs_document ⇒ ::Google::Cloud::DocumentAI::V1beta3::GcsDocument

Returns A raw document on Google Cloud Storage.

Returns:

• (::Google::Cloud::DocumentAI::V1beta3::GcsDocument) —

  A raw document on Google Cloud Storage.

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 103

class ProcessRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#inline_document ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document

Returns An inline document proto.

Returns:

• (::Google::Cloud::DocumentAI::V1beta3::Document) —

  An inline document proto.

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 103

class ProcessRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Required. The resource name of the Processor or ProcessorVersion to use for processing. If a 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}.

Returns:

• (::String) —

  Required. The resource name of the Processor or ProcessorVersion to use for processing. If a 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}

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 103

class ProcessRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#process_options ⇒ ::Google::Cloud::DocumentAI::V1beta3::ProcessOptions

Returns Inference-time options for the process API.

Returns:

• (::Google::Cloud::DocumentAI::V1beta3::ProcessOptions) —

  Inference-time options for the process API

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 103

class ProcessRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#raw_document ⇒ ::Google::Cloud::DocumentAI::V1beta3::RawDocument

Returns A raw document content (bytes).

Returns:

• (::Google::Cloud::DocumentAI::V1beta3::RawDocument) —

  A raw document content (bytes).

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 103

class ProcessRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#skip_human_review ⇒ ::Boolean

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

Returns:

• (::Boolean) —

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

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 103

class ProcessRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end