Class ProcessOptions.LayoutConfig.ChunkingConfig (2.49.0)

public static final class ProcessOptions.LayoutConfig.ChunkingConfig extends GeneratedMessageV3 implements ProcessOptions.LayoutConfig.ChunkingConfigOrBuilder

Serving config for chunking.

Protobuf type google.cloud.documentai.v1beta3.ProcessOptions.LayoutConfig.ChunkingConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ProcessOptions.LayoutConfig.ChunkingConfig

Static Fields

BREAKPOINT_PERCENTILE_THRESHOLD_FIELD_NUMBER

public static final int BREAKPOINT_PERCENTILE_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

CHUNK_SIZE_FIELD_NUMBER

public static final int CHUNK_SIZE_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_ANCESTOR_HEADINGS_FIELD_NUMBER

public static final int INCLUDE_ANCESTOR_HEADINGS_FIELD_NUMBER
Field Value
Type Description
int

SEMANTIC_CHUNKING_GROUP_SIZE_FIELD_NUMBER

public static final int SEMANTIC_CHUNKING_GROUP_SIZE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ProcessOptions.LayoutConfig.ChunkingConfig getDefaultInstance()
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig

getDescriptor()

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

newBuilder()

public static ProcessOptions.LayoutConfig.ChunkingConfig.Builder newBuilder()
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

newBuilder(ProcessOptions.LayoutConfig.ChunkingConfig prototype)

public static ProcessOptions.LayoutConfig.ChunkingConfig.Builder newBuilder(ProcessOptions.LayoutConfig.ChunkingConfig prototype)
Parameter
Name Description
prototype ProcessOptions.LayoutConfig.ChunkingConfig
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

parseDelimitedFrom(InputStream input)

public static ProcessOptions.LayoutConfig.ChunkingConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions.LayoutConfig.ChunkingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ProcessOptions.LayoutConfig.ChunkingConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions.LayoutConfig.ChunkingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProcessOptions.LayoutConfig.ChunkingConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions.LayoutConfig.ChunkingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProcessOptions.LayoutConfig.ChunkingConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions.LayoutConfig.ChunkingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ProcessOptions.LayoutConfig.ChunkingConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions.LayoutConfig.ChunkingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ProcessOptions.LayoutConfig.ChunkingConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions.LayoutConfig.ChunkingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ProcessOptions.LayoutConfig.ChunkingConfig> parser()
Returns
Type Description
Parser<ChunkingConfig>

Methods

equals(Object obj)

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

getBreakpointPercentileThreshold()

public int getBreakpointPercentileThreshold()

Optional. The percentile of cosine dissimilarity that must be exceeded between a group of tokens and the next. The smaller this number is, the more chunks will be generated.

int32 breakpoint_percentile_threshold = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The breakpointPercentileThreshold.

getChunkSize()

public int getChunkSize()

Optional. The chunk sizes to use when splitting documents, in order of level.

int32 chunk_size = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The chunkSize.

getDefaultInstanceForType()

public ProcessOptions.LayoutConfig.ChunkingConfig getDefaultInstanceForType()
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig

getIncludeAncestorHeadings()

public boolean getIncludeAncestorHeadings()

Optional. Whether or not to include ancestor headings when splitting.

bool include_ancestor_headings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The includeAncestorHeadings.

getParserForType()

public Parser<ProcessOptions.LayoutConfig.ChunkingConfig> getParserForType()
Returns
Type Description
Parser<ChunkingConfig>
Overrides

getSemanticChunkingGroupSize()

public boolean getSemanticChunkingGroupSize()

Optional. The number of tokens to group together when evaluating semantic similarity.

bool semantic_chunking_group_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The semanticChunkingGroupSize.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 ProcessOptions.LayoutConfig.ChunkingConfig.Builder newBuilderForType()
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProcessOptions.LayoutConfig.ChunkingConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder toBuilder()
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

writeTo(CodedOutputStream output)

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