Class TableExtractionParams (2.47.0)

public final class TableExtractionParams extends GeneratedMessageV3 implements TableExtractionParamsOrBuilder

Parameters to control table extraction behavior.

Protobuf type google.cloud.documentai.v1beta1.TableExtractionParams

Static Fields

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

HEADER_HINTS_FIELD_NUMBER

public static final int HEADER_HINTS_FIELD_NUMBER
Field Value
Type Description
int

MODEL_VERSION_FIELD_NUMBER

public static final int MODEL_VERSION_FIELD_NUMBER
Field Value
Type Description
int

TABLE_BOUND_HINTS_FIELD_NUMBER

public static final int TABLE_BOUND_HINTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TableExtractionParams getDefaultInstance()
Returns
Type Description
TableExtractionParams

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TableExtractionParams.Builder newBuilder()
Returns
Type Description
TableExtractionParams.Builder

newBuilder(TableExtractionParams prototype)

public static TableExtractionParams.Builder newBuilder(TableExtractionParams prototype)
Parameter
Name Description
prototype TableExtractionParams
Returns
Type Description
TableExtractionParams.Builder

parseDelimitedFrom(InputStream input)

public static TableExtractionParams parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TableExtractionParams
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TableExtractionParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TableExtractionParams
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TableExtractionParams parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TableExtractionParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TableExtractionParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TableExtractionParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TableExtractionParams parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TableExtractionParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TableExtractionParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TableExtractionParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TableExtractionParams parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TableExtractionParams
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TableExtractionParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TableExtractionParams
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TableExtractionParams parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TableExtractionParams
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TableExtractionParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TableExtractionParams
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TableExtractionParams parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TableExtractionParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TableExtractionParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TableExtractionParams
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TableExtractionParams> parser()
Returns
Type Description
Parser<TableExtractionParams>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public TableExtractionParams getDefaultInstanceForType()
Returns
Type Description
TableExtractionParams

getEnabled()

public boolean getEnabled()

Whether to enable table extraction.

bool enabled = 1;

Returns
Type Description
boolean

The enabled.

getHeaderHints(int index)

public String getHeaderHints(int index)

Optional. Table header hints. The extraction will bias towards producing these terms as table headers, which may improve accuracy.

repeated string header_hints = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The headerHints at the given index.

getHeaderHintsBytes(int index)

public ByteString getHeaderHintsBytes(int index)

Optional. Table header hints. The extraction will bias towards producing these terms as table headers, which may improve accuracy.

repeated string header_hints = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the headerHints at the given index.

getHeaderHintsCount()

public int getHeaderHintsCount()

Optional. Table header hints. The extraction will bias towards producing these terms as table headers, which may improve accuracy.

repeated string header_hints = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of headerHints.

getHeaderHintsList()

public ProtocolStringList getHeaderHintsList()

Optional. Table header hints. The extraction will bias towards producing these terms as table headers, which may improve accuracy.

repeated string header_hints = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the headerHints.

getModelVersion()

public String getModelVersion()

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

string model_version = 4;

Returns
Type Description
String

The modelVersion.

getModelVersionBytes()

public ByteString getModelVersionBytes()

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

string model_version = 4;

Returns
Type Description
ByteString

The bytes for modelVersion.

getParserForType()

public Parser<TableExtractionParams> getParserForType()
Returns
Type Description
Parser<TableExtractionParams>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTableBoundHints(int index)

public TableBoundHint getTableBoundHints(int index)

Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.

repeated .google.cloud.documentai.v1beta1.TableBoundHint table_bound_hints = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TableBoundHint

getTableBoundHintsCount()

public int getTableBoundHintsCount()

Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.

repeated .google.cloud.documentai.v1beta1.TableBoundHint table_bound_hints = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getTableBoundHintsList()

public List<TableBoundHint> getTableBoundHintsList()

Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.

repeated .google.cloud.documentai.v1beta1.TableBoundHint table_bound_hints = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<TableBoundHint>

getTableBoundHintsOrBuilder(int index)

public TableBoundHintOrBuilder getTableBoundHintsOrBuilder(int index)

Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.

repeated .google.cloud.documentai.v1beta1.TableBoundHint table_bound_hints = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TableBoundHintOrBuilder

getTableBoundHintsOrBuilderList()

public List<? extends TableBoundHintOrBuilder> getTableBoundHintsOrBuilderList()

Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.

repeated .google.cloud.documentai.v1beta1.TableBoundHint table_bound_hints = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.documentai.v1beta1.TableBoundHintOrBuilder>

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TableExtractionParams.Builder newBuilderForType()
Returns
Type Description
TableExtractionParams.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TableExtractionParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TableExtractionParams.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TableExtractionParams.Builder toBuilder()
Returns
Type Description
TableExtractionParams.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException