Package com.azure.ai.openai.models

Class ChatRequestToolMessage

java.lang.Object
com.azure.ai.openai.models.ChatRequestMessage
com.azure.ai.openai.models.ChatRequestToolMessage
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatRequestMessage>
public final class ChatRequestToolMessage extends ChatRequestMessage
A request chat message representing requested output from a configured tool.

  • Constructor Details

    • ChatRequestToolMessage

      public ChatRequestToolMessage(String content, String toolCallId)
      Creates an instance of ChatRequestToolMessage class.
      Parameters:
      content - the String content value to set.
      toolCallId - the toolCallId value to set.

    • ChatRequestToolMessage

      public ChatRequestToolMessage(List<ChatMessageContentItem> content, String toolCallId)
      Creates an instance of ChatRequestToolMessage class.
      Parameters:
      content - the List of ChatMessageContentItem content value to set.
      toolCallId - the toolCallId value to set.

  • Method Details

    • getContent

      public com.azure.core.util.BinaryData getContent()
      Get the content property: The content of the message.
      Returns:
      the content value.

    • getToolCallId

      public String getToolCallId()
      Get the toolCallId property: The ID of the tool call resolved by the provided content.
      Returns:
      the toolCallId value.

    • getRole

      public ChatRole getRole()
      Get the role property: The chat role associated with this message.
      Overrides:
      getRole in class ChatRequestMessage
      Returns:
      the role value.

    • toJson

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

    • fromJson

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