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

Copy Markdown View Source

An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.

Attributes

  • confidence (type: number()) - Optional. Confidence of detected Schema entity. Range [0, 1].
  • id (type: String.t()) - Optional. Canonical id. This will be a unique value in the entity list for this document.
  • mention_id (type: String.t()) - Optional. Deprecated. Use id field instead.
  • mention_text (type: String.t()) - Optional. Text value of the entity, for example, 1600 Amphitheatre Pkwy.
  • method (type: String.t()) - Optional. Specifies how the entity's value is obtained.
  • normalized_value (type: Googly.DocumentAI.Model.GoogleCloudDocumentaiV1DocumentEntityNormalizedValue.t()) - Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (for example, address) is not supported for certain parsers. This field is also only populated for certain supported document types.
  • page_anchor (type: Googly.DocumentAI.Model.GoogleCloudDocumentaiV1DocumentPageAnchor.t()) - Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
  • properties (type: list(Googly.DocumentAI.Model.GoogleCloudDocumentaiV1DocumentEntity.t())) - Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
  • provenance (type: Googly.DocumentAI.Model.GoogleCloudDocumentaiV1DocumentProvenance.t()) - Optional. The history of this annotation.
  • redacted (type: boolean()) - Optional. Whether the entity will be redacted for de-identification purposes.
  • text_anchor (type: Googly.DocumentAI.Model.GoogleCloudDocumentaiV1DocumentTextAnchor.t()) - Optional. Provenance of the entity. Text anchor indexing into the Document.text.
  • type (type: String.t()) - Required. Entity type from a schema, for example, Address.

Summary

Types

t()

Types

t()

@type t() :: %Googly.DocumentAI.Model.GoogleCloudDocumentaiV1DocumentEntity{
  confidence: number() | nil,
  id: String.t() | nil,
  mention_id: String.t() | nil,
  mention_text: String.t() | nil,
  method: String.t() | nil,
  normalized_value:
    Googly.DocumentAI.Model.GoogleCloudDocumentaiV1DocumentEntityNormalizedValue.t()
    | nil,
  page_anchor:
    Googly.DocumentAI.Model.GoogleCloudDocumentaiV1DocumentPageAnchor.t() | nil,
  properties: [t()] | nil,
  provenance:
    Googly.DocumentAI.Model.GoogleCloudDocumentaiV1DocumentProvenance.t() | nil,
  redacted: boolean() | nil,
  text_anchor:
    Googly.DocumentAI.Model.GoogleCloudDocumentaiV1DocumentTextAnchor.t() | nil,
  type: String.t() | nil
}