com.google.cloud.discoveryengine.v1beta

Class DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig

All Implemented Interfaces:

DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

DocumentProcessingConfig.ChunkingConfig

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

 Configuration for the layout based chunking.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder Configuration for the layout based chunking.

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	CHUNK_SIZE_FIELD_NUMBER
static int	INCLUDE_ANCESTOR_HEADINGS_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)
int	getChunkSize() The token size limit for each chunk.
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	getDefaultInstance()
DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getIncludeAncestorHeadings() Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss.
com.google.protobuf.Parser<DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder	newBuilder()
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder	newBuilder(DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig prototype)
DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder	newBuilderForType()
protected DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	parseDelimitedFrom(InputStream input)
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	parseFrom(byte[] data)
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	parseFrom(ByteBuffer data)
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	parseFrom(com.google.protobuf.ByteString data)
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	parseFrom(InputStream input)
static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig>	parser()
DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.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

CHUNK_SIZE_FIELD_NUMBER

public static final int CHUNK_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

INCLUDE_ANCESTOR_HEADINGS_FIELD_NUMBER

public static final int INCLUDE_ANCESTOR_HEADINGS_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

getChunkSize

public int getChunkSize()

 The token size limit for each chunk.

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

int32 chunk_size = 1;

Specified by:

getChunkSize in interface DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfigOrBuilder

Returns:

The chunkSize.

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;

Specified by:

getIncludeAncestorHeadings in interface DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfigOrBuilder

Returns:

The includeAncestorHeadings.

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 DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig parseFrom(ByteBuffer data)
                                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig parseFrom(com.google.protobuf.ByteString data)
                                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig parseFrom(byte[] data)
                                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig parseFrom(InputStream input)
                                                                                   throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig parseDelimitedFrom(InputStream input)
                                                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                                                                   throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder newBuilder()

newBuilder

public static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder newBuilder(DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig prototype)

toBuilder

public DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig> parser()

getParserForType

public com.google.protobuf.Parser<DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig> 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 DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder