Package co.elastic.clients.elasticsearch._types.mapping

Class ChunkingSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch._types.mapping.ChunkingSettings.Builder

All Implemented Interfaces:

WithJson<ChunkingSettings.Builder>, ObjectBuilder<ChunkingSettings>

Enclosing class:

ChunkingSettings

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

Builder for ChunkingSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ChunkingSettings	build()	Builds a ChunkingSettings.
final ChunkingSettings.Builder	maxChunkSize(int value)	Required - The maximum size of a chunk in words.
final ChunkingSettings.Builder	overlap(Integer value)	The number of overlapping words for chunks.
protected ChunkingSettings.Builder	self()
final ChunkingSettings.Builder	sentenceOverlap(Integer value)	The number of overlapping sentences for chunks.
final ChunkingSettings.Builder	strategy(String value)	Required - The chunking strategy: 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

strategy

public final ChunkingSettings.Builder strategy(String value)

Required - The chunking strategy: sentence or word.

API name: strategy

maxChunkSize

public final ChunkingSettings.Builder maxChunkSize(int value)

Required - 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 ChunkingSettings.Builder overlap(@Nullable
 Integer value)

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

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

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

self

protected ChunkingSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<ChunkingSettings.Builder>

build

public ChunkingSettings build()

Builds a ChunkingSettings.

Specified by:

build in interface ObjectBuilder<ChunkingSettings>

Throws:

NullPointerException - if some of the required fields are null.