Package com.azure.ai.agents.persistent.models

Class FileSearchToolDefinition

java.lang.Object
com.azure.ai.agents.persistent.models.ToolDefinition
com.azure.ai.agents.persistent.models.FileSearchToolDefinition
All Implemented Interfaces:
com.azure.json.JsonSerializable<ToolDefinition>
public final class FileSearchToolDefinition extends ToolDefinition
The input definition information for a file search tool as used to configure an agent.

  • Constructor Details

    • FileSearchToolDefinition

      public FileSearchToolDefinition()
      Creates an instance of FileSearchToolDefinition class.

  • Method Details

    • getType

      public String getType()
      Get the type property: The object type.
      Overrides:
      getType in class ToolDefinition
      Returns:
      the type value.

    • getFileSearch

      public FileSearchToolDefinitionDetails getFileSearch()
      Get the fileSearch property: Options overrides for the file search tool.
      Returns:
      the fileSearch value.

    • setFileSearch

      public FileSearchToolDefinition setFileSearch(FileSearchToolDefinitionDetails fileSearch)
      Set the fileSearch property: Options overrides for the file search tool.
      Parameters:
      fileSearch - the fileSearch value to set.
      Returns:
      the FileSearchToolDefinition object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ToolDefinition>
      Overrides:
      toJson in class ToolDefinition
      Throws:
      IOException

    • fromJson

      public static FileSearchToolDefinition fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of FileSearchToolDefinition from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of FileSearchToolDefinition 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 FileSearchToolDefinition.