Class DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig (0.41.0)

public static final class DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig extends GeneratedMessageV3 implements DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfigOrBuilder

Configuration for the layout based chunking.

Protobuf type google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig

Static Fields

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

Static Methods

getDefaultInstance()

public static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig getDefaultInstance()
Returns
Type Description
DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig

getDescriptor()

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

newBuilder()

public static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder newBuilder()
Returns
Type Description
DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder

newBuilder(DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig prototype)

public static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder newBuilder(DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig prototype)
Parameter
Name Description
prototype DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig
Returns
Type Description
DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig> parser()
Returns
Type Description
Parser<LayoutBasedChunkingConfig>

Methods

equals(Object obj)

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

getChunkSize()

public int getChunkSize()

The token size limit for each chunk.

Supported values: 100-500 (inclusive). Default value: 500.

int32 chunk_size = 1;

Returns
Type Description
int

The chunkSize.

getDefaultInstanceForType()

public DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig getDefaultInstanceForType()
Returns
Type Description
DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig

getIncludeAncestorHeadings()

public boolean getIncludeAncestorHeadings()

Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss.

Default value: False.

bool include_ancestor_headings = 2;

Returns
Type Description
boolean

The includeAncestorHeadings.

getParserForType()

public Parser<DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig> getParserForType()
Returns
Type Description
Parser<LayoutBasedChunkingConfig>
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder toBuilder()
Returns
Type Description
DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder

writeTo(CodedOutputStream output)

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