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

Defined Under Namespace

Classes: BatchInputConfig, BatchOutputConfig

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns The output configuration for the BatchProcessDocuments method.

Returns:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 178

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]
  #     An IANA published [media type (MIME
  #     type)](https://www.iana.org/assignments/media-types/media-types.xhtml) of
  #     the input. If the input is a raw document, refer to [supported file
  #     types](https://cloud.google.com/document-ai/docs/file-types) for the list
  #     of media types. If the input is a
  #     {::Google::Cloud::DocumentAI::V1beta3::Document Document}, the type should be
  #     `application/json`.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The output configuration in the
  # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
  # method.
  # @!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:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 178

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]
  #     An IANA published [media type (MIME
  #     type)](https://www.iana.org/assignments/media-types/media-types.xhtml) of
  #     the input. If the input is a raw document, refer to [supported file
  #     types](https://cloud.google.com/document-ai/docs/file-types) for the list
  #     of media types. If the input is a
  #     {::Google::Cloud::DocumentAI::V1beta3::Document Document}, the type should be
  #     `application/json`.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The output configuration in the
  # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
  # method.
  # @!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 the BatchProcessDocuments method.

Returns:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 178

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]
  #     An IANA published [media type (MIME
  #     type)](https://www.iana.org/assignments/media-types/media-types.xhtml) of
  #     the input. If the input is a raw document, refer to [supported file
  #     types](https://cloud.google.com/document-ai/docs/file-types) for the list
  #     of media types. If the input is a
  #     {::Google::Cloud::DocumentAI::V1beta3::Document Document}, the type should be
  #     `application/json`.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The output configuration in the
  # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
  # method.
  # @!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}



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 178

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]
  #     An IANA published [media type (MIME
  #     type)](https://www.iana.org/assignments/media-types/media-types.xhtml) of
  #     the input. If the input is a raw document, refer to [supported file
  #     types](https://cloud.google.com/document-ai/docs/file-types) for the list
  #     of media types. If the input is a
  #     {::Google::Cloud::DocumentAI::V1beta3::Document Document}, the type should be
  #     `application/json`.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The output configuration in the
  # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
  # method.
  # @!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:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 178

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]
  #     An IANA published [media type (MIME
  #     type)](https://www.iana.org/assignments/media-types/media-types.xhtml) of
  #     the input. If the input is a raw document, refer to [supported file
  #     types](https://cloud.google.com/document-ai/docs/file-types) for the list
  #     of media types. If the input is a
  #     {::Google::Cloud::DocumentAI::V1beta3::Document Document}, the type should be
  #     `application/json`.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The output configuration in the
  # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
  # method.
  # @!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

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

Returns Inference-time options for the process API.

Returns:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 178

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]
  #     An IANA published [media type (MIME
  #     type)](https://www.iana.org/assignments/media-types/media-types.xhtml) of
  #     the input. If the input is a raw document, refer to [supported file
  #     types](https://cloud.google.com/document-ai/docs/file-types) for the list
  #     of media types. If the input is a
  #     {::Google::Cloud::DocumentAI::V1beta3::Document Document}, the type should be
  #     `application/json`.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The output configuration in the
  # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
  # method.
  # @!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 should be skipped for this request. Default to false.

Returns:

  • (::Boolean) —

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 178

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]
  #     An IANA published [media type (MIME
  #     type)](https://www.iana.org/assignments/media-types/media-types.xhtml) of
  #     the input. If the input is a raw document, refer to [supported file
  #     types](https://cloud.google.com/document-ai/docs/file-types) for the list
  #     of media types. If the input is a
  #     {::Google::Cloud::DocumentAI::V1beta3::Document Document}, the type should be
  #     `application/json`.
  class BatchInputConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The output configuration in the
  # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
  # method.
  # @!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