FunctionShellToolParameter Class

Package:
com.azure.ai.agents.models
Maven Artifact:
com.azure:azure-ai-agents:2.2.0

public final class FunctionShellToolParameter
extends Tool

Shell tool A tool that allows the model to execute shell commands.

Constructor Summary

Constructor Description
FunctionShellToolParameter()

Creates an instance of FunctionShellToolParameter class.

Method Summary

Modifier and Type Method and Description
static FunctionShellToolParameter fromJson(JsonReader jsonReader)

Reads an instance of FunctionShellToolParameter from the JsonReader.
String getDescription()

Get the description property: Deprecated.
FunctionShellToolParamEnvironment getEnvironment()

Get the environment property: The environment property.
String getName()

Get the name property: Deprecated.
Map<String,ToolConfig> getToolConfigs()

Get the toolConfigs property: Deprecated.
ToolType getType()

Get the type property: The type property.
FunctionShellToolParameter setDescription(String description)

Set the description property: Deprecated.
FunctionShellToolParameter setEnvironment(FunctionShellToolParamEnvironment environment)

Set the environment property: The environment property.
FunctionShellToolParameter setName(String name)

Set the name property: Deprecated.
FunctionShellToolParameter setToolConfigs(Map<String,ToolConfig> toolConfigs)

Set the toolConfigs property: Deprecated.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from Tool

fromJson getType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FunctionShellToolParameter

public FunctionShellToolParameter()

Creates an instance of FunctionShellToolParameter class.

Method Details

fromJson

public static FunctionShellToolParameter fromJson(JsonReader jsonReader)

Reads an instance of FunctionShellToolParameter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of FunctionShellToolParameter if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the FunctionShellToolParameter.

getDescription

public String getDescription()

Get the description property: Deprecated. This property is deprecated and will be removed in a future version.

Returns:

the description value.

getEnvironment

public FunctionShellToolParamEnvironment getEnvironment()

Get the environment property: The environment property.

Returns:

the environment value.

getName

public String getName()

Get the name property: Deprecated. This property is deprecated and will be removed in a future version.

Returns:

the name value.

getToolConfigs

public Map<String,ToolConfig> getToolConfigs()

Get the toolConfigs property: Deprecated. This property is deprecated and will be removed in a future version.

Returns:

the toolConfigs value.

getType

public ToolType getType()

Get the type property: The type property.

Overrides:

FunctionShellToolParameter.getType()

Returns:

the type value.

setDescription

public FunctionShellToolParameter setDescription(String description)

Set the description property: Deprecated. This property is deprecated and will be removed in a future version.

Parameters:

description - the description value to set.

Returns:

the FunctionShellToolParameter object itself.

setEnvironment

public FunctionShellToolParameter setEnvironment(FunctionShellToolParamEnvironment environment)

Set the environment property: The environment property.

Parameters:

environment - the environment value to set.

Returns:

the FunctionShellToolParameter object itself.

setName

public FunctionShellToolParameter setName(String name)

Set the name property: Deprecated. This property is deprecated and will be removed in a future version.

Parameters:

name - the name value to set.

Returns:

the FunctionShellToolParameter object itself.

setToolConfigs

public FunctionShellToolParameter setToolConfigs(Map<String,ToolConfig> toolConfigs)

Set the toolConfigs property: Deprecated. This property is deprecated and will be removed in a future version.

Parameters:

toolConfigs - the toolConfigs value to set.

Returns:

the FunctionShellToolParameter object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

FunctionShellToolParameter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to