Package co.elastic.clients.elasticsearch.inference

Class InferenceChunkingSettings

java.lang.Object

co.elastic.clients.elasticsearch.inference.InferenceEndpoint

co.elastic.clients.elasticsearch.inference.InferenceChunkingSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class InferenceChunkingSettings
extends InferenceEndpoint

Chunking configuration object

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.inference.InferenceEndpoint

InferenceEndpoint.AbstractBuilder<BuilderT extends InferenceEndpoint.AbstractBuilder<BuilderT>>

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()	Specifies 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)
static InferenceChunkingSettings	of(Function<InferenceChunkingSettings.Builder,ObjectBuilder<InferenceChunkingSettings>> fn)
final Integer	overlap()	Specifies the number of overlapping words for chunks Only for word chunking strategy This value cannot be higher than the half of max_chunk_size
final Integer	sentenceOverlap()	Specifies the number of overlapping sentences for chunks Only for sentence chunking strategy It can be either 1 or 0
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupInferenceChunkingSettingsDeserializer(ObjectDeserializer<InferenceChunkingSettings.Builder> op)
final String	strategy()	Specifies the chunking strategy It could be either sentence or word

Methods inherited from class co.elastic.clients.elasticsearch.inference.InferenceEndpoint

chunkingSettings, inferenceEndpointOf, serialize, service, serviceSettings, setupInferenceEndpointDeserializer, taskSettings, 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()

Specifies 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()

Specifies the number of overlapping words for chunks Only for word chunking strategy This value cannot be higher than the half of max_chunk_size

API name: overlap

sentenceOverlap

@Nullable
public final Integer sentenceOverlap()

Specifies the number of overlapping sentences for chunks Only for sentence chunking strategy It can be either 1 or 0

API name: sentence_overlap

strategy

@Nullable
public final String strategy()

Specifies the chunking strategy It could be either sentence or word

API name: strategy

serializeInternal

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

Overrides:

serializeInternal in class InferenceEndpoint

setupInferenceChunkingSettingsDeserializer

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