Class ProcessOptions.LayoutConfig.ChunkingConfig.Builder (2.56.0)

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

Serving config for chunking.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder
Overrides

build()

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

buildPartial()

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

clear()

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder clear()
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder
Overrides

clearBreakpointPercentileThreshold()

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder clearBreakpointPercentileThreshold()

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
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

This builder for chaining.

clearChunkSize()

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder clearChunkSize()

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
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder
Overrides

clearIncludeAncestorHeadings()

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder clearIncludeAncestorHeadings()

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

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

Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder
Overrides

clearSemanticChunkingGroupSize()

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder clearSemanticChunkingGroupSize()

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
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

This builder for chaining.

clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ProcessOptions.LayoutConfig.ChunkingConfig other)

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder mergeFrom(ProcessOptions.LayoutConfig.ChunkingConfig other)
Parameter
Name Description
other ProcessOptions.LayoutConfig.ChunkingConfig
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ProcessOptions.LayoutConfig.ChunkingConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder
Overrides

setBreakpointPercentileThreshold(int value)

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder setBreakpointPercentileThreshold(int value)

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];

Parameter
Name Description
value int

The breakpointPercentileThreshold to set.

Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

This builder for chaining.

setChunkSize(int value)

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder setChunkSize(int value)

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

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

Parameter
Name Description
value int

The chunkSize to set.

Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder
Overrides

setIncludeAncestorHeadings(boolean value)

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder setIncludeAncestorHeadings(boolean value)

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

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

Parameter
Name Description
value boolean

The includeAncestorHeadings to set.

Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder
Overrides

setSemanticChunkingGroupSize(boolean value)

public ProcessOptions.LayoutConfig.ChunkingConfig.Builder setSemanticChunkingGroupSize(boolean value)

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

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

Parameter
Name Description
value boolean

The semanticChunkingGroupSize to set.

Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ProcessOptions.LayoutConfig.ChunkingConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ProcessOptions.LayoutConfig.ChunkingConfig.Builder
Overrides