Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType (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_types (type: list(String.t())) - The entity type that this type is derived from. For now, one and only one should be set.
  • description (type: String.t()) - The description of the entity type. Could be used to provide more information about the entity type for model calls.
  • display_name (type: String.t()) - User defined name for the type.
  • entity_type_metadata (type: Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata.t()) - Metadata for the entity type.
  • enum_values (type: Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues.t()) - 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.
  • name (type: String.t()) - 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.
  • properties (type: list(Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty.t())) - Description the nested structure, or composition of an entity.

Summary

Types

t()

Types

t()

@type t() ::
  %Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType{
    base_types: [String.t()] | nil,
    description: String.t() | nil,
    display_name: String.t() | nil,
    entity_type_metadata:
      Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata.t()
      | nil,
    enum_values:
      Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues.t()
      | nil,
    name: String.t() | nil,
    properties:
      [
        Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty.t()
      ]
      | nil
  }