Class: Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest

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

Overview

Request message for batch process document method.

Defined Under Namespace

Classes: BatchInputConfig, BatchOutputConfig

Instance Attribute Summary collapse

Instance Attribute Details

#document_output_config ⇒ ::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig

Returns The overall output config for batch process.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 124

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

  # The message for input config in batch process.
  # @!attribute [rw] gcs_source
  #   @return [::String]
  #     The Cloud Storage location as the source of the document.
  # @!attribute [rw] mime_type
  #   @return [::String]
  #     Mimetype of the input. If the input is a raw document, the supported
  #     mimetypes are application/pdf, image/tiff, and image/gif.
  #     If the input is a [Document] proto, the type should be application/json.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The message for output config in batch process.
  # @!attribute [rw] gcs_destination
  #   @return [::String]
  #     The output Cloud Storage directory to put the processed documents.
  class BatchOutputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#input_configs ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchInputConfig>

Returns The input config for each single document in the batch process.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 124

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

  # The message for input config in batch process.
  # @!attribute [rw] gcs_source
  #   @return [::String]
  #     The Cloud Storage location as the source of the document.
  # @!attribute [rw] mime_type
  #   @return [::String]
  #     Mimetype of the input. If the input is a raw document, the supported
  #     mimetypes are application/pdf, image/tiff, and image/gif.
  #     If the input is a [Document] proto, the type should be application/json.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The message for output config in batch process.
  # @!attribute [rw] gcs_destination
  #   @return [::String]
  #     The output Cloud Storage directory to put the processed documents.
  class BatchOutputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#input_documents ⇒ ::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig

Returns The input documents for batch process.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 124

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

  # The message for input config in batch process.
  # @!attribute [rw] gcs_source
  #   @return [::String]
  #     The Cloud Storage location as the source of the document.
  # @!attribute [rw] mime_type
  #   @return [::String]
  #     Mimetype of the input. If the input is a raw document, the supported
  #     mimetypes are application/pdf, image/tiff, and image/gif.
  #     If the input is a [Document] proto, the type should be application/json.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The message for output config in batch process.
  # @!attribute [rw] gcs_destination
  #   @return [::String]
  #     The output Cloud Storage directory to put the processed documents.
  class BatchOutputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Required. The processor resource name.

Returns:

  • (::String) —

    Required. The processor resource name.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 124

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

  # The message for input config in batch process.
  # @!attribute [rw] gcs_source
  #   @return [::String]
  #     The Cloud Storage location as the source of the document.
  # @!attribute [rw] mime_type
  #   @return [::String]
  #     Mimetype of the input. If the input is a raw document, the supported
  #     mimetypes are application/pdf, image/tiff, and image/gif.
  #     If the input is a [Document] proto, the type should be application/json.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The message for output config in batch process.
  # @!attribute [rw] gcs_destination
  #   @return [::String]
  #     The output Cloud Storage directory to put the processed documents.
  class BatchOutputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#output_config ⇒ ::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig

Returns The overall output config for batch process.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 124

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

  # The message for input config in batch process.
  # @!attribute [rw] gcs_source
  #   @return [::String]
  #     The Cloud Storage location as the source of the document.
  # @!attribute [rw] mime_type
  #   @return [::String]
  #     Mimetype of the input. If the input is a raw document, the supported
  #     mimetypes are application/pdf, image/tiff, and image/gif.
  #     If the input is a [Document] proto, the type should be application/json.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The message for output config in batch process.
  # @!attribute [rw] gcs_destination
  #   @return [::String]
  #     The output Cloud Storage directory to put the processed documents.
  class BatchOutputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#skip_human_review ⇒ ::Boolean

Returns Whether Human Review feature should be skipped for this request. Default to false.

Returns:

  • (::Boolean) —

    Whether Human Review feature should be skipped for this request. Default to false.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 124

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

  # The message for input config in batch process.
  # @!attribute [rw] gcs_source
  #   @return [::String]
  #     The Cloud Storage location as the source of the document.
  # @!attribute [rw] mime_type
  #   @return [::String]
  #     Mimetype of the input. If the input is a raw document, the supported
  #     mimetypes are application/pdf, image/tiff, and image/gif.
  #     If the input is a [Document] proto, the type should be application/json.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The message for output config in batch process.
  # @!attribute [rw] gcs_destination
  #   @return [::String]
  #     The output Cloud Storage directory to put the processed documents.
  class BatchOutputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end