Share via

FileSearchToolResource 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.FileSearchToolResource

Implements

JsonSerializable<FileSearchToolResource>

public final class FileSearchToolResource
implements JsonSerializable<FileSearchToolResource>

A set of resources that are used by the `file_search` tool.

Constructor Summary

Constructor Description
FileSearchToolResource()

Creates an instance of FileSearchToolResource class.

Method Summary

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

Reads an instance of FileSearchToolResource from the JsonReader.
List<String> getVectorStoreIds()

Get the vectorStoreIds property: The ID of the vector store attached to this agent.
List<VectorStoreConfigurations> getVectorStores()

Get the vectorStores property: The list of vector store configuration objects from Azure.
FileSearchToolResource setVectorStoreIds(List<String> vectorStoreIds)

Set the vectorStoreIds property: The ID of the vector store attached to this agent.
FileSearchToolResource setVectorStores(List<VectorStoreConfigurations> vectorStores)

Set the vectorStores property: The list of vector store configuration objects from Azure.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FileSearchToolResource

public FileSearchToolResource()

Creates an instance of FileSearchToolResource class.

Method Details

fromJson

public static FileSearchToolResource fromJson(JsonReader jsonReader)

Reads an instance of FileSearchToolResource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getVectorStoreIds

public List<String> getVectorStoreIds()

Get the vectorStoreIds property: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent.

Returns:

the vectorStoreIds value.

getVectorStores

public List<VectorStoreConfigurations> getVectorStores()

Get the vectorStores property: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool.

Returns:

the vectorStores value.

setVectorStoreIds

public FileSearchToolResource setVectorStoreIds(List<String> vectorStoreIds)

Set the vectorStoreIds property: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent.

Parameters:

vectorStoreIds - the vectorStoreIds value to set.

Returns:

the FileSearchToolResource object itself.

setVectorStores

public FileSearchToolResource setVectorStores(List<VectorStoreConfigurations> vectorStores)

Set the vectorStores property: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool.

Parameters:

vectorStores - the vectorStores value to set.

Returns:

the FileSearchToolResource object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to