ToolResources Class

Package:

com.azure.ai.agents.persistent.models

Maven Artifact:

com.azure:azure-ai-agents-persistent:1.0.0-beta.2

• java.lang.Object
• • com.azure.ai.agents.persistent.models.ToolResources

Implements

JsonSerializable<ToolResources>

public final class ToolResources
implements JsonSerializable<ToolResources>

A set of resources that are used by the agent's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.

Constructor Summary

Constructor	Description
ToolResources()	Creates an instance of ToolResources class.

Method Summary

Modifier and Type	Method and Description
static ToolResources	fromJson(JsonReader jsonReader) Reads an instance of ToolResources from the JsonReader.
AzureAISearchToolResource	getAzureAISearch() Get the azureAISearch property: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names.
CodeInterpreterToolResource	getCodeInterpreter() Get the codeInterpreter property: Resources to be used by the `code_interpreter` tool consisting of file IDs.
FileSearchToolResource	getFileSearch() Get the fileSearch property: Resources to be used by the `file_search` tool consisting of vector store IDs.
ToolResources	setAzureAISearch(AzureAISearchToolResource azureAISearch) Set the azureAISearch property: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names.
ToolResources	setCodeInterpreter(CodeInterpreterToolResource codeInterpreter) Set the codeInterpreter property: Resources to be used by the `code_interpreter` tool consisting of file IDs.
ToolResources	setFileSearch(FileSearchToolResource fileSearch) Set the fileSearch property: Resources to be used by the `file_search` tool consisting of vector store IDs.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ToolResources

public ToolResources()

Creates an instance of ToolResources class.

Method Details

fromJson

public static ToolResources fromJson(JsonReader jsonReader)

Reads an instance of ToolResources from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ToolResources 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 ToolResources.

getAzureAISearch

public AzureAISearchToolResource getAzureAISearch()

Get the azureAISearch property: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names.

Returns:

the azureAISearch value.

getCodeInterpreter

public CodeInterpreterToolResource getCodeInterpreter()

Get the codeInterpreter property: Resources to be used by the `code_interpreter` tool consisting of file IDs.

Returns:

the codeInterpreter value.

getFileSearch

public FileSearchToolResource getFileSearch()

Get the fileSearch property: Resources to be used by the `file_search` tool consisting of vector store IDs.

Returns:

the fileSearch value.

setAzureAISearch

public ToolResources setAzureAISearch(AzureAISearchToolResource azureAISearch)

Set the azureAISearch property: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names.

Parameters:

azureAISearch - the azureAISearch value to set.

Returns:

the ToolResources object itself.

setCodeInterpreter

public ToolResources setCodeInterpreter(CodeInterpreterToolResource codeInterpreter)

Set the codeInterpreter property: Resources to be used by the `code_interpreter` tool consisting of file IDs.

Parameters:

codeInterpreter - the codeInterpreter value to set.

Returns:

the ToolResources object itself.

setFileSearch

public ToolResources setFileSearch(FileSearchToolResource fileSearch)

Set the fileSearch property: Resources to be used by the `file_search` tool consisting of vector store IDs.

Parameters:

fileSearch - the fileSearch value to set.

Returns:

the ToolResources object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException