GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiV1beta3SchemaEntityType (google_api_document_ai v0.30.0) 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
-
baseType
(type:String.t
, default:nil
) - Type of the entity. It must be one of the following:document
- the entity represents a classification of a logical document.object
- if the entity has properties it is likely an object (or or a document.)datetime
- the entity is a date or time value.money
- the entity represents a money value amount.number
- the entity is a number - integer or floating point.string
- the entity is a string value.boolean
- the entity is a boolean value.address
- the entity is a location address.duration
- the entity is a duration. -
description
(type:String.t
, default:nil
) - Description of the entity type. -
enumValues
(type:list(String.t)
, default:nil
) - If specified, lists all the possible values for this entity. -
occurrenceType
(type:String.t
, default:nil
) - Occurrence type limits the number of times an entity type appears in the document. -
properties
(type:list(GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiV1beta3SchemaEntityType.t)
, default:nil
) - 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
, default:nil
) - Source of this entity type. -
type
(type:String.t
, default:nil
) - 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 50 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.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Specs
t() :: %GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiV1beta3SchemaEntityType{ baseType: String.t() | nil, description: String.t() | nil, enumValues: [String.t()] | nil, occurrenceType: String.t() | nil, properties: [ GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiV1beta3SchemaEntityType.t() ] | nil, source: String.t() | nil, type: String.t() | nil }
Link to this section Functions
Specs
Unwrap a decoded JSON object into its complex fields.