Package co.elastic.clients.elasticsearch.inference

Class ElserServiceSettings

java.lang.Object

co.elastic.clients.elasticsearch.inference.ElserServiceSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ElserServiceSettings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElserServiceSettings.Builder	Builder for ElserServiceSettings.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ElserServiceSettings>	_DESERIALIZER	Json deserializer for ElserServiceSettings

Method Summary

Modifier and Type	Method	Description
final AdaptiveAllocations	adaptiveAllocations()	Adaptive allocations configuration details.
final int	numAllocations()	Required - The total number of allocations this model is assigned across machine learning nodes.
final int	numThreads()	Required - The number of threads used by each model allocation during inference.
static ElserServiceSettings	of(Function<ElserServiceSettings.Builder,ObjectBuilder<ElserServiceSettings>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupElserServiceSettingsDeserializer(ObjectDeserializer<ElserServiceSettings.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ElserServiceSettings> _DESERIALIZER

Json deserializer for ElserServiceSettings

Method Details

of

public static ElserServiceSettings of(Function<ElserServiceSettings.Builder,ObjectBuilder<ElserServiceSettings>> fn)

adaptiveAllocations

@Nullable
public final AdaptiveAllocations adaptiveAllocations()

Adaptive allocations configuration details. If enabled is true, the number of allocations of the model is set based on the current load the process gets. When the load is high, a new model allocation is automatically created, respecting the value of max_number_of_allocations if it's set. When the load is low, a model allocation is automatically removed, respecting the value of min_number_of_allocations if it's set. If enabled is true, do not set the number of allocations manually.

API name: adaptive_allocations

numAllocations

public final int numAllocations()

Required - The total number of allocations this model is assigned across machine learning nodes. Increasing this value generally increases the throughput. If adaptive allocations is enabled, do not set this value because it's automatically set.

API name: num_allocations

numThreads

public final int numThreads()

Required - The number of threads used by each model allocation during inference. Increasing this value generally increases the speed per inference request. The inference process is a compute-bound process; threads_per_allocations must not exceed the number of available allocated processors per node. The value must be a power of 2. The maximum value is 32.

info If you want to optimize your ELSER endpoint for ingest, set the number of threads to 1. If you want to optimize your ELSER endpoint for search, set the number of threads to greater than 1.

API name: num_threads

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupElserServiceSettingsDeserializer

protected static void setupElserServiceSettingsDeserializer(ObjectDeserializer<ElserServiceSettings.Builder> op)