Module org.elasticsearch.server

Package org.elasticsearch.inference

Class ModelConfigurations

java.lang.Object

org.elasticsearch.inference.ModelConfigurations

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, ToFilteredXContentObject, ToXContent, ToXContentObject

public class ModelConfigurations
extends Object
implements ToFilteredXContentObject, 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

Modifier and Type	Field	Description
static final String	MODEL_ID
static final String	SERVICE
static final String	SERVICE_SETTINGS
static final String	TASK_SETTINGS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ModelConfigurations(String inferenceEntityId, TaskType taskType, String service, ServiceSettings serviceSettings)	Allows no task settings to be defined.
ModelConfigurations(String inferenceEntityId, TaskType taskType, String service, ServiceSettings serviceSettings, TaskSettings taskSettings)
ModelConfigurations(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getInferenceEntityId()
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getService()
ServiceSettings	getServiceSettings()
TaskSettings	getTaskSettings()
TaskType	getTaskType()
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static ModelConfigurations	of(Model model, ServiceSettings serviceSettings)
static ModelConfigurations	of(Model model, TaskSettings taskSettings)
XContentBuilder	toFilteredXContent(XContentBuilder builder, ToXContent.Params params)	Returns a XContentBuilder which has some fields removed from the response content.
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, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

MODEL_ID

public static final String MODEL_ID

See Also:

• Constant Field Values

SERVICE

public static final String SERVICE

See Also:

• Constant Field Values

SERVICE_SETTINGS

public static final String SERVICE_SETTINGS

See Also:

• Constant Field Values

TASK_SETTINGS

public static final String TASK_SETTINGS

See Also:

• Constant Field Values

Constructor Details

ModelConfigurations

public ModelConfigurations(String inferenceEntityId,
 TaskType taskType,
 String service,
 ServiceSettings serviceSettings)

Allows no task settings to be defined. This will default to the EmptyTaskSettings object.

ModelConfigurations

public ModelConfigurations(String inferenceEntityId,
 TaskType taskType,
 String service,
 ServiceSettings serviceSettings,
 TaskSettings taskSettings)

ModelConfigurations

public ModelConfigurations(StreamInput in)
                    throws IOException

Throws:

IOException

Method Details

of

public static ModelConfigurations of(Model model,
 TaskSettings taskSettings)

of

public static ModelConfigurations of(Model model,
 ServiceSettings serviceSettings)

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

getInferenceEntityId

public String getInferenceEntityId()

getTaskType

public TaskType getTaskType()

getService

public String getService()

getServiceSettings

public ServiceSettings getServiceSettings()

getTaskSettings

public TaskSettings getTaskSettings()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toFilteredXContent

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

Description copied from interface: ToFilteredXContentObject

Returns a XContentBuilder which has some fields removed from the response content.

Specified by:

toFilteredXContent in interface ToFilteredXContentObject

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object