Module org.elasticsearch.server

Package org.elasticsearch.inference

Record Class MinimalServiceSettings

java.lang.Object

java.lang.Record

org.elasticsearch.inference.MinimalServiceSettings

Record Components:

taskType - the type of task the inference model performs.

dimensions - the number of dimensions for the embeddings, applicable only for TaskType.TEXT_EMBEDDING (nullable).

similarity - the similarity measure used for embeddings, applicable only for TaskType.TEXT_EMBEDDING (nullable).

elementType - the type of elements in the embeddings, applicable only for TaskType.TEXT_EMBEDDING (nullable).

All Implemented Interfaces:

Diffable<MinimalServiceSettings>, SimpleDiffable<MinimalServiceSettings>, NamedWriteable, VersionedNamedWriteable, Writeable, FilteredXContent, ServiceSettings, ToXContent, ToXContentObject

public record MinimalServiceSettings(String service, TaskType taskType, Integer dimensions, SimilarityMeasure similarity, DenseVectorFieldMapper.ElementType elementType)
extends Record
implements ServiceSettings, SimpleDiffable<MinimalServiceSettings>

Defines the base settings required to configure an inference endpoint. These settings are immutable and describe the input and output types that the endpoint will handle. They capture the essential properties of an inference model, ensuring the endpoint is correctly configured. Key properties include:

• taskType - Specifies the type of task the model performs, such as classification or text embeddings.
• dimensions, similarity, and elementType - These settings are applicable only when the taskType is TaskType.TEXT_EMBEDDING. They define the structure and behavior of embeddings.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.SimpleDiffable

SimpleDiffable.CompleteDiff<T extends Diffable<T>>

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
static final String	NAME
static final String	SERVICE_FIELD
static final String	TASK_TYPE_FIELD

Fields inherited from interface org.elasticsearch.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MinimalServiceSettings(String service, TaskType taskType, Integer dimensions, SimilarityMeasure similarity, DenseVectorFieldMapper.ElementType elementType)	Creates an instance of a MinimalServiceSettings record class.
MinimalServiceSettings(StreamInput in)
MinimalServiceSettings(Model model)

Method Summary

Modifier and Type	Method	Description
boolean	canMergeWith(MinimalServiceSettings other)	Checks if the given MinimalServiceSettings is equivalent to the current definition.
static MinimalServiceSettings	chatCompletion(String serviceName)
static MinimalServiceSettings	completion(String serviceName)
Integer	dimensions()	Returns the value of the dimensions record component.
DenseVectorFieldMapper.ElementType	elementType()	Returns the value of the elementType record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ToXContentObject	getFilteredXContentObject()	Returns a ToXContentObject that only writes the exposed fields.
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
final int	hashCode()	Returns a hash code value for this object.
String	modelId()	The model to use in the inference endpoint (e.g.
static MinimalServiceSettings	parse(XContentParser parser)
static Diff<MinimalServiceSettings>	readDiffFrom(StreamInput in)
static MinimalServiceSettings	rerank(String serviceName)
String	service()	Returns the value of the service record component.
SimilarityMeasure	similarity()	Returns the value of the similarity record component.
static MinimalServiceSettings	sparseEmbedding(String serviceName)
TaskType	taskType()	Returns the value of the taskType record component.
static MinimalServiceSettings	textEmbedding(String serviceName, int dimensions, SimilarityMeasure similarity, DenseVectorFieldMapper.ElementType elementType)
String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.inference.ServiceSettings

dimensionsSetByUser

Methods inherited from interface org.elasticsearch.cluster.SimpleDiffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

SERVICE_FIELD

public static final String SERVICE_FIELD

See Also:

• Constant Field Values

TASK_TYPE_FIELD

public static final String TASK_TYPE_FIELD

See Also:

• Constant Field Values

Constructor Details

MinimalServiceSettings

public MinimalServiceSettings(@Nullable
 String service,
 TaskType taskType,
 @Nullable
 Integer dimensions,
 @Nullable
 SimilarityMeasure similarity,
 @Nullable
 DenseVectorFieldMapper.ElementType elementType)

Creates an instance of a MinimalServiceSettings record class.

Parameters:

service - the value for the service record component

taskType - the value for the taskType record component

dimensions - the value for the dimensions record component

similarity - the value for the similarity record component

elementType - the value for the elementType record component

MinimalServiceSettings

public MinimalServiceSettings(Model model)

MinimalServiceSettings

public MinimalServiceSettings(StreamInput in)
                       throws IOException

Throws:

IOException

Method Details

parse

public static MinimalServiceSettings parse(XContentParser parser)
                                    throws IOException

Throws:

IOException

textEmbedding

public static MinimalServiceSettings textEmbedding(String serviceName,
 int dimensions,
 SimilarityMeasure similarity,
 DenseVectorFieldMapper.ElementType elementType)

sparseEmbedding

public static MinimalServiceSettings sparseEmbedding(String serviceName)

rerank

public static MinimalServiceSettings rerank(String serviceName)

completion

public static MinimalServiceSettings completion(String serviceName)

chatCompletion

public static MinimalServiceSettings chatCompletion(String serviceName)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

getFilteredXContentObject

public ToXContentObject getFilteredXContentObject()

Description copied from interface: FilteredXContent

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

Specified by:

getFilteredXContentObject in interface FilteredXContent

modelId

public String modelId()

Description copied from interface: ServiceSettings

The model to use in the inference endpoint (e.g. text-embedding-ada-002). Sometimes the model is not defined in the service settings. This can happen for external providers (e.g. hugging face, azure ai studio) where the provider requires that the model be chosen when initializing a deployment within their service. In this situation, return null.

Specified by:

modelId in interface ServiceSettings

Returns:

the model used to perform inference or null if the model is not defined

readDiffFrom

public static Diff<MinimalServiceSettings> readDiffFrom(StreamInput in)
                                                 throws IOException

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

canMergeWith

public boolean canMergeWith(MinimalServiceSettings other)

Checks if the given MinimalServiceSettings is equivalent to the current definition.

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

service

@Nullable
public String service()

Returns the value of the service record component.

Returns:

the value of the service record component

taskType

public TaskType taskType()

Returns the value of the taskType record component.

Returns:

the value of the taskType record component

dimensions

@Nullable
public Integer dimensions()

Returns the value of the dimensions record component.

Specified by:

dimensions in interface ServiceSettings

Returns:

the value of the dimensions record component

similarity

@Nullable
public SimilarityMeasure similarity()

Returns the value of the similarity record component.

Specified by:

similarity in interface ServiceSettings

Returns:

the value of the similarity record component

elementType

@Nullable
public DenseVectorFieldMapper.ElementType elementType()

Returns the value of the elementType record component.

Specified by:

elementType in interface ServiceSettings

Returns:

the value of the elementType record component