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:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 138

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:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 138

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:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 138

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 resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}.

Returns:

  • (::String) —

    Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 138

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:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 138

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.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 138

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