Document AI V1 API - Class Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType (v0.6.0)

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#base_types

def base_types() -> ::Array<::String>
Returns
  • (::Array<::String>) — The entity type that this type is derived from. For now, one and only one should be set.

#base_types=

def base_types=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The entity type that this type is derived from. For now, one and only one should be set.
Returns
  • (::Array<::String>) — The entity type that this type is derived from. For now, one and only one should be set.

#display_name

def display_name() -> ::String
Returns
  • (::String) — User defined name for the type.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — User defined name for the type.
Returns
  • (::String) — User defined name for the type.

#enum_values

def enum_values() -> ::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType::EnumValues
Returns
  • (::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType::EnumValues) — If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the EntityType.value_ontology field and specify a list of all possible values in a value ontology file.

#enum_values=

def enum_values=(value) -> ::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType::EnumValues
Parameter
  • value (::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType::EnumValues) — If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the EntityType.value_ontology field and specify a list of all possible values in a value ontology file.
Returns
  • (::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType::EnumValues) — If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the EntityType.value_ontology field and specify a list of all possible values in a value ontology file.

#name

def name() -> ::String
Returns
  • (::String) —

    Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions:

    • use snake_casing
    • name matching is case-insensitive
    • Maximum 64 characters.
    • Must start with a letter.
    • Allowed characters: ASCII letters [a-z0-9_-]. (For backward compatibility internal infrastructure and tooling can handle any ascii character)
    • The / is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) —

    Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions:

    • use snake_casing
    • name matching is case-insensitive
    • Maximum 64 characters.
    • Must start with a letter.
    • Allowed characters: ASCII letters [a-z0-9_-]. (For backward compatibility internal infrastructure and tooling can handle any ascii character)
    • The / is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.
Returns
  • (::String) —

    Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions:

    • use snake_casing
    • name matching is case-insensitive
    • Maximum 64 characters.
    • Must start with a letter.
    • Allowed characters: ASCII letters [a-z0-9_-]. (For backward compatibility internal infrastructure and tooling can handle any ascii character)
    • The / is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.

#properties

def properties() -> ::Array<::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType::Property>
Returns

#properties=

def properties=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType::Property>
Parameter
Returns