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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ text_anchor |
TextAnchor
Optional. Provenance of the entity. Text anchor indexing into the Document.text. |
↳ type |
string
Required. Entity type from a schema e.g. |
↳ mention_text |
string
Optional. Text value of the entity e.g. |
↳ mention_id |
string
Optional. Deprecated. Use |
↳ confidence |
float
Optional. Confidence of detected Schema entity. Range |
↳ page_anchor |
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 |
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<Entity>
Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. |
↳ provenance |
Provenance
Optional. The history of this annotation. |
↳ 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.
| Returns | |
|---|---|
| Type | Description |
TextAnchor|null |
|
hasTextAnchor
clearTextAnchor
setTextAnchor
Optional. Provenance of the entity.
Text anchor indexing into the Document.text.
| Parameter | |
|---|---|
| Name | Description |
var |
TextAnchor
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Required. Entity type from a schema e.g. Address.
| Returns | |
|---|---|
| Type | Description |
string |
|
setType
Required. Entity type from a schema e.g. Address.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMentionText
Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMentionText
Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMentionId
Optional. Deprecated. Use id field instead.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMentionId
Optional. Deprecated. Use id field instead.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConfidence
Optional. Confidence of detected Schema entity. Range [0, 1].
| Returns | |
|---|---|
| Type | Description |
float |
|
setConfidence
Optional. Confidence of detected Schema entity. Range [0, 1].
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageAnchor
Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
| Returns | |
|---|---|
| Type | Description |
PageAnchor|null |
|
hasPageAnchor
clearPageAnchor
setPageAnchor
Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
| Parameter | |
|---|---|
| Name | Description |
var |
PageAnchor
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getId
Optional. Canonical id. This will be a unique value in the entity list for this document.
| Returns | |
|---|---|
| Type | Description |
string |
|
setId
Optional. Canonical id. This will be a unique value in the entity list for this document.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Entity\NormalizedValue|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Entity\NormalizedValue
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProperties
Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setProperties
Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Entity>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProvenance
Optional. The history of this annotation.
| Returns | |
|---|---|
| Type | Description |
Provenance|null |
|
hasProvenance
clearProvenance
setProvenance
Optional. The history of this annotation.
| Parameter | |
|---|---|
| Name | Description |
var |
Provenance
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRedacted
Optional. Whether the entity will be redacted for de-identification purposes.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRedacted
Optional. Whether the entity will be redacted for de-identification purposes.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|