Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::ProcessorVersion.
A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — The time the processor version was created.
#create_time=
def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — The time the processor version was created.
Returns
- (::Google::Protobuf::Timestamp) — The time the processor version was created.
#deprecation_info
def deprecation_info() -> ::Google::Cloud::DocumentAI::V1::ProcessorVersion::DeprecationInfo
Returns
- (::Google::Cloud::DocumentAI::V1::ProcessorVersion::DeprecationInfo) — If set, information about the eventual deprecation of this version.
#deprecation_info=
def deprecation_info=(value) -> ::Google::Cloud::DocumentAI::V1::ProcessorVersion::DeprecationInfo
Parameter
- value (::Google::Cloud::DocumentAI::V1::ProcessorVersion::DeprecationInfo) — If set, information about the eventual deprecation of this version.
Returns
- (::Google::Cloud::DocumentAI::V1::ProcessorVersion::DeprecationInfo) — If set, information about the eventual deprecation of this version.
#display_name
def display_name() -> ::String
Returns
- (::String) — The display name of the processor version.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — The display name of the processor version.
Returns
- (::String) — The display name of the processor version.
#document_schema
def document_schema() -> ::Google::Cloud::DocumentAI::V1::DocumentSchema
Returns
- (::Google::Cloud::DocumentAI::V1::DocumentSchema) — The schema of the processor version. Describes the output.
#document_schema=
def document_schema=(value) -> ::Google::Cloud::DocumentAI::V1::DocumentSchema
Parameter
- value (::Google::Cloud::DocumentAI::V1::DocumentSchema) — The schema of the processor version. Describes the output.
Returns
- (::Google::Cloud::DocumentAI::V1::DocumentSchema) — The schema of the processor version. Describes the output.
#google_managed
def google_managed() -> ::Boolean
Returns
-
(::Boolean) — Output only. Denotes that this
ProcessorVersion
is managed by Google.
#kms_key_name
def kms_key_name() -> ::String
Returns
- (::String) — The KMS key name used for encryption.
#kms_key_name=
def kms_key_name=(value) -> ::String
Parameter
- value (::String) — The KMS key name used for encryption.
Returns
- (::String) — The KMS key name used for encryption.
#kms_key_version_name
def kms_key_version_name() -> ::String
Returns
- (::String) — The KMS key version with which data is encrypted.
#kms_key_version_name=
def kms_key_version_name=(value) -> ::String
Parameter
- value (::String) — The KMS key version with which data is encrypted.
Returns
- (::String) — The KMS key version with which data is encrypted.
#latest_evaluation
def latest_evaluation() -> ::Google::Cloud::DocumentAI::V1::EvaluationReference
Returns
- (::Google::Cloud::DocumentAI::V1::EvaluationReference) — The most recently invoked evaluation for the processor version.
#latest_evaluation=
def latest_evaluation=(value) -> ::Google::Cloud::DocumentAI::V1::EvaluationReference
Parameter
- value (::Google::Cloud::DocumentAI::V1::EvaluationReference) — The most recently invoked evaluation for the processor version.
Returns
- (::Google::Cloud::DocumentAI::V1::EvaluationReference) — The most recently invoked evaluation for the processor version.
#model_type
def model_type() -> ::Google::Cloud::DocumentAI::V1::ProcessorVersion::ModelType
Returns
- (::Google::Cloud::DocumentAI::V1::ProcessorVersion::ModelType) — Output only. The model type of this processor version.
#name
def name() -> ::String
Returns
-
(::String) — The resource name of the processor version.
Format:
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — The resource name of the processor version.
Format:
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}
Returns
-
(::String) — The resource name of the processor version.
Format:
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}
#state
def state() -> ::Google::Cloud::DocumentAI::V1::ProcessorVersion::State
Returns
- (::Google::Cloud::DocumentAI::V1::ProcessorVersion::State) — The state of the processor version.
#state=
def state=(value) -> ::Google::Cloud::DocumentAI::V1::ProcessorVersion::State
Parameter
- value (::Google::Cloud::DocumentAI::V1::ProcessorVersion::State) — The state of the processor version.
Returns
- (::Google::Cloud::DocumentAI::V1::ProcessorVersion::State) — The state of the processor version.