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

Class ConnectedAgentDetails

java.lang.Object
com.azure.ai.agents.persistent.models.ConnectedAgentDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<ConnectedAgentDetails>
public final class ConnectedAgentDetails extends Object implements com.azure.json.JsonSerializable<ConnectedAgentDetails>
Information for connecting one agent to another as a tool.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConnectedAgentDetails(String id, String name, String description)
    Creates an instance of ConnectedAgentDetails class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ConnectedAgentDetails
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ConnectedAgentDetails from the JsonReader.
    String
    getDescription()
    Get the description property: A description of what the agent does, used by the model to choose when and how to call the agent.
    String
    getId()
    Get the id property: The identifier of the child agent.
    String
    getName()
    Get the name property: The name of the agent to be called.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • ConnectedAgentDetails

      public ConnectedAgentDetails(String id, String name, String description)
      Creates an instance of ConnectedAgentDetails class.
      Parameters:
      id - the id value to set.
      name - the name value to set.
      description - the description value to set.

  • Method Details

    • getId

      public String getId()
      Get the id property: The identifier of the child agent.
      Returns:
      the id value.

    • getName

      public String getName()
      Get the name property: The name of the agent to be called.
      Returns:
      the name value.

    • getDescription

      public String getDescription()
      Get the description property: A description of what the agent does, used by the model to choose when and how to call the agent.
      Returns:
      the description value.

    • toJson

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

    • fromJson

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