Class GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType

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

GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType

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 GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType : IDirectResponseSchema

Properties

BaseTypes

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

Declaration

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

Property Value

Type	Description
IList<string>

Description

The description of the entity type. Could be used to provide more information about the entity type for model calls.

Declaration

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

Property Value

Type	Description
string

DisplayName

User defined name for the type.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { 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

EntityTypeMetadata

Metadata for the entity type.

Declaration

[JsonProperty("entityTypeMetadata")]
public virtual GoogleCloudDocumentaiV1beta3EntityTypeMetadata EntityTypeMetadata { get; set; }

Property Value

Type	Description
GoogleCloudDocumentaiV1beta3EntityTypeMetadata

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.

Declaration

[JsonProperty("enumValues")]
public virtual GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues EnumValues { get; set; }

Property Value

Type	Description
GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues

Name

Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use snake_casing. - Name matching is case-sensitive. - 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.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Properties

Description the nested structure, or composition of an entity.

Declaration

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

Property Value

Type	Description
IList<GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty>

Implements

IDirectResponseSchema