Package org.opensearch.ml.common.agent

Class MLToolSpec

java.lang.Object

org.opensearch.ml.common.agent.MLToolSpec

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

public class MLToolSpec
extends Object
implements org.opensearch.core.xcontent.ToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MLToolSpec.MLToolSpecBuilder

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCRIPTION_FIELD
static final String	INCLUDE_OUTPUT_IN_AGENT_RESPONSE
static final String	PARAMETERS_FIELD
static final String	TOOL_NAME_FIELD
static final String	TOOL_TYPE_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MLToolSpec(String type, String name, String description, Map<String,String> parameters, boolean includeOutputInAgentResponse)
MLToolSpec(org.opensearch.core.common.io.stream.StreamInput input)

Method Summary

Modifier and Type	Method	Description
static MLToolSpec.MLToolSpecBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static MLToolSpec	fromStream(org.opensearch.core.common.io.stream.StreamInput in)
String	getDescription()
String	getName()
Map<String,String>	getParameters()
String	getType()
int	hashCode()
boolean	isIncludeOutputInAgentResponse()
static MLToolSpec	parse(org.opensearch.core.xcontent.XContentParser parser)
MLToolSpec.MLToolSpecBuilder	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

TOOL_TYPE_FIELD

public static final String TOOL_TYPE_FIELD

See Also:

• Constant Field Values

TOOL_NAME_FIELD

public static final String TOOL_NAME_FIELD

See Also:

• Constant Field Values

DESCRIPTION_FIELD

public static final String DESCRIPTION_FIELD

See Also:

• Constant Field Values

PARAMETERS_FIELD

public static final String PARAMETERS_FIELD

See Also:

• Constant Field Values

INCLUDE_OUTPUT_IN_AGENT_RESPONSE

public static final String INCLUDE_OUTPUT_IN_AGENT_RESPONSE

See Also:

• Constant Field Values

Constructor Details

MLToolSpec

public MLToolSpec(String type,
 String name,
 String description,
 Map<String,String> parameters,
 boolean includeOutputInAgentResponse)

MLToolSpec

public MLToolSpec(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

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 MLToolSpec parse(org.opensearch.core.xcontent.XContentParser parser)
                        throws IOException

Throws:

IOException

fromStream

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

Throws:

IOException

builder

public static MLToolSpec.MLToolSpecBuilder builder()

toBuilder

public MLToolSpec.MLToolSpecBuilder 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

getType

public String getType()

getName

public String getName()

getDescription

public String getDescription()

getParameters

public Map<String,String> getParameters()

isIncludeOutputInAgentResponse

public boolean isIncludeOutputInAgentResponse()