Cloud Document AI v1 API - Class Document.Types.Page.Types.FormField (3.3.0) 

public sealed class FormField : IMessage<Document.Types.Page.Types.FormField>, IEquatable<Document.Types.Page.Types.FormField>, IDeepCloneable<Document.Types.Page.Types.FormField>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Document AI v1 API class Document.Types.Page.Types.FormField.

A form field detected on the page.

Inheritance

Object > Document.Types.Page.Types.FormField

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Constructors

FormField()

public FormField()

FormField(Document.Types.Page.Types.FormField)

public FormField(Document.Types.Page.Types.FormField other)
Parameter
NameDescription
otherDocument.Types.Page.Types.FormField

Properties

CorrectedKeyText

public string CorrectedKeyText { get; set; }

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.

Property Value
TypeDescription
String

CorrectedValueText

public string CorrectedValueText { get; set; }

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.

Property Value
TypeDescription
String

FieldName

public Document.Types.Page.Types.Layout FieldName { get; set; }

[Layout][google.cloud.documentai.v1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1.Document.Page.FormField] name. e.g. Address, Email, Grand total, Phone number, etc.

Property Value
TypeDescription
Document.Types.Page.Types.Layout

FieldValue

public Document.Types.Page.Types.Layout FieldValue { get; set; }

[Layout][google.cloud.documentai.v1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1.Document.Page.FormField] value.

Property Value
TypeDescription
Document.Types.Page.Types.Layout

NameDetectedLanguages

public RepeatedField<Document.Types.Page.Types.DetectedLanguage> NameDetectedLanguages { get; }

A list of detected languages for name together with confidence.

Property Value
TypeDescription
RepeatedField<Document.Types.Page.Types.DetectedLanguage>

Provenance

public Document.Types.Provenance Provenance { get; set; }

The history of this annotation.

Property Value
TypeDescription
Document.Types.Provenance

ValueDetectedLanguages

public RepeatedField<Document.Types.Page.Types.DetectedLanguage> ValueDetectedLanguages { get; }

A list of detected languages for value together with confidence.

Property Value
TypeDescription
RepeatedField<Document.Types.Page.Types.DetectedLanguage>

ValueType

public string ValueType { get; set; }

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
Property Value
TypeDescription
String