Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType

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

Overview

EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta3SchemaEntityType

Returns a new instance of GoogleCloudDocumentaiV1beta3SchemaEntityType.



6433
6434
6435
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6433

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

Instance Attribute Details

#base_type ⇒ String

Type of the entity. It must be one of the following: document - the entity represents a classification of a logical document. object - if the entity has properties it is likely an object (or or a document.) datetime - the entity is a date or time value. money - the entity represents a money value amount. number - the entity is a number - integer or floating point. string

  • the entity is a string value. boolean - the entity is a boolean value. address - the entity is a location address. Corresponds to the JSON property baseType

Returns:

  • (String) 


6395
6396
6397
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6395

def base_type
  @base_type
end

#description ⇒ String

Description of the entity type. Corresponds to the JSON property description

Returns:

  • (String) 


6400
6401
6402
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6400

def description
  @description
end

#enum_values ⇒ Array<String>

For some entity types there are only a few possible values. They can be specified here. Corresponds to the JSON property enumValues

Returns:

  • (Array<String>) 


6406
6407
6408
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6406

def enum_values
  @enum_values
end

#occurrence_type ⇒ String

Occurrence type limits the number of times an entity type appears in the document. Corresponds to the JSON property occurrenceType

Returns:

  • (String) 


6412
6413
6414
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6412

def occurrence_type
  @occurrence_type
end

#properties ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType>

Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType 'ID', which consists of EntityType 'name' and 'address', with corresponding attributes, such as TEXT for both types and ONCE for occurrence types. Corresponds to the JSON property properties

Returns:



6421
6422
6423
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6421

def properties
  @properties
end

#source ⇒ String

Source of this entity type. Corresponds to the JSON property source

Returns:

  • (String) 


6426
6427
6428
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6426

def source
  @source
end

#type ⇒ String

Name of the type. It must be unique within the set of same level types. Corresponds to the JSON property type

Returns:

  • (String) 


6431
6432
6433
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6431

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6438
6439
6440
6441
6442
6443
6444
6445
6446
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6438

def update!(**args)
  @base_type = args[:base_type] if args.key?(:base_type)
  @description = args[:description] if args.key?(:description)
  @enum_values = args[:enum_values] if args.key?(:enum_values)
  @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
  @properties = args[:properties] if args.key?(:properties)
  @source = args[:source] if args.key?(:source)
  @type = args[:type] if args.key?(:type)
end