AzureFunctionTool Class

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

public final class AzureFunctionTool
extends Tool

The input definition information for an Azure Function Tool, as used to configure an Agent.

Constructor Summary

Constructor Description
AzureFunctionTool(AzureFunctionDefinition azureFunction)

Creates an instance of AzureFunctionTool class.

Method Summary

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

Reads an instance of AzureFunctionTool from the JsonReader.
AzureFunctionDefinition getAzureFunction()

Get the azureFunction property: The Azure Function Tool definition.
Map<String,ToolConfig> getToolConfigs()

Get the toolConfigs property: Deprecated.
ToolType getType()

Get the type property: The type property.
AzureFunctionTool 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

AzureFunctionTool

public AzureFunctionTool(AzureFunctionDefinition azureFunction)

Creates an instance of AzureFunctionTool class.

Parameters:

azureFunction - the azureFunction value to set.

Method Details

fromJson

public static AzureFunctionTool fromJson(JsonReader jsonReader)

Reads an instance of AzureFunctionTool from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getAzureFunction

public AzureFunctionDefinition getAzureFunction()

Get the azureFunction property: The Azure Function Tool definition.

Returns:

the azureFunction 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:

AzureFunctionTool.getType()

Returns:

the type value.

setToolConfigs

public AzureFunctionTool 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 AzureFunctionTool object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AzureFunctionTool.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to