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

Class BingGroundingToolDefinition

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

  • Constructor Details

    • BingGroundingToolDefinition

      public BingGroundingToolDefinition(BingGroundingSearchToolParameters bingGrounding)
      Creates an instance of BingGroundingToolDefinition class.
      Parameters:
      bingGrounding - the bingGrounding value to set.

  • Method Details

    • getType

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

    • getBingGrounding

      public BingGroundingSearchToolParameters getBingGrounding()
      Get the bingGrounding property: The bing grounding search tool parameters.
      Returns:
      the bingGrounding value.

    • 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 BingGroundingToolDefinition fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of BingGroundingToolDefinition from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of BingGroundingToolDefinition if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the BingGroundingToolDefinition.