public interface FormExtractionParamsOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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. |