Package co.elastic.clients.elasticsearch.inference

Class InferenceChunkingSettings

java.lang.Object

co.elastic.clients.elasticsearch.inference.InferenceChunkingSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class InferenceChunkingSettings
extends Object
implements JsonpSerializable

Chunking configuration object

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InferenceChunkingSettings.Builder	Builder for InferenceChunkingSettings.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<InferenceChunkingSettings>	_DESERIALIZER	Json deserializer for InferenceChunkingSettings

Method Summary

Modifier and Type	Method	Description
final Integer	maxChunkSize()	The maximum size of a chunk in words.
static InferenceChunkingSettings	of(Function<InferenceChunkingSettings.Builder,ObjectBuilder<InferenceChunkingSettings>> fn)
final Integer	overlap()	The number of overlapping words for chunks.
InferenceChunkingSettings.Builder	rebuild()
final Integer	sentenceOverlap()	The number of overlapping sentences for chunks.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupInferenceChunkingSettingsDeserializer(ObjectDeserializer<InferenceChunkingSettings.Builder> op)
final String	strategy()	The chunking strategy: sentence or word.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<InferenceChunkingSettings> _DESERIALIZER

Json deserializer for InferenceChunkingSettings

Method Details

of

public static InferenceChunkingSettings of(Function<InferenceChunkingSettings.Builder,ObjectBuilder<InferenceChunkingSettings>> fn)

maxChunkSize

@Nullable
public final Integer maxChunkSize()

The maximum size of a chunk in words. This value cannot be higher than 300 or lower than 20 (for sentence strategy) or 10 (for word strategy).

API name: max_chunk_size

overlap

@Nullable
public final Integer overlap()

The number of overlapping words for chunks. It is applicable only to a word chunking strategy. This value cannot be higher than half the max_chunk_size value.

API name: overlap

sentenceOverlap

@Nullable
public final Integer sentenceOverlap()

The number of overlapping sentences for chunks. It is applicable only for a sentence chunking strategy. It can be either 1 or 0.

API name: sentence_overlap

strategy

@Nullable
public final String strategy()

The chunking strategy: sentence or word.

API name: strategy

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

rebuild

public InferenceChunkingSettings.Builder rebuild()

Returns:

New InferenceChunkingSettings.Builder initialized with field values of this instance

setupInferenceChunkingSettingsDeserializer

protected static void setupInferenceChunkingSettingsDeserializer(ObjectDeserializer<InferenceChunkingSettings.Builder> op)