- 2.47.0 (latest)
- 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 static final class FormExtractionParams.Builder extends GeneratedMessageV3.Builder<FormExtractionParams.Builder> implements FormExtractionParamsOrBuilderParameters to control form extraction behavior.
Protobuf type google.cloud.documentai.v1beta1.FormExtractionParams
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > FormExtractionParams.BuilderImplements
FormExtractionParamsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllKeyValuePairHints(Iterable<? extends KeyValuePairHint> values)
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.documentai.v1beta1.KeyValuePairHint> |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
addKeyValuePairHints(KeyValuePairHint value)
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
KeyValuePairHint |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
addKeyValuePairHints(KeyValuePairHint.Builder builderForValue)
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
KeyValuePairHint.Builder |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
addKeyValuePairHints(int index, KeyValuePairHint value)
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
KeyValuePairHint |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
addKeyValuePairHints(int index, KeyValuePairHint.Builder builderForValue)
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
KeyValuePairHint.Builder |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
addKeyValuePairHintsBuilder()
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Returns | |
|---|---|
| Type | Description |
KeyValuePairHint.Builder |
|
addKeyValuePairHintsBuilder(int index)
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
KeyValuePairHint.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public FormExtractionParams.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
build()
public FormExtractionParams build()| Returns | |
|---|---|
| Type | Description |
FormExtractionParams |
|
buildPartial()
public FormExtractionParams buildPartial()| Returns | |
|---|---|
| Type | Description |
FormExtractionParams |
|
clear()
public FormExtractionParams.Builder clear()| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
clearEnabled()
public FormExtractionParams.Builder clearEnabled()Whether to enable form extraction.
bool enabled = 1;
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public FormExtractionParams.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
clearKeyValuePairHints()
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
clearModelVersion()
public FormExtractionParams.Builder clearModelVersion()Model version of the form extraction system. Default is "builtin/stable". Specify "builtin/latest" for the latest model.
string model_version = 3;
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public FormExtractionParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
clone()
public FormExtractionParams.Builder clone()| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
getDefaultInstanceForType()
public FormExtractionParams getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
FormExtractionParams |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEnabled()
public boolean getEnabled()Whether to enable form extraction.
bool enabled = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
The enabled. |
getKeyValuePairHints(int index)
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
KeyValuePairHint |
|
getKeyValuePairHintsBuilder(int index)
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
KeyValuePairHint.Builder |
|
getKeyValuePairHintsBuilderList()
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getKeyValuePairHintsCount()
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
getKeyValuePairHintsList()
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Returns | |
|---|---|
| Type | Description |
List<KeyValuePairHint> |
|
getKeyValuePairHintsOrBuilder(int index)
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
KeyValuePairHintOrBuilder |
|
getKeyValuePairHintsOrBuilderList()
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.documentai.v1beta1.KeyValuePairHintOrBuilder> |
|
getModelVersion()
public String getModelVersion()Model version of the form extraction system. Default is "builtin/stable". Specify "builtin/latest" for the latest model.
string model_version = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The modelVersion. |
getModelVersionBytes()
public ByteString getModelVersionBytes()Model version of the form extraction system. Default is "builtin/stable". Specify "builtin/latest" for the latest model.
string model_version = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for modelVersion. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(FormExtractionParams other)
public FormExtractionParams.Builder mergeFrom(FormExtractionParams other)| Parameter | |
|---|---|
| Name | Description |
other |
FormExtractionParams |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public FormExtractionParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public FormExtractionParams.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final FormExtractionParams.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
removeKeyValuePairHints(int index)
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
setEnabled(boolean value)
public FormExtractionParams.Builder setEnabled(boolean value)Whether to enable form extraction.
bool enabled = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe enabled to set. |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public FormExtractionParams.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
setKeyValuePairHints(int index, KeyValuePairHint value)
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
KeyValuePairHint |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
setKeyValuePairHints(int index, KeyValuePairHint.Builder builderForValue)
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.v1beta1.KeyValuePairHint key_value_pair_hints = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
KeyValuePairHint.Builder |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
setModelVersion(String value)
public FormExtractionParams.Builder setModelVersion(String value)Model version of the form extraction system. Default is "builtin/stable". Specify "builtin/latest" for the latest model.
string model_version = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe modelVersion to set. |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
This builder for chaining. |
setModelVersionBytes(ByteString value)
public FormExtractionParams.Builder setModelVersionBytes(ByteString value)Model version of the form extraction system. Default is "builtin/stable". Specify "builtin/latest" for the latest model.
string model_version = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for modelVersion to set. |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public FormExtractionParams.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final FormExtractionParams.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
FormExtractionParams.Builder |
|