View Source GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1DocumentSchemaEntityType (google_api_document_ai v0.39.0)

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

baseTypes (type: list(String.t), default: nil) - The entity type that this type is derived from. For now, one and only one should be set.
displayName (type: String.t, default: nil) - User defined name for the type.
enumValues (type: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues.t, default: nil) - 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, default: nil) - 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(GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty.t), default: nil) - Description the nested structure, or composition of an entity.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1DocumentSchemaEntityType{
    baseTypes: [String.t()] | nil,
    displayName: String.t() | nil,
    enumValues:
      GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues.t()
      | nil,
    name: String.t() | nil,
    properties:
      [
        GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty.t()
      ]
      | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.