public static final class FormExtractionParams.Builder extends GeneratedMessageV3.Builder<FormExtractionParams.Builder> implements FormExtractionParamsOrBuilder
Parameters to control form extraction behavior.
Protobuf type google.cloud.documentai.v1beta2.FormExtractionParams
Methods
public FormExtractionParams.Builder addAllKeyValuePairHints(Iterable<? extends KeyValuePairHint> values)
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;
| Name | Description |
| values | Iterable<? extends com.google.cloud.documentai.v1beta2.KeyValuePairHint>
|
Returns
public FormExtractionParams.Builder addKeyValuePairHints(KeyValuePairHint value)
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;
public FormExtractionParams.Builder addKeyValuePairHints(KeyValuePairHint.Builder builderForValue)
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;
public FormExtractionParams.Builder addKeyValuePairHints(int index, KeyValuePairHint value)
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;
public FormExtractionParams.Builder addKeyValuePairHints(int index, KeyValuePairHint.Builder builderForValue)
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;
public KeyValuePairHint.Builder addKeyValuePairHintsBuilder()
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;
public KeyValuePairHint.Builder addKeyValuePairHintsBuilder(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;
public FormExtractionParams.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public FormExtractionParams build()
Returns
public FormExtractionParams buildPartial()
Returns
public FormExtractionParams.Builder clear()
Returns
Overrides
public FormExtractionParams.Builder clearEnabled()
Whether to enable form extraction.
bool enabled = 1;
public FormExtractionParams.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
public FormExtractionParams.Builder clearKeyValuePairHints()
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;
public FormExtractionParams.Builder clearModelVersion()
Model version of the form extraction system. Default is
"builtin/stable". Specify "builtin/latest" for the latest model.
For custom form models, specify: \u201ccustom/{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;
public FormExtractionParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
public FormExtractionParams.Builder clone()
Returns
Overrides
public FormExtractionParams getDefaultInstanceForType()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
public boolean getEnabled()
Whether to enable form extraction.
bool enabled = 1;
public 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;
public KeyValuePairHint.Builder getKeyValuePairHintsBuilder(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;
public List<KeyValuePairHint.Builder> getKeyValuePairHintsBuilderList()
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;
public 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;
public 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;
public 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;
public 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;
| 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: \u201ccustom/{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;
| 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: \u201ccustom/{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;
| Type | Description |
| ByteString | The bytes for modelVersion.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public FormExtractionParams.Builder mergeFrom(FormExtractionParams other)
Parameter
Returns
public FormExtractionParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
public FormExtractionParams.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
public final FormExtractionParams.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
public FormExtractionParams.Builder removeKeyValuePairHints(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;
public FormExtractionParams.Builder setEnabled(boolean value)
Whether to enable form extraction.
bool enabled = 1;
| Name | Description |
| value | boolean
The enabled to set.
|
Returns
public FormExtractionParams.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public FormExtractionParams.Builder setKeyValuePairHints(int index, KeyValuePairHint value)
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;
public FormExtractionParams.Builder setKeyValuePairHints(int index, KeyValuePairHint.Builder builderForValue)
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;
public FormExtractionParams.Builder setModelVersion(String value)
Model version of the form extraction system. Default is
"builtin/stable". Specify "builtin/latest" for the latest model.
For custom form models, specify: \u201ccustom/{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;
| Name | Description |
| value | String
The modelVersion to set.
|
Returns
public FormExtractionParams.Builder setModelVersionBytes(ByteString value)
Model version of the form extraction system. Default is
"builtin/stable". Specify "builtin/latest" for the latest model.
For custom form models, specify: \u201ccustom/{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;
| Name | Description |
| value | ByteString
The bytes for modelVersion to set.
|
Returns
public FormExtractionParams.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
public final FormExtractionParams.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
