Class FormExtractionParams (2.26.0)
2.91.0 (latest)
2.89.0
2.87.0
2.86.0
2.85.0
2.84.0
2.82.0
2.80.0
2.79.0
2.78.0
2.77.0
2.76.0
2.74.0
2.72.0
2.71.0
2.68.0
2.67.0
2.66.0
2.64.0
2.63.0
2.62.0
2.61.0
2.60.0
2.59.0
2.58.0
2.57.0
2.56.0
2.55.0
2.53.0
2.52.0
2.51.0
2.50.0
2.49.0
2.48.0
2.47.0
2.46.0
2.45.0
2.44.0
2.43.0
2.41.0
2.40.0
2.39.0
2.38.0
2.37.0
2.36.0
2.35.0
2.34.0
2.33.0
2.32.0
2.31.0
2.28.0
2.27.0
2.26.0
2.25.0
2.24.0
2.23.0
2.22.0
2.21.0
2.20.0
2.19.0
2.18.0
2.17.0
2.16.0
2.15.0
2.13.0
2.12.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.5
2.6.2
2.5.1
2.4.3
2.3.1
2.2.1
2.1.9
public final class FormExtractionParams extends GeneratedMessageV3 implements FormExtractionParamsOrBuilder
Parameters to control form extraction behavior.
Protobuf type google.cloud.documentai.v1beta2.FormExtractionParams
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int
public static final int KEY_VALUE_PAIR_HINTS_FIELD_NUMBER
Field Value
Type Description
int
public static final int MODEL_VERSION_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static FormExtractionParams getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static FormExtractionParams . Builder newBuilder ()
public static FormExtractionParams . Builder newBuilder ( FormExtractionParams prototype )
public static FormExtractionParams parseDelimitedFrom ( InputStream input )
public static FormExtractionParams parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static FormExtractionParams parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static FormExtractionParams parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static FormExtractionParams parseFrom ( ByteString data )
public static FormExtractionParams parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static FormExtractionParams parseFrom ( CodedInputStream input )
public static FormExtractionParams parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static FormExtractionParams parseFrom ( InputStream input )
public static FormExtractionParams parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static FormExtractionParams parseFrom ( ByteBuffer data )
public static FormExtractionParams parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<FormExtractionParams> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public FormExtractionParams getDefaultInstanceForType ()
public boolean getEnabled ()
Whether to enable form extraction.
bool enabled = 1;
Returns
Type Description
boolean The enabled.
public KeyValuePairHint getKeyValuePairHints ( int index )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
Parameter
Name Description
indexint
public int getKeyValuePairHintsCount ()
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
Returns
Type Description
int
public List<KeyValuePairHint> getKeyValuePairHintsList ()
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
public KeyValuePairHintOrBuilder getKeyValuePairHintsOrBuilder ( int index )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
Parameter
Name Description
indexint
public List <? extends KeyValuePairHintOrBuilder > getKeyValuePairHintsOrBuilderList ()
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
Returns
Type Description
List <? extends com.google.cloud.documentai.v1beta2.KeyValuePairHintOrBuilder >
public String getModelVersion ()
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.
string model_version = 3;
Returns
Type Description
String The modelVersion.
public ByteString getModelVersionBytes ()
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.
string model_version = 3;
Returns
Type Description
ByteString The bytes for modelVersion.
public Parser<FormExtractionParams> getParserForType ()
Overrides
public int getSerializedSize ()
Returns
Type Description
int
Overrides
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public FormExtractionParams . Builder newBuilderForType ()
protected FormExtractionParams . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public FormExtractionParams . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
