Package co.elastic.clients.elasticsearch.inference

Class InferenceChunkingSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<InferenceChunkingSettings.Builder>

co.elastic.clients.elasticsearch.inference.InferenceChunkingSettings.Builder

All Implemented Interfaces:

WithJson<InferenceChunkingSettings.Builder>, ObjectBuilder<InferenceChunkingSettings>

Enclosing class:

InferenceChunkingSettings

public static class InferenceChunkingSettings.Builder
extends WithJsonObjectBuilderBase<InferenceChunkingSettings.Builder>
implements ObjectBuilder<InferenceChunkingSettings>

Builder for InferenceChunkingSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InferenceChunkingSettings	build()	Builds a InferenceChunkingSettings.
final InferenceChunkingSettings.Builder	maxChunkSize(Integer value)	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)
final InferenceChunkingSettings.Builder	overlap(Integer value)	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
protected InferenceChunkingSettings.Builder	self()
final InferenceChunkingSettings.Builder	sentenceOverlap(Integer value)	Specifies the number of overlapping sentences for chunks Only for sentence chunking strategy It can be either 1 or 0
final InferenceChunkingSettings.Builder	strategy(String value)	Specifies the chunking strategy It could be either sentence or word

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

maxChunkSize

public final InferenceChunkingSettings.Builder maxChunkSize(@Nullable
 Integer value)

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

public final InferenceChunkingSettings.Builder overlap(@Nullable
 Integer value)

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

public final InferenceChunkingSettings.Builder sentenceOverlap(@Nullable
 Integer value)

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

public final InferenceChunkingSettings.Builder strategy(@Nullable
 String value)

Specifies the chunking strategy It could be either sentence or word

API name: strategy

self

protected InferenceChunkingSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<InferenceChunkingSettings.Builder>

build

public InferenceChunkingSettings build()

Builds a InferenceChunkingSettings.

Specified by:

build in interface ObjectBuilder<InferenceChunkingSettings>

Throws:

NullPointerException - if some of the required fields are null.