Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.inference.chunking

Class SentenceBoundaryChunkingSettings

java.lang.Object

org.elasticsearch.xpack.core.inference.chunking.SentenceBoundaryChunkingSettings

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, ChunkingSettings, ToXContent, ToXContentObject

public class SentenceBoundaryChunkingSettings
extends Object
implements ChunkingSettings

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	maxChunkSize
static final String	NAME
protected int	sentenceOverlap

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SentenceBoundaryChunkingSettings(Integer maxChunkSize, Integer sentenceOverlap)
SentenceBoundaryChunkingSettings(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()
boolean	equals(Object o)
static SentenceBoundaryChunkingSettings	fromMap(Map<String,Object> map)
ChunkingStrategy	getChunkingStrategy()
TransportVersion	getMinimalSupportedVersion()
String	getWriteableName()
int	hashCode()
Integer	maxChunkSize()
int	sentenceOverlap()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	validate()
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

maxChunkSize

protected final int maxChunkSize

sentenceOverlap

protected int sentenceOverlap

Constructor Details

SentenceBoundaryChunkingSettings

public SentenceBoundaryChunkingSettings(Integer maxChunkSize,
 @Nullable
 Integer sentenceOverlap)

SentenceBoundaryChunkingSettings

public SentenceBoundaryChunkingSettings(StreamInput in)
                                 throws IOException

Throws:

IOException

Method Details

maxChunkSize

public Integer maxChunkSize()

Specified by:

maxChunkSize in interface ChunkingSettings

sentenceOverlap

public int sentenceOverlap()

validate

public void validate()

Specified by:

validate in interface ChunkingSettings

asMap

public Map<String,Object> asMap()

Specified by:

asMap in interface ChunkingSettings

fromMap

public static SentenceBoundaryChunkingSettings fromMap(Map<String,Object> map)

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getChunkingStrategy

public ChunkingStrategy getChunkingStrategy()

Specified by:

getChunkingStrategy in interface ChunkingSettings

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object