Cloud Document AI v1beta3 API - Class DocumentSchema.Types.EntityType (2.0.0-beta03)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class EntityType : IMessage<DocumentSchema.Types.EntityType>, IEquatable<DocumentSchema.Types.EntityType>, IDeepCloneable<DocumentSchema.Types.EntityType>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Document AI v1beta3 API class DocumentSchema.Types.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.

Inheritance

Object > DocumentSchema.Types.EntityType

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Constructors

EntityType()

public EntityType()

EntityType(DocumentSchema.Types.EntityType)

public EntityType(DocumentSchema.Types.EntityType other)
Parameter
NameDescription
otherDocumentSchema.Types.EntityType

Properties

BaseTypes

public RepeatedField<string> BaseTypes { get; }

The entity type that this type is derived from. For now, one and only one should be set.

Property Value
TypeDescription
RepeatedField<String>

DisplayName

public string DisplayName { get; set; }

User defined name for the type.

Property Value
TypeDescription
String

EnumValues

public DocumentSchema.Types.EntityType.Types.EnumValues EnumValues { get; set; }

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.

Property Value
TypeDescription
DocumentSchema.Types.EntityType.Types.EnumValues

Name

public string Name { get; set; }

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.
Property Value
TypeDescription
String

Properties

public RepeatedField<DocumentSchema.Types.EntityType.Types.Property> Properties { get; }

Describing the nested structure, or composition of an entity.

Property Value
TypeDescription
RepeatedField<DocumentSchema.Types.EntityType.Types.Property>

ValueSourceCase

public DocumentSchema.Types.EntityType.ValueSourceOneofCase ValueSourceCase { get; }
Property Value
TypeDescription
DocumentSchema.Types.EntityType.ValueSourceOneofCase