ToolConfig Class
- java.
lang. Object - com.
azure. ai. agents. models. ToolConfig
- com.
Implements
public final class ToolConfig
implements JsonSerializable<ToolConfig>
Per-tool configuration that controls tool visibility and search behavior.
Constructor Summary
| Constructor | Description |
|---|---|
| ToolConfig() |
Creates an instance of Tool |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
static
Tool |
fromJson(JsonReader jsonReader)
Reads an instance of Tool |
| String |
getAdditionalSearchText()
Get the additional |
| Boolean |
isPin()
Get the pin property: When true, the tool is always included in agent context and visible in `tools/list`. |
|
Tool |
setAdditionalSearchText(String additionalSearchText)
Set the additional |
|
Tool |
setPin(Boolean pin)
Set the pin property: When true, the tool is always included in agent context and visible in `tools/list`. |
|
Json |
toJson(JsonWriter jsonWriter) |
Methods inherited from java.lang.Object
Constructor Details
ToolConfig
public ToolConfig()
Creates an instance of ToolConfig class.
Method Details
fromJson
public static ToolConfig fromJson(JsonReader jsonReader)
Reads an instance of ToolConfig from the JsonReader.
Parameters:
Returns:
Throws:
getAdditionalSearchText
public String getAdditionalSearchText()
Get the additionalSearchText property: Additional text indexed for tool_search. Supplements the native tool description to improve discoverability. Does not alter `tools/list` output.
Returns:
isPin
public Boolean isPin()
Get the pin property: When true, the tool is always included in agent context and visible in `tools/list`. When false (default), the tool is hidden from `tools/list` and only discoverable via `tool_search`.
Returns:
setAdditionalSearchText
public ToolConfig setAdditionalSearchText(String additionalSearchText)
Set the additionalSearchText property: Additional text indexed for tool_search. Supplements the native tool description to improve discoverability. Does not alter `tools/list` output.
Parameters:
Returns:
setPin
public ToolConfig setPin(Boolean pin)
Set the pin property: When true, the tool is always included in agent context and visible in `tools/list`. When false (default), the tool is hidden from `tools/list` and only discoverable via `tool_search`.
Parameters:
Returns: