Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::ProcessorType.
A processor type is responsible for performing a certain document understanding task on a certain type of document.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#allow_creation
def allow_creation() -> ::Boolean
Returns
- (::Boolean) — Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.
#allow_creation=
def allow_creation=(value) -> ::Boolean
Parameter
- value (::Boolean) — Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.
Returns
- (::Boolean) — Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.
#available_locations
def available_locations() -> ::Array<::Google::Cloud::DocumentAI::V1::ProcessorType::LocationInfo>
Returns
- (::Array<::Google::Cloud::DocumentAI::V1::ProcessorType::LocationInfo>) — The locations in which this processor is available.
#available_locations=
def available_locations=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::ProcessorType::LocationInfo>
Parameter
- value (::Array<::Google::Cloud::DocumentAI::V1::ProcessorType::LocationInfo>) — The locations in which this processor is available.
Returns
- (::Array<::Google::Cloud::DocumentAI::V1::ProcessorType::LocationInfo>) — The locations in which this processor is available.
#category
def category() -> ::String
Returns
- (::String) — The processor category, used by UI to group processor types.
#category=
def category=(value) -> ::String
Parameter
- value (::String) — The processor category, used by UI to group processor types.
Returns
- (::String) — The processor category, used by UI to group processor types.
#launch_stage
def launch_stage() -> ::Google::Api::LaunchStage
Returns
- (::Google::Api::LaunchStage) — Launch stage of the processor type
#launch_stage=
def launch_stage=(value) -> ::Google::Api::LaunchStage
Parameter
- value (::Google::Api::LaunchStage) — Launch stage of the processor type
Returns
- (::Google::Api::LaunchStage) — Launch stage of the processor type
#name
def name() -> ::String
Returns
-
(::String) — The resource name of the processor type.
Format:
projects/{project}/processorTypes/{processor_type}
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — The resource name of the processor type.
Format:
projects/{project}/processorTypes/{processor_type}
Returns
-
(::String) — The resource name of the processor type.
Format:
projects/{project}/processorTypes/{processor_type}
#sample_document_uris
def sample_document_uris() -> ::Array<::String>
Returns
- (::Array<::String>) — A set of Cloud Storage URIs of sample documents for this processor.
#sample_document_uris=
def sample_document_uris=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — A set of Cloud Storage URIs of sample documents for this processor.
Returns
- (::Array<::String>) — A set of Cloud Storage URIs of sample documents for this processor.
#type
def type() -> ::String
Returns
-
(::String) — The processor type, such as:
OCR_PROCESSOR,INVOICE_PROCESSOR.
#type=
def type=(value) -> ::String
Parameter
-
value (::String) — The processor type, such as:
OCR_PROCESSOR,INVOICE_PROCESSOR.
Returns
-
(::String) — The processor type, such as:
OCR_PROCESSOR,INVOICE_PROCESSOR.