com.google.cloud.documentai.v1beta1

Class FormExtractionParams

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta1.FormExtractionParams

All Implemented Interfaces:

FormExtractionParamsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class FormExtractionParams
extends com.google.protobuf.GeneratedMessageV3
implements FormExtractionParamsOrBuilder

 Parameters to control form extraction behavior.
 

Protobuf type google.cloud.documentai.v1beta1.FormExtractionParams

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FormExtractionParams.Builder Parameters to control form extraction behavior.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENABLED_FIELD_NUMBER
static int	KEY_VALUE_PAIR_HINTS_FIELD_NUMBER
static int	MODEL_VERSION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static FormExtractionParams	getDefaultInstance()
FormExtractionParams	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getEnabled() Whether to enable form extraction.
KeyValuePairHint	getKeyValuePairHints(int index) User can provide pairs of (key text, value type) to improve the parsing result.
int	getKeyValuePairHintsCount() User can provide pairs of (key text, value type) to improve the parsing result.
List<KeyValuePairHint>	getKeyValuePairHintsList() User can provide pairs of (key text, value type) to improve the parsing result.
KeyValuePairHintOrBuilder	getKeyValuePairHintsOrBuilder(int index) User can provide pairs of (key text, value type) to improve the parsing result.
List<? extends KeyValuePairHintOrBuilder>	getKeyValuePairHintsOrBuilderList() User can provide pairs of (key text, value type) to improve the parsing result.
String	getModelVersion() Model version of the form extraction system.
com.google.protobuf.ByteString	getModelVersionBytes() Model version of the form extraction system.
com.google.protobuf.Parser<FormExtractionParams>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static FormExtractionParams.Builder	newBuilder()
static FormExtractionParams.Builder	newBuilder(FormExtractionParams prototype)
FormExtractionParams.Builder	newBuilderForType()
protected FormExtractionParams.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FormExtractionParams	parseDelimitedFrom(InputStream input)
static FormExtractionParams	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FormExtractionParams	parseFrom(byte[] data)
static FormExtractionParams	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FormExtractionParams	parseFrom(ByteBuffer data)
static FormExtractionParams	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FormExtractionParams	parseFrom(com.google.protobuf.ByteString data)
static FormExtractionParams	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FormExtractionParams	parseFrom(com.google.protobuf.CodedInputStream input)
static FormExtractionParams	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FormExtractionParams	parseFrom(InputStream input)
static FormExtractionParams	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FormExtractionParams>	parser()
FormExtractionParams.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER

See Also:

Constant Field Values

KEY_VALUE_PAIR_HINTS_FIELD_NUMBER

public static final int KEY_VALUE_PAIR_HINTS_FIELD_NUMBER

See Also:

Constant Field Values

MODEL_VERSION_FIELD_NUMBER

public static final int MODEL_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getEnabled

public boolean getEnabled()

 Whether to enable form extraction.
 

bool enabled = 1;

Specified by:

getEnabled in interface FormExtractionParamsOrBuilder

Returns:

The enabled.

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;

Specified by:

getKeyValuePairHintsList in interface FormExtractionParamsOrBuilder

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;

Specified by:

getKeyValuePairHintsOrBuilderList in interface FormExtractionParamsOrBuilder

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;

Specified by:

getKeyValuePairHintsCount in interface FormExtractionParamsOrBuilder

getKeyValuePairHints

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;

Specified by:

getKeyValuePairHints in interface FormExtractionParamsOrBuilder

getKeyValuePairHintsOrBuilder

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;

Specified by:

getKeyValuePairHintsOrBuilder in interface FormExtractionParamsOrBuilder

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;

Specified by:

getModelVersion in interface FormExtractionParamsOrBuilder

Returns:

The modelVersion.

getModelVersionBytes

public com.google.protobuf.ByteString getModelVersionBytes()

 Model version of the form extraction system. Default is
 "builtin/stable". Specify "builtin/latest" for the latest model.
 

string model_version = 3;

Specified by:

getModelVersionBytes in interface FormExtractionParamsOrBuilder

Returns:

The bytes for modelVersion.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static FormExtractionParams parseFrom(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FormExtractionParams parseFrom(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FormExtractionParams parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FormExtractionParams parseFrom(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FormExtractionParams parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FormExtractionParams parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FormExtractionParams parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static FormExtractionParams parseFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static FormExtractionParams parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static FormExtractionParams parseDelimitedFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseFrom

public static FormExtractionParams parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static FormExtractionParams parseFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

newBuilderForType

public FormExtractionParams.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FormExtractionParams.Builder newBuilder()

newBuilder

public static FormExtractionParams.Builder newBuilder(FormExtractionParams prototype)

toBuilder

public FormExtractionParams.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected FormExtractionParams.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FormExtractionParams getDefaultInstance()

parser

public static com.google.protobuf.Parser<FormExtractionParams> parser()

getParserForType

public com.google.protobuf.Parser<FormExtractionParams> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public FormExtractionParams getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder