class Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType

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.

Attributes

base_type[RW]

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` @return [String]

description[RW]

Description of the entity type. Corresponds to the JSON property `description` @return [String]

enum_values[RW]

If specified, lists all the possible values for this entity. Corresponds to the JSON property `enumValues` @return [Array<String>]

occurrence_type[RW]

Occurrence type limits the number of times an entity type appears in the document. Corresponds to the JSON property `occurrenceType` @return [String]

properties[RW]

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` @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType>]

source[RW]

Source of this entity type. Corresponds to the JSON property `source` @return [String]

type[RW]

Name of the type. It must be unique within the set of same level types. Corresponds to the JSON property `type` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/documentai_v1beta3/classes.rb, line 7262
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/documentai_v1beta3/classes.rb, line 7267
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