Reference documentation and code samples for the Google Cloud Document Ai V1 Client class 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.
Generated from protobuf message google.cloud.documentai.v1.DocumentSchema.EntityType
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ enum_values
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.
↳ display_name
string
User defined name for the type.
↳ name
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.
↳ base_types
array
The entity type that this type is derived from. For now, one and only one should be set.
↳ properties
array< Google\Cloud\DocumentAI\V1\DocumentSchema\EntityType\Property
>
Describing the nested structure, or composition of an entity.
getEnumValues
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.
Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema.EntityType.EnumValues enum_values = 14;
hasEnumValues
setEnumValues
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.
Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema.EntityType.EnumValues enum_values = 14;
$this
getDisplayName
User defined name for the type.
Generated from protobuf field string display_name = 13;
string
setDisplayName
User defined name for the type.
Generated from protobuf field string display_name = 13;
var
string
$this
getName
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 exampleline_item/amount. This convention is deprecated, but will still be honored for backward compatibility.
Generated from protobuf field string name = 1;
string
setName
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 exampleline_item/amount. This convention is deprecated, but will still be honored for backward compatibility.
Generated from protobuf field string name = 1;
var
string
$this
getBaseTypes
The entity type that this type is derived from. For now, one and only one should be set.
Generated from protobuf field repeated string base_types = 2;
Google\Protobuf\Internal\RepeatedField
setBaseTypes
The entity type that this type is derived from. For now, one and only one should be set.
Generated from protobuf field repeated string base_types = 2;
var
string[]
$this
getProperties
Describing the nested structure, or composition of an entity.
Generated from protobuf field repeated .google.cloud.documentai.v1.DocumentSchema.EntityType.Property properties = 6;
Google\Protobuf\Internal\RepeatedField
setProperties
Describing the nested structure, or composition of an entity.
Generated from protobuf field repeated .google.cloud.documentai.v1.DocumentSchema.EntityType.Property properties = 6;
$this
getValueSource
string
