Module org.elasticsearch.server

Package org.elasticsearch.inference

Class Model

java.lang.Object

org.elasticsearch.inference.Model

All Implemented Interfaces:

Writeable

public class Model
extends Object
implements Writeable

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
Model(StreamInput in)
Model(ModelConfigurations configurations)
Model(ModelConfigurations configurations, ModelSecrets secrets)
Model(Model model, ServiceSettings serviceSettings)
Model(Model model, TaskSettings taskSettings)

Method Summary

Modifier and Type	Method	Description
static String	documentId(String modelId)
boolean	equals(Object o)
ModelConfigurations	getConfigurations()	Returns the model's non-sensitive configurations (e.g.
String	getInferenceEntityId()
ModelSecrets	getSecrets()	Returns the model's sensitive configurations (e.g.
SecretSettings	getSecretSettings()	Returns the inner sensitive data defined by a particular service.
ServiceSettings	getServiceSettings()
TaskSettings	getTaskSettings()
TaskType	getTaskType()
int	hashCode()
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

Constructor Details

Model

public Model(ModelConfigurations configurations,
 ModelSecrets secrets)

Model

public Model(Model model,
 TaskSettings taskSettings)

Model

public Model(Model model,
 ServiceSettings serviceSettings)

Model

public Model(ModelConfigurations configurations)

Model

public Model(StreamInput in)
      throws IOException

Throws:

IOException

Method Details

documentId

public static String documentId(String modelId)

getInferenceEntityId

public String getInferenceEntityId()

getTaskType

public TaskType getTaskType()

getConfigurations

public ModelConfigurations getConfigurations()

Returns the model's non-sensitive configurations (e.g. service name).

getSecrets

public ModelSecrets getSecrets()

Returns the model's sensitive configurations (e.g. api key). This returns an object that in json would look like:

 
 {
     "secret_settings": { "api_key": "abc" }
 }
 
 

getServiceSettings

public ServiceSettings getServiceSettings()

getTaskSettings

public TaskSettings getTaskSettings()

getSecretSettings

public SecretSettings getSecretSettings()

Returns the inner sensitive data defined by a particular service. This returns an object that in json would look like:

 
 {
     "api_key": "abc"
 }
 
 

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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