Interface FormExtractionParamsOrBuilder (2.25.0)

Version 2.25.0

• 2.59.0 (latest)
• 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 interface FormExtractionParamsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEnabled()

public abstract boolean getEnabled()

Whether to enable form extraction.

bool enabled = 1;

Returns
Type	Description
boolean	The enabled.

getKeyValuePairHints(int index)

public abstract KeyValuePairHint getKeyValuePairHints(int index)

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": []}

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
KeyValuePairHint

getKeyValuePairHintsCount()

public abstract int getKeyValuePairHintsCount()

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": []}

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
Type	Description
int

getKeyValuePairHintsList()

public abstract List<KeyValuePairHint> getKeyValuePairHintsList()

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": []}

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
Type	Description
List<KeyValuePairHint>

getKeyValuePairHintsOrBuilder(int index)

public abstract KeyValuePairHintOrBuilder getKeyValuePairHintsOrBuilder(int index)

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": []}

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
KeyValuePairHintOrBuilder

getKeyValuePairHintsOrBuilderList()

public abstract List<? extends KeyValuePairHintOrBuilder> getKeyValuePairHintsOrBuilderList()

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": []}

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1beta2.KeyValuePairHintOrBuilder>

getModelVersion()

public abstract 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.

getModelVersionBytes()

public abstract 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.