Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1SchemaEntityType

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

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) ⇒ GoogleCloudDocumentaiV1SchemaEntityType

Returns a new instance of GoogleCloudDocumentaiV1SchemaEntityType.



3283
3284
3285
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3283

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. duration - the entity is a duration. Corresponds to the JSON property baseType

Returns:

  • (String) 


3234
3235
3236
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3234

def base_type
  @base_type
end

#description ⇒ String

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

Returns:

  • (String) 


3239
3240
3241
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3239

def description
  @description
end

#enum_values ⇒ Array<String>

If specified, lists all the possible values for this entity. Corresponds to the JSON property enumValues

Returns:

  • (Array<String>) 


3244
3245
3246
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3244

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) 


3250
3251
3252
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3250

def occurrence_type
  @occurrence_type
end

#properties ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1SchemaEntityType>

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:



3259
3260
3261
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3259

def properties
  @properties
end

#source ⇒ String

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

Returns:

  • (String) 


3264
3265
3266
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3264

def source
  @source
end

#type ⇒ String

Name of the type. It must satisfy the following constraints: 1. Must be unique within the set of same level types (with case-insensitive match). 2. Maximum 50 characters. 3. Must start with a letter. 4. Allowed characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation characters: * underscore '_' (recommended) * hyphen '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace characters are not allowed. 5. Cannot end with a punctuation character. 6. Cannot contain the following restricted strings: "google", "DocumentAI" (case- insensitive match). 7. A slash character '/' is reserved as a separator in flattened representations of nested entity types (e.g., "line_item/amount") in which case each part (e.g., "line_item", "amount") must comply with the rules defined above. We recommend using the snake case ("snake_case") in entity type names. Corresponds to the JSON property type

Returns:

  • (String) 


3281
3282
3283
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3281

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3288
3289
3290
3291
3292
3293
3294
3295
3296
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3288

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