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

Class ConnectedAgentToolDefinition

java.lang.Object
com.azure.ai.agents.persistent.models.ToolDefinition
com.azure.ai.agents.persistent.models.ConnectedAgentToolDefinition
All Implemented Interfaces:
com.azure.json.JsonSerializable<ToolDefinition>
public final class ConnectedAgentToolDefinition extends ToolDefinition
The input definition information for a connected agent tool which defines a domain specific sub-agent.

  • Constructor Details

    • ConnectedAgentToolDefinition

      public ConnectedAgentToolDefinition(ConnectedAgentDetails connectedAgent)
      Creates an instance of ConnectedAgentToolDefinition class.
      Parameters:
      connectedAgent - the connectedAgent 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.

    • getConnectedAgent

      public ConnectedAgentDetails getConnectedAgent()
      Get the connectedAgent property: The sub-agent to connect.
      Returns:
      the connectedAgent 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 ConnectedAgentToolDefinition fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ConnectedAgentToolDefinition from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ConnectedAgentToolDefinition 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 ConnectedAgentToolDefinition.