Class: Google::Cloud::DocumentAI::V1beta3::ProcessRequest
- Inherits:
-
Object
- Object
- Google::Cloud::DocumentAI::V1beta3::ProcessRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb
Overview
Request message for the ProcessDocument method.
Defined Under Namespace
Classes: LabelsEntry
Instance Attribute Summary collapse
-
#document ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document
deprecated
Deprecated.
This field is deprecated and may be removed in the next major version update.
-
#field_mask ⇒ ::Google::Protobuf::FieldMask
Specifies which fields to include in the ProcessResponse.document output.
-
#gcs_document ⇒ ::Google::Cloud::DocumentAI::V1beta3::GcsDocument
A raw document on Google Cloud Storage.
-
#inline_document ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document
An inline document proto.
-
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Optional.
-
#name ⇒ ::String
Required.
-
#process_options ⇒ ::Google::Cloud::DocumentAI::V1beta3::ProcessOptions
Inference-time options for the process API.
-
#raw_document ⇒ ::Google::Cloud::DocumentAI::V1beta3::RawDocument
A raw document content (bytes).
-
#skip_human_review ⇒ ::Boolean
Whether human review should be skipped for this request.
Instance Attribute Details
#document ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document
112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 112 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 |
#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}
.
112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 112 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::V1beta3::GcsDocument
Returns A raw document on Google Cloud Storage.
112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 112 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::V1beta3::Document
Returns An inline document proto.
112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 112 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.
112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 112 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.v1beta3.Processor.default_processor_version].
Format: projects/{project}/locations/{location}/processors/{processor}
,
or
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
.
112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 112 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::V1beta3::ProcessOptions
Returns Inference-time options for the process API.
112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 112 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::V1beta3::RawDocument
Returns A raw document content (bytes).
112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 112 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
.
112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 112 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 |