Google Cloud Document Ai V1 Client - Class TextChange (1.0.1)

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class TextChange.

This message is used for text changes aka. OCR corrections.

Generated from protobuf message google.cloud.documentai.v1.Document.TextChange

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ text_anchor Google\Cloud\DocumentAI\V1\Document\TextAnchor

Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single TextAnchor.text_segments element. If the start and end index of the text segment are the same, the text change is inserted before that index.

↳ changed_text string

The text that replaces the text identified in the text_anchor.

↳ provenance array<Google\Cloud\DocumentAI\V1\Document\Provenance>

The history of this annotation.

getTextAnchor

Provenance of the correction.

Text anchor indexing into the Document.text. There can only be a single TextAnchor.text_segments element. If the start and end index of the text segment are the same, the text change is inserted before that index.

Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1;

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\Document\TextAnchor|null

hasTextAnchor

clearTextAnchor

setTextAnchor

Provenance of the correction.

Text anchor indexing into the Document.text. There can only be a single TextAnchor.text_segments element. If the start and end index of the text segment are the same, the text change is inserted before that index.

Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1;

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\Document\TextAnchor
Returns
TypeDescription
$this

getChangedText

The text that replaces the text identified in the text_anchor.

Generated from protobuf field string changed_text = 2;

Returns
TypeDescription
string

setChangedText

The text that replaces the text identified in the text_anchor.

Generated from protobuf field string changed_text = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProvenance

The history of this annotation.

Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Provenance provenance = 3 [deprecated = true];

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setProvenance

The history of this annotation.

Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Provenance provenance = 3 [deprecated = true];

Parameter
NameDescription
var array<Google\Cloud\DocumentAI\V1\Document\Provenance>
Returns
TypeDescription
$this