GoogleCloudDocumentaiV1DocumentEntity

AI Overview😉

  • The potential purpose of this module is to identify and extract specific entities from a document, such as names, locations, and organizations, and to provide additional information about these entities, such as their type, confidence level, and provenance.
  • This module could impact search results by allowing Google to better understand the content of a document and to provide more accurate and relevant search results. For example, if a user searches for a specific person or organization, this module could help Google to identify and rank documents that mention that entity more highly. Additionally, this module could be used to improve the quality of search results by filtering out documents that do not contain relevant entities.
  • A website may change things to be more favorable for this function by ensuring that their content is well-structured and easy to parse, using schema markup to identify and provide additional information about entities mentioned on the page, and by using clear and consistent language to refer to entities. Additionally, websites could provide additional context and information about entities mentioned on the page, such as links to relevant pages or additional resources, to help Google to better understand the content and to improve the accuracy of search results.

Interesting Module? Vote 👇

Voting helps other researchers find interesting modules.

Current Votes: 0

GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentEntity (google_api_content_warehouse v0.4.0)

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(), 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 of the entity e.g. 1600 Amphitheatre Pkwy.
  • normalizedValue (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentEntityNormalizedValue.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.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentPageAnchor.t, default: nil) - Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
  • properties (type: list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentEntity.t), default: nil) - Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
  • provenance (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentProvenance.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.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentTextAnchor.t, default: nil) - Optional. Provenance of the entity. Text anchor indexing into the Document.text.
  • type (type: String.t, default: nil) - Required. Entity type from a schema e.g. Address.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

Link to this type

t()

@type t() ::
  %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentEntity{
    confidence: number() | nil,
    id: String.t() | nil,
    mentionId: String.t() | nil,
    mentionText: String.t() | nil,
    normalizedValue:
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentEntityNormalizedValue.t()
      | nil,
    pageAnchor:
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentPageAnchor.t()
      | nil,
    properties: [t()] | nil,
    provenance:
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentProvenance.t()
      | nil,
    redacted: boolean() | nil,
    textAnchor:
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentTextAnchor.t()
      | nil,
    type: String.t() | nil
  }

Functions

Link to this function

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.