Class Document.Types.Page.Types.FormField

A form field detected on the page.

Inheritance
System.Object
Document.Types.Page.Types.FormField
Inherited Members
System.Object.ToString()
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Cloud.DocumentAI.V1Beta2
Assembly: Google.Cloud.DocumentAI.V1Beta2.dll
Syntax
public sealed class FormField : IMessage<Document.Types.Page.Types.FormField>, IEquatable<Document.Types.Page.Types.FormField>, IDeepCloneable<Document.Types.Page.Types.FormField>, IBufferMessage, IMessage

Constructors

FormField()

Declaration
public FormField()

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

Declaration
public FormField(Document.Types.Page.Types.FormField other)
Parameters
Type Name Description
Document.Types.Page.Types.FormField other

Properties

CorrectedKeyText

An internal field, created for Labeling UI to export key text.

Declaration
public string CorrectedKeyText { get; set; }
Property Value
Type Description
System.String

CorrectedValueText

An internal field, created for Labeling UI to export value text.

Declaration
public string CorrectedValueText { get; set; }
Property Value
Type Description
System.String

FieldName

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

Declaration
public Document.Types.Page.Types.Layout FieldName { get; set; }
Property Value
Type Description
Document.Types.Page.Types.Layout

FieldValue

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

Declaration
public Document.Types.Page.Types.Layout FieldValue { get; set; }
Property Value
Type Description
Document.Types.Page.Types.Layout

NameDetectedLanguages

A list of detected languages for name together with confidence.

Declaration
public RepeatedField<Document.Types.Page.Types.DetectedLanguage> NameDetectedLanguages { get; }
Property Value
Type Description
RepeatedField<Document.Types.Page.Types.DetectedLanguage>

ValueDetectedLanguages

A list of detected languages for value together with confidence.

Declaration
public RepeatedField<Document.Types.Page.Types.DetectedLanguage> ValueDetectedLanguages { get; }
Property Value
Type Description
RepeatedField<Document.Types.Page.Types.DetectedLanguage>

ValueType

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"
Declaration
public string ValueType { get; set; }
Property Value
Type Description
System.String