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

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ field_name Google\Cloud\DocumentAI\V1\Document\Page\Layout

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

↳ field_value Google\Cloud\DocumentAI\V1\Document\Page\Layout

Layout for the FormField value.

↳ name_detected_languages array<Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>

A list of detected languages for name together with confidence.

↳ value_detected_languages array<Google\Cloud\DocumentAI\V1\Document\Page\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.

hasFieldName

clearFieldName

setFieldName

Layout for the FormField name.

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

Returns
TypeDescription
$this

getFieldValue

Layout for the FormField value.

hasFieldValue

clearFieldValue

setFieldValue

Layout for the FormField value.

Returns
TypeDescription
$this

getNameDetectedLanguages

A list of detected languages for name together with confidence.

setNameDetectedLanguages

A list of detected languages for name together with confidence.

Returns
TypeDescription
$this

getValueDetectedLanguages

A list of detected languages for value together with confidence.

setValueDetectedLanguages

A list of detected languages for value together with confidence.

Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getProvenance

The history of this annotation.

hasProvenance

clearProvenance

setProvenance

The history of this annotation.

Returns
TypeDescription
$this