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

Class MessageDeltaTextUrlCitationAnnotation

java.lang.Object
com.azure.ai.agents.persistent.models.MessageDeltaTextAnnotation
com.azure.ai.agents.persistent.models.MessageDeltaTextUrlCitationAnnotation
All Implemented Interfaces:
com.azure.json.JsonSerializable<MessageDeltaTextAnnotation>
public final class MessageDeltaTextUrlCitationAnnotation extends MessageDeltaTextAnnotation
A citation within the message that points to a specific URL associated with the message. Generated when the agent uses tools such as 'bing_grounding' to search the Internet.

  • Method Details

    • getType

      public String getType()
      Get the type property: The type of the text content annotation.
      Overrides:
      getType in class MessageDeltaTextAnnotation
      Returns:
      the type value.

    • getUrlCitation

      public MessageDeltaTextUrlCitationDetails getUrlCitation()
      Get the urlCitation property: The details of the URL citation.
      Returns:
      the urlCitation value.

    • getStartIndex

      public Integer getStartIndex()
      Get the startIndex property: The first text index associated with this text annotation.
      Returns:
      the startIndex value.

    • getEndIndex

      public Integer getEndIndex()
      Get the endIndex property: The last text index associated with this text annotation.
      Returns:
      the endIndex value.

    • toJson

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

    • fromJson

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