Class FormExtractionParams.Builder (2.4.3)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.documentai.v1beta2.KeyValuePairHint>
Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
NameDescription
valueKeyValuePairHint
Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
NameDescription
builderForValueKeyValuePairHint.Builder
Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameters
NameDescription
indexint
valueKeyValuePairHint
Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameters
NameDescription
indexint
builderForValueKeyValuePairHint.Builder
Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
KeyValuePairHint.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FormExtractionParams.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
FormExtractionParams.Builder
Overrides

build()

public FormExtractionParams build()
Returns
TypeDescription
FormExtractionParams

buildPartial()

public FormExtractionParams buildPartial()
Returns
TypeDescription
FormExtractionParams

clear()

public FormExtractionParams.Builder clear()
Returns
TypeDescription
FormExtractionParams.Builder
Overrides

clearEnabled()

public FormExtractionParams.Builder clearEnabled()

Whether to enable form extraction.

bool enabled = 1;

Returns
TypeDescription
FormExtractionParams.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FormExtractionParams.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
FormExtractionParams.Builder
Overrides

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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
TypeDescription
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. 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;

Returns
TypeDescription
FormExtractionParams.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FormExtractionParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
FormExtractionParams.Builder
Overrides

clone()

public FormExtractionParams.Builder clone()
Returns
TypeDescription
FormExtractionParams.Builder
Overrides

getDefaultInstanceForType()

public FormExtractionParams getDefaultInstanceForType()
Returns
TypeDescription
FormExtractionParams

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEnabled()

public boolean getEnabled()

Whether to enable form extraction.

bool enabled = 1;

Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

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

getModelVersion()

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;

Returns
TypeDescription
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. 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;

Returns
TypeDescription
ByteString

The bytes for modelVersion.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(FormExtractionParams other)

public FormExtractionParams.Builder mergeFrom(FormExtractionParams other)
Parameter
NameDescription
otherFormExtractionParams
Returns
TypeDescription
FormExtractionParams.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FormExtractionParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FormExtractionParams.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public FormExtractionParams.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
FormExtractionParams.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FormExtractionParams.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
FormExtractionParams.Builder
Overrides

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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
FormExtractionParams.Builder

setEnabled(boolean value)

public FormExtractionParams.Builder setEnabled(boolean value)

Whether to enable form extraction.

bool enabled = 1;

Parameter
NameDescription
valueboolean

The enabled to set.

Returns
TypeDescription
FormExtractionParams.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FormExtractionParams.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
FormExtractionParams.Builder
Overrides

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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameters
NameDescription
indexint
valueKeyValuePairHint
Returns
TypeDescription
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.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameters
NameDescription
indexint
builderForValueKeyValuePairHint.Builder
Returns
TypeDescription
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. 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;

Parameter
NameDescription
valueString

The modelVersion to set.

Returns
TypeDescription
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. 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;

Parameter
NameDescription
valueByteString

The bytes for modelVersion to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
FormExtractionParams.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FormExtractionParams.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
FormExtractionParams.Builder
Overrides