Class GoogleCloudDocumentaiUiv1beta3SchemaEntityType

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

GoogleCloudDocumentaiUiv1beta3SchemaEntityType

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Document.v1beta3.Data

Assembly: Google.Apis.Document.v1beta3.dll

Syntax

public class GoogleCloudDocumentaiUiv1beta3SchemaEntityType : IDirectResponseSchema

Properties

BaseType

Declaration

[JsonProperty("baseType")]
public virtual string BaseType { get; set; }

Property Value

Type	Description
string

Description

Description of the entity type.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EnumValues

If specified, lists all the possible values for this entity.

Declaration

[JsonProperty("enumValues")]
public virtual IList<string> EnumValues { get; set; }

Property Value

Type	Description
IList<string>

Hide

If the entity type is hidden in the schema. This provides the functionality to temporally "disable" an entity without deleting it.

Declaration

[JsonProperty("hide")]
public virtual bool? Hide { get; set; }

Property Value

Type	Description
bool?

Method

Specifies how the entity's value is obtained.

Declaration

[JsonProperty("method")]
public virtual string Method { get; set; }

Property Value

Type	Description
string

OccurrenceType

Occurrence type limits the number of times an entity type appears in the document.

Declaration

[JsonProperty("occurrenceType")]
public virtual string OccurrenceType { get; set; }

Property Value

Type	Description
string

Properties

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.

Declaration

[JsonProperty("properties")]
public virtual IList<GoogleCloudDocumentaiUiv1beta3SchemaEntityType> Properties { get; set; }

Property Value

Type	Description
IList<GoogleCloudDocumentaiUiv1beta3SchemaEntityType>

Source

Source of this entity type.

Declaration

[JsonProperty("source")]
public virtual string Source { get; set; }

Property Value

Type	Description
string

Type

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 64 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.

Declaration

[JsonProperty("type")]
public virtual string Type { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema