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