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.
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
↳ 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
getFieldName
Layout
for the FormField
name. e.g. Address
, Email
, Grand total
, Phone number
, etc.
Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout field_name = 1;
hasFieldName
clearFieldName
setFieldName
Layout
for the FormField
name. e.g. Address
, Email
, Grand total
, Phone number
, etc.
Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout field_name = 1;
$this
getFieldValue
Layout for the FormField value.
Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout field_value = 2;
hasFieldValue
clearFieldValue
setFieldValue
Layout for the FormField value.
Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout field_value = 2;
$this
getNameDetectedLanguages
A list of detected languages for name together with confidence.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage name_detected_languages = 3;
Google\Protobuf\Internal\RepeatedField
setNameDetectedLanguages
A list of detected languages for name together with confidence.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage name_detected_languages = 3;
$this
getValueDetectedLanguages
A list of detected languages for value together with confidence.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;
Google\Protobuf\Internal\RepeatedField
setValueDetectedLanguages
A list of detected languages for value together with confidence.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;
$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"
Generated from protobuf field string value_type = 5;
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"
Generated from protobuf field string value_type = 5;
var
string
$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.
Generated from protobuf field string corrected_key_text = 6;
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.
Generated from protobuf field string corrected_key_text = 6;
var
string
$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.
Generated from protobuf field string corrected_value_text = 7;
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.
Generated from protobuf field string corrected_value_text = 7;
var
string
$this
getProvenance
The history of this annotation.
Generated from protobuf field .google.cloud.documentai.v1.Document.Provenance provenance = 8;
hasProvenance
clearProvenance
setProvenance
The history of this annotation.
Generated from protobuf field .google.cloud.documentai.v1.Document.Provenance provenance = 8;
$this
