public final class FormExtractionParams extends GeneratedMessageV3 implements FormExtractionParamsOrBuilder
Parameters to control form extraction behavior.
Protobuf type google.cloud.documentai.v1beta2.FormExtractionParams
Fields
public static final int ENABLED_FIELD_NUMBER
Field Value
public static final int KEY_VALUE_PAIR_HINTS_FIELD_NUMBER
Field Value
public static final int MODEL_VERSION_FIELD_NUMBER
Field Value
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public static FormExtractionParams getDefaultInstance()
Returns
public FormExtractionParams getDefaultInstanceForType()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
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 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.
|
public Parser<FormExtractionParams> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public static FormExtractionParams.Builder newBuilder()
Returns
public static FormExtractionParams.Builder newBuilder(FormExtractionParams prototype)
Parameter
Returns
public FormExtractionParams.Builder newBuilderForType()
Returns
protected FormExtractionParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static FormExtractionParams parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static FormExtractionParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static FormExtractionParams parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static FormExtractionParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static FormExtractionParams parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static FormExtractionParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static FormExtractionParams parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static FormExtractionParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static FormExtractionParams parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static FormExtractionParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static FormExtractionParams parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static FormExtractionParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<FormExtractionParams> parser()
Returns
public FormExtractionParams.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
