Module org.elasticsearch.server

Package org.elasticsearch.inference

Interface ServiceSettings

All Superinterfaces:

NamedWriteable, ToXContent, ToXContentObject, VersionedNamedWriteable, Writeable

public interface ServiceSettings
extends ToXContentObject, VersionedNamedWriteable

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 inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
default Integer	dimensions()	Number of dimensions the service works with.
default DenseVectorFieldMapper.ElementType	elementType()	The data type for the embeddings this service works with.
ToXContentObject	getFilteredXContentObject()	Returns a ToXContentObject that only writes the exposed fields.
default SimilarityMeasure	similarity()	Similarity used in the service.

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

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

getMinimalSupportedVersion, getWriteableName

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

writeTo

Method Details

getFilteredXContentObject

ToXContentObject getFilteredXContentObject()

Returns a ToXContentObject that only writes the exposed fields. Any hidden fields are not written.

similarity

default SimilarityMeasure similarity()

Similarity used in the service. Will be null if not applicable.

Returns:

similarity

dimensions

default Integer dimensions()

Number of dimensions the service works with. Will be null if not applicable.

Returns:

number of dimensions

elementType

default DenseVectorFieldMapper.ElementType elementType()

The data type for the embeddings this service works with. Defaults to null, Text Embedding models should return a non-null value

Returns:

the element type