Class: Google::Cloud::DocumentAI::V1::ProcessRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1/document_processor_service.rb

Overview

Request message for the ProcessDocument method.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#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:



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 153

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns A raw document on Google Cloud Storage.

Note: The following fields are mutually exclusive: gcs_document, inline_document, raw_document. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

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

    A raw document on Google Cloud Storage.

    Note: The following fields are mutually exclusive: gcs_document, inline_document, raw_document. If a field in that set is populated, all other fields in the set will automatically be cleared.



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 153

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#imageless_mode ⇒ ::Boolean

Returns Optional. Option to remove images from the document.

Returns:

  • (::Boolean) —

    Optional. Option to remove images from the document.



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 153

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns An inline document proto.

Note: The following fields are mutually exclusive: inline_document, raw_document, gcs_document. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

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

    An inline document proto.

    Note: The following fields are mutually exclusive: inline_document, raw_document, gcs_document. If a field in that set is populated, all other fields in the set will automatically be cleared.



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 153

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

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

Returns:

  • (::Google::Protobuf::Map{::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.



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 153

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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.v1.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.v1.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 153

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Inference-time options for the process API.

Returns:



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 153

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns A raw document content (bytes).

Note: The following fields are mutually exclusive: raw_document, inline_document, gcs_document. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

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

    A raw document content (bytes).

    Note: The following fields are mutually exclusive: raw_document, inline_document, gcs_document. If a field in that set is populated, all other fields in the set will automatically be cleared.



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 153

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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.



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 153

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end