Reference documentation and code samples for the Google Cloud Document Ai V1 Client class Entity.
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.
Generated from protobuf message google.cloud.documentai.v1.Document.Entity
Namespace
Google \ Cloud \ DocumentAI \ V1 \ DocumentMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ text_anchor
Google\Cloud\DocumentAI\V1\Document\TextAnchor
Optional. Provenance of the entity. Text anchor indexing into the Document.text .
↳ type
string
Required. Entity type from a schema e.g. Address
.
↳ mention_text
string
Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy
.
↳ mention_id
string
Optional. Deprecated. Use id
field instead.
↳ confidence
float
Optional. Confidence of detected Schema entity. Range [0, 1]
.
↳ page_anchor
Google\Cloud\DocumentAI\V1\Document\PageAnchor
Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
↳ id
string
Optional. Canonical id. This will be a unique value in the entity list for this document.
↳ normalized_value
Google\Cloud\DocumentAI\V1\Document\Entity\NormalizedValue
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.
↳ properties
array< Google\Cloud\DocumentAI\V1\Document\Entity
>
Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
↳ provenance
↳ redacted
bool
Optional. Whether the entity will be redacted for de-identification purposes.
getTextAnchor
Optional. Provenance of the entity.
Text anchor indexing into the Document.text .
hasTextAnchor
clearTextAnchor
setTextAnchor
Optional. Provenance of the entity.
Text anchor indexing into the Document.text .
$this
getType
Required. Entity type from a schema e.g. Address
.
string
setType
Required. Entity type from a schema e.g. Address
.
var
string
$this
getMentionText
Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy
.
string
setMentionText
Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy
.
var
string
$this
getMentionId
Optional. Deprecated. Use id
field instead.
string
setMentionId
Optional. Deprecated. Use id
field instead.
var
string
$this
getConfidence
Optional. Confidence of detected Schema entity. Range [0, 1]
.
float
setConfidence
Optional. Confidence of detected Schema entity. Range [0, 1]
.
var
float
$this
getPageAnchor
Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
hasPageAnchor
clearPageAnchor
setPageAnchor
Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
$this
getId
Optional. Canonical id. This will be a unique value in the entity list for this document.
string
setId
Optional. Canonical id. This will be a unique value in the entity list for this document.
var
string
$this
getNormalizedValue
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.
hasNormalizedValue
clearNormalizedValue
setNormalizedValue
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.
$this
getProperties
Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
setProperties
Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
$this
getProvenance
Optional. The history of this annotation.
hasProvenance
clearProvenance
setProvenance
Optional. The history of this annotation.
$this
getRedacted
Optional. Whether the entity will be redacted for de-identification purposes.
bool
setRedacted
Optional. Whether the entity will be redacted for de-identification purposes.
var
bool
$this
