Class FormExtractionParams

Parameters to control form extraction behavior.

Inheritance

System.Object

FormExtractionParams

Implements

IMessage<FormExtractionParams>

System.IEquatable<FormExtractionParams>

IDeepCloneable<FormExtractionParams>

Google.Protobuf.IBufferMessage

IMessage

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 FormExtractionParams : IMessage<FormExtractionParams>, IEquatable<FormExtractionParams>, IDeepCloneable<FormExtractionParams>, IBufferMessage, IMessage

Constructors

FormExtractionParams()

Declaration

public FormExtractionParams()

FormExtractionParams(FormExtractionParams)

Declaration

public FormExtractionParams(FormExtractionParams other)

Parameters

Type	Name	Description
FormExtractionParams	other

Properties

Enabled

Whether to enable form extraction.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

KeyValuePairHints

User can provide pairs of (key text, value type) to improve the parsing result.

For example, if a document has a field called "Date" that holds a date value and a field called "Amount" that may hold either a currency value (e.g., "$500.00") or a simple number value (e.g., "20"), you could use the following hints: [ {"key": "Date", value_types: [ "DATE"]}, {"key": "Amount", "value_types": [ "PRICE", "NUMBER" ]} ]

If the value type is unknown, but you want to provide hints for the keys, you can leave the value_types field blank. e.g. {"key": "Date", "value_types": []}

Declaration

public RepeatedField<KeyValuePairHint> KeyValuePairHints { get; }

Property Value

Type	Description
RepeatedField<KeyValuePairHint>

ModelVersion

Model version of the form extraction system. Default is "builtin/stable". Specify "builtin/latest" for the latest model. For custom form models, specify: “custom/{model_name}". Model name format is "bucket_name/path/to/modeldir" corresponding to "gs://bucket_name/path/to/modeldir" where annotated examples are stored.

Declaration

public string ModelVersion { get; set; }

Property Value

Type	Description
System.String