Package software.amazon.awssdk.services.bedrockagent.model

Class ChunkingConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.ChunkingConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ChunkingConfiguration.Builder,ChunkingConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class ChunkingConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ChunkingConfiguration.Builder,ChunkingConfiguration>

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChunkingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ChunkingConfiguration.Builder	builder()
ChunkingStrategy	chunkingStrategy()	Knowledge base can split your source data into chunks.
String	chunkingStrategyAsString()	Knowledge base can split your source data into chunks.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FixedSizeChunkingConfiguration	fixedSizeChunkingConfiguration()	Configurations for when you choose fixed-size chunking.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ChunkingConfiguration.Builder>	serializableBuilderClass()
ChunkingConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

chunkingStrategy

public final ChunkingStrategy chunkingStrategy()

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

• FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

• NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

If the service returns an enum value that is not available in the current SDK version, chunkingStrategy will return ChunkingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from chunkingStrategyAsString().

Returns:

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

• FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

• NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

See Also:

ChunkingStrategy

chunkingStrategyAsString

public final String chunkingStrategyAsString()

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

• FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

• NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

If the service returns an enum value that is not available in the current SDK version, chunkingStrategy will return ChunkingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from chunkingStrategyAsString().

Returns:

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

• FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

• NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

See Also:

ChunkingStrategy

fixedSizeChunkingConfiguration

public final FixedSizeChunkingConfiguration fixedSizeChunkingConfiguration()

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

Returns:

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

toBuilder

public ChunkingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChunkingConfiguration.Builder,ChunkingConfiguration>

builder

public static ChunkingConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ChunkingConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo