Package org.opensearch.ml.common.agent

Class MLAgent

java.lang.Object

org.opensearch.ml.common.agent.MLAgent

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

public class MLAgent
extends Object
implements org.opensearch.core.xcontent.ToXContentObject, org.opensearch.core.common.io.stream.Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MLAgent.MLAgentBuilder

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AGENT_NAME_FIELD
static final String	AGENT_TYPE_FIELD
static final String	APP_TYPE_FIELD
static final String	CREATED_TIME_FIELD
static final String	DESCRIPTION_FIELD
static final String	IS_HIDDEN_FIELD
static final String	LAST_UPDATED_TIME_FIELD
static final String	LLM_FIELD
static final String	MEMORY_FIELD
static final String	MEMORY_ID_FIELD
static final String	PARAMETERS_FIELD
static final String	TOOLS_FIELD

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MLAgent(String name, String type, String description, LLMSpec llm, List<MLToolSpec> tools, Map<String,String> parameters, MLMemorySpec memory, Instant createdTime, Instant lastUpdateTime, String appType, Boolean isHidden)
MLAgent(org.opensearch.core.common.io.stream.StreamInput input)

Method Summary

Modifier and Type	Method	Description
static MLAgent.MLAgentBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static MLAgent	fromStream(org.opensearch.core.common.io.stream.StreamInput in)
String	getAppType()
Instant	getCreatedTime()
String	getDescription()
Boolean	getIsHidden()
Instant	getLastUpdateTime()
LLMSpec	getLlm()
MLMemorySpec	getMemory()
String	getName()
Map<String,String>	getParameters()
List<MLToolSpec>	getTools()
String	getType()
int	hashCode()
static MLAgent	parse(org.opensearch.core.xcontent.XContentParser parser)
static MLAgent	parseFromUserInput(org.opensearch.core.xcontent.XContentParser parser)
MLAgent.MLAgentBuilder	toBuilder()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

AGENT_NAME_FIELD

public static final String AGENT_NAME_FIELD

See Also:

• Constant Field Values

AGENT_TYPE_FIELD

public static final String AGENT_TYPE_FIELD

See Also:

• Constant Field Values

DESCRIPTION_FIELD

public static final String DESCRIPTION_FIELD

See Also:

• Constant Field Values

LLM_FIELD

public static final String LLM_FIELD

See Also:

• Constant Field Values

TOOLS_FIELD

public static final String TOOLS_FIELD

See Also:

• Constant Field Values

PARAMETERS_FIELD

public static final String PARAMETERS_FIELD

See Also:

• Constant Field Values

MEMORY_FIELD

public static final String MEMORY_FIELD

See Also:

• Constant Field Values

MEMORY_ID_FIELD

public static final String MEMORY_ID_FIELD

See Also:

• Constant Field Values

CREATED_TIME_FIELD

public static final String CREATED_TIME_FIELD

See Also:

• Constant Field Values

LAST_UPDATED_TIME_FIELD

public static final String LAST_UPDATED_TIME_FIELD

See Also:

• Constant Field Values

APP_TYPE_FIELD

public static final String APP_TYPE_FIELD

See Also:

• Constant Field Values

IS_HIDDEN_FIELD

public static final String IS_HIDDEN_FIELD

See Also:

• Constant Field Values

Constructor Details

MLAgent

public MLAgent(String name,
 String type,
 String description,
 LLMSpec llm,
 List<MLToolSpec> tools,
 Map<String,String> parameters,
 MLMemorySpec memory,
 Instant createdTime,
 Instant lastUpdateTime,
 String appType,
 Boolean isHidden)

MLAgent

public MLAgent(org.opensearch.core.common.io.stream.StreamInput input)
        throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

parse

public static MLAgent parse(org.opensearch.core.xcontent.XContentParser parser)
                     throws IOException

Throws:

IOException

parseFromUserInput

public static MLAgent parseFromUserInput(org.opensearch.core.xcontent.XContentParser parser)
                                  throws IOException

Throws:

IOException

fromStream

public static MLAgent fromStream(org.opensearch.core.common.io.stream.StreamInput in)
                          throws IOException

Throws:

IOException

builder

public static MLAgent.MLAgentBuilder builder()

toBuilder

public MLAgent.MLAgentBuilder toBuilder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getName

public String getName()

getType

public String getType()

getDescription

public String getDescription()

getLlm

public LLMSpec getLlm()

getTools

public List<MLToolSpec> getTools()

getParameters

public Map<String,String> getParameters()

getMemory

public MLMemorySpec getMemory()

getCreatedTime

public Instant getCreatedTime()

getLastUpdateTime

public Instant getLastUpdateTime()

getAppType

public String getAppType()

getIsHidden

public Boolean getIsHidden()