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:

ToXContent, ToXContentObject

public record MinimalServiceSettings(TaskType taskType, Integer dimensions, SimilarityMeasure similarity, DenseVectorFieldMapper.ElementType elementType)
extends Record
implements ToXContentObject

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.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TASK_TYPE_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static MinimalServiceSettings	chatCompletion()
static MinimalServiceSettings	completion()
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.
final int	hashCode()	Returns a hash code value for this object.
static MinimalServiceSettings	parse(XContentParser parser)
static MinimalServiceSettings	rerank()
SimilarityMeasure	similarity()	Returns the value of the similarity record component.
static MinimalServiceSettings	sparseEmbedding()
TaskType	taskType()	Returns the value of the taskType record component.
static MinimalServiceSettings	textEmbedding(int dimensions, SimilarityMeasure similarity, DenseVectorFieldMapper.ElementType elementType)
String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

TASK_TYPE_FIELD

public static final String TASK_TYPE_FIELD

See Also:

• Constant Field Values

Constructor Details

MinimalServiceSettings

public MinimalServiceSettings(Model model)

MinimalServiceSettings

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

Creates an instance of a MinimalServiceSettings record class.

Parameters:

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

Method Details

parse

public static MinimalServiceSettings parse(XContentParser parser)
                                    throws IOException

Throws:

IOException

textEmbedding

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

sparseEmbedding

public static MinimalServiceSettings sparseEmbedding()

rerank

public static MinimalServiceSettings rerank()

completion

public static MinimalServiceSettings completion()

chatCompletion

public static MinimalServiceSettings chatCompletion()

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

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.

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.

Returns:

the value of the dimensions record component

similarity

@Nullable
public SimilarityMeasure similarity()

Returns the value of the similarity record component.

Returns:

the value of the similarity record component

elementType

@Nullable
public DenseVectorFieldMapper.ElementType elementType()

Returns the value of the elementType record component.

Returns:

the value of the elementType record component