Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3SchemaEntityType (googly_document_ai v0.1.0)

Copy Markdown View Source

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.

Attributes

  • base_type (type: String.t()) -
  • description (type: String.t()) - Description of the entity type.
  • enum_values (type: list(String.t())) - If specified, lists all the possible values for this entity.
  • hide (type: boolean()) - If the entity type is hidden in the schema. This provides the functionality to temporally "disable" an entity without deleting it.
  • method (type: String.t()) - Specifies how the entity's value is obtained.
  • occurrence_type (type: String.t()) - Occurrence type limits the number of times an entity type appears in the document.
  • properties (type: list(Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3SchemaEntityType.t())) - 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.
  • source (type: String.t()) - Source of this entity type.
  • type (type: String.t()) - 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.

Summary

Types

t()

Types

t()

@type t() :: %Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3SchemaEntityType{
  base_type: String.t() | nil,
  description: String.t() | nil,
  enum_values: [String.t()] | nil,
  hide: boolean() | nil,
  method: String.t() | nil,
  occurrence_type: String.t() | nil,
  properties: [t()] | nil,
  source: String.t() | nil,
  type: String.t() | nil
}