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

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

A detected token.

Generated from protobuf message google.cloud.documentai.v1.Document.Page.Token

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ layout`	`Google\Cloud\DocumentAI\V1\Document\Page\Layout` Layout for Token.
`↳ detected_break`	`Google\Cloud\DocumentAI\V1\Document\Page\Token\DetectedBreak` Detected break at the end of a Token.
`↳ detected_languages`	`array<Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>` A list of detected languages together with confidence.
`↳ provenance`	`Google\Cloud\DocumentAI\V1\Document\Provenance` The history of this annotation.

getLayout

Layout for Token.

Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1;

Returns
Type	Description
`Google\Cloud\DocumentAI\V1\Document\Page\Layout\|null`

hasLayout

clearLayout

setLayout

Layout for Token.

Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1;

Parameter
Name	Description
`var`	`Google\Cloud\DocumentAI\V1\Document\Page\Layout`

Returns
Type	Description
`$this`

getDetectedBreak

Detected break at the end of a Token.

Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Token.DetectedBreak detected_break = 2;

Returns
Type	Description
`Google\Cloud\DocumentAI\V1\Document\Page\Token\DetectedBreak\|null`

hasDetectedBreak

clearDetectedBreak

setDetectedBreak

Detected break at the end of a Token.

Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Token.DetectedBreak detected_break = 2;

Parameter
Name	Description
`var`	`Google\Cloud\DocumentAI\V1\Document\Page\Token\DetectedBreak`

Returns
Type	Description
`$this`

getDetectedLanguages

A list of detected languages together with confidence.

Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDetectedLanguages

A list of detected languages together with confidence.

Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameter
Name	Description
`var`	`array<Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>`

Returns
Type	Description
`$this`

getProvenance

The history of this annotation.

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

Returns
Type	Description
`Google\Cloud\DocumentAI\V1\Document\Provenance\|null`

hasProvenance

clearProvenance

setProvenance

The history of this annotation.

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

Parameter
Name	Description
`var`	`Google\Cloud\DocumentAI\V1\Document\Provenance`

Returns
Type	Description
`$this`