Class: Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest
- Inherits:
-
Object
- Object
- Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest
- 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, LabelsEntry
Instance Attribute Summary collapse
-
#document_output_config ⇒ ::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig
The output configuration for the BatchProcessDocuments method.
-
#input_configs ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchInputConfig>
deprecated
Deprecated.
This field is deprecated and may be removed in the next major version update.
-
#input_documents ⇒ ::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig
The input documents for the BatchProcessDocuments method.
-
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Optional.
-
#name ⇒ ::String
Required.
-
#output_config ⇒ ::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig
deprecated
Deprecated.
This field is deprecated and may be removed in the next major version update.
-
#process_options ⇒ ::Google::Cloud::DocumentAI::V1beta3::ProcessOptions
Inference-time options for the process API.
-
#skip_human_review ⇒ ::Boolean
Whether human review should be skipped for this request.
Instance Attribute Details
#document_output_config ⇒ ::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig
Returns The output configuration for the BatchProcessDocuments method.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 233 class BatchProcessRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The message for input config in batch process. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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 # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#input_configs ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchInputConfig>
This field is deprecated and may be removed in the next major version update.
Returns The input config for each single document in the batch process.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 233 class BatchProcessRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The message for input config in batch process. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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 # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry 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.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 233 class BatchProcessRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The message for input config in batch process. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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 # @!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.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 233 class BatchProcessRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The message for input config in batch process. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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 # @!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
Processor or
ProcessorVersion.
Format: projects/{project}/locations/{location}/processors/{processor}
,
or
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 233 class BatchProcessRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The message for input config in batch process. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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 # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#output_config ⇒ ::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig
This field is deprecated and may be removed in the next major version update.
Returns The overall output config for batch process.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 233 class BatchProcessRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The message for input config in batch process. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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 # @!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::V1beta3::ProcessOptions
Returns Inference-time options for the process API.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 233 class BatchProcessRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The message for input config in batch process. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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 # @!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
.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 233 class BatchProcessRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The message for input config in batch process. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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. # @deprecated This message is deprecated and may be removed in the next major version update. # @!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 # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |