Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersion

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1ProcessorVersion

Returns a new instance of GoogleCloudDocumentaiV1ProcessorVersion.



5542
5543
5544
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5542

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

The time the processor version was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


5470
5471
5472
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5470

def create_time
  @create_time
end

#deprecation_info ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo

Information about the upcoming deprecation of this processor version. Corresponds to the JSON property deprecationInfo

Returns:



5475
5476
5477
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5475

def deprecation_info
  @deprecation_info
end

#display_name ⇒ String

The display name of the processor version. Corresponds to the JSON property displayName

Returns:

  • (String) 


5480
5481
5482
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5480

def display_name
  @display_name
end

#document_schema ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema

The schema defines the output of the processed document by a processor. Corresponds to the JSON property documentSchema

Returns:



5485
5486
5487
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5485

def document_schema
  @document_schema
end

#gen_ai_model_info ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo

Information about Generative AI model-based processor versions. Corresponds to the JSON property genAiModelInfo

Returns:



5490
5491
5492
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5490

def gen_ai_model_info
  @gen_ai_model_info
end

#google_managed ⇒ Boolean Also known as: google_managed?

Output only. Denotes that this ProcessorVersion is managed by Google. Corresponds to the JSON property googleManaged

Returns:

  • (Boolean) 


5495
5496
5497
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5495

def google_managed
  @google_managed
end

#kms_key_name ⇒ String

The KMS key name used for encryption. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


5501
5502
5503
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5501

def kms_key_name
  @kms_key_name
end

#kms_key_version_name ⇒ String

The KMS key version with which data is encrypted. Corresponds to the JSON property kmsKeyVersionName

Returns:

  • (String) 


5506
5507
5508
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5506

def kms_key_version_name
  @kms_key_version_name
end

#latest_evaluation ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference

Gives a short summary of an evaluation, and links to the evaluation itself. Corresponds to the JSON property latestEvaluation

Returns:



5511
5512
5513
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5511

def latest_evaluation
  @latest_evaluation
end

#model_type ⇒ String

Output only. The model type of this processor version. Corresponds to the JSON property modelType

Returns:

  • (String) 


5516
5517
5518
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5516

def model_type
  @model_type
end

#name ⇒ String

Identifier. The resource name of the processor version. Format: projects/ project/locations/location/processors/processor/processorVersions/ processor_version` Corresponds to the JSON propertyname`

Returns:

  • (String) 


5523
5524
5525
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5523

def name
  @name
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


5528
5529
5530
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5528

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


5534
5535
5536
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5534

def satisfies_pzs
  @satisfies_pzs
end

#state ⇒ String

Output only. The state of the processor version. Corresponds to the JSON property state

Returns:

  • (String) 


5540
5541
5542
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5540

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5547

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deprecation_info = args[:deprecation_info] if args.key?(:deprecation_info)
  @display_name = args[:display_name] if args.key?(:display_name)
  @document_schema = args[:document_schema] if args.key?(:document_schema)
  @gen_ai_model_info = args[:gen_ai_model_info] if args.key?(:gen_ai_model_info)
  @google_managed = args[:google_managed] if args.key?(:google_managed)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
  @latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation)
  @model_type = args[:model_type] if args.key?(:model_type)
  @name = args[:name] if args.key?(:name)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @state = args[:state] if args.key?(:state)
end