Google Cloud Document Ai V1 Client - Class FormField (2.5.0)

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

A form field detected on the page.

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

Namespace

Google \ Cloud \ DocumentAI \ V1 \ Document \ Page

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ field_name Layout

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.
↳ field_value Layout

Layout for the FormField value.
↳ name_detected_languages array<DetectedLanguage>

A list of detected languages for name together with confidence.
↳ value_detected_languages array<DetectedLanguage>

A list of detected languages for value together with confidence.
↳ value_type string

If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - unfilled_checkbox - filled_checkbox
↳ corrected_key_text string

Created for Labeling UI to export key text. If corrections were made to the text identified by the field_name.text_anchor, this field will contain the correction.
↳ corrected_value_text string

Created for Labeling UI to export value text. If corrections were made to the text identified by the field_value.text_anchor, this field will contain the correction.
↳ provenance Google\Cloud\DocumentAI\V1\Document\Provenance

The history of this annotation.

getFieldName

Layout for the FormField name.

e.g. Address, Email, Grand total, Phone number, etc.

Returns
Type Description
Layout|null

hasFieldName

clearFieldName

setFieldName

Layout for the FormField name.

e.g. Address, Email, Grand total, Phone number, etc.

Parameter
Name Description
var Layout
Returns
Type Description
$this

getFieldValue

Layout for the FormField value.

Returns
Type Description
Layout|null

hasFieldValue

clearFieldValue

setFieldValue

Layout for the FormField value.

Parameter
Name Description
var Layout
Returns
Type Description
$this

getNameDetectedLanguages

A list of detected languages for name together with confidence.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setNameDetectedLanguages

A list of detected languages for name together with confidence.

Parameter
Name Description
var array<DetectedLanguage>
Returns
Type Description
$this

getValueDetectedLanguages

A list of detected languages for value together with confidence.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setValueDetectedLanguages

A list of detected languages for value together with confidence.

Parameter
Name Description
var array<DetectedLanguage>
Returns
Type Description
$this

getValueType

If the value is non-textual, this field represents the type. Current valid values are:

  • blank (this indicates the field_value is normal text)
  • unfilled_checkbox
  • filled_checkbox
Returns
Type Description
string

setValueType

If the value is non-textual, this field represents the type. Current valid values are:

  • blank (this indicates the field_value is normal text)
  • unfilled_checkbox
  • filled_checkbox
Parameter
Name Description
var string
Returns
Type Description
$this

getCorrectedKeyText

Created for Labeling UI to export key text.

If corrections were made to the text identified by the field_name.text_anchor, this field will contain the correction.

Returns
Type Description
string

setCorrectedKeyText

Created for Labeling UI to export key text.

If corrections were made to the text identified by the field_name.text_anchor, this field will contain the correction.

Parameter
Name Description
var string
Returns
Type Description
$this

getCorrectedValueText

Created for Labeling UI to export value text.

If corrections were made to the text identified by the field_value.text_anchor, this field will contain the correction.

Returns
Type Description
string

setCorrectedValueText

Created for Labeling UI to export value text.

If corrections were made to the text identified by the field_value.text_anchor, this field will contain the correction.

Parameter
Name Description
var string
Returns
Type Description
$this

getProvenance

The history of this annotation.

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

hasProvenance

clearProvenance

setProvenance

The history of this annotation.

Parameter
Name Description
var Google\Cloud\DocumentAI\V1\Document\Provenance
Returns
Type Description
$this