View Source GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentEntity (google_api_document_ai v0.32.2)

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.


  • confidence (type: number(), default: nil) - Optional. Confidence of detected Schema entity. Range [0, 1].
  • id (type: String.t, default: nil) - Optional. Canonical id. This will be a unique value in the entity list for this document.
  • mentionId (type: String.t, default: nil) - Optional. Deprecated. Use id field instead.
  • mentionText (type: String.t, default: nil) - Optional. Text value in the document e.g. 1600 Amphitheatre Pkwy. If the entity is not present in the document, this field will be empty.
  • normalizedValue (type: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue.t, default: nil) - Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
  • pageAnchor (type: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageAnchor.t, default: nil) - Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
  • properties (type: list(GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentEntity.t), default: nil) - Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
  • provenance (type: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentProvenance.t, default: nil) - Optional. The history of this annotation.
  • redacted (type: boolean(), default: nil) - Optional. Whether the entity will be redacted for de-identification purposes.
  • textAnchor (type: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentTextAnchor.t, default: nil) - Optional. Provenance of the entity. Text anchor indexing into the Document.text.
  • type (type: String.t, default: nil) - Entity type from a schema e.g. Address.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() ::
    confidence: number() | nil,
    id: String.t() | nil,
    mentionId: String.t() | nil,
    mentionText: String.t() | nil,
      | nil,
      | nil,
      | nil,
      | nil,
    redacted: boolean() | nil,
      | nil,
    type: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.