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 Summary

    Constructors
    Constructor
    Description
    ChatRequestToolMessage(String content, String toolCallId)
    Creates an instance of ChatRequestToolMessage class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ChatRequestToolMessage
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ChatRequestToolMessage from the JsonReader.
    String
    getContent()
    Get the content property: The content of the message.
    ChatRole
    getRole()
    Get the role property: The chat role associated with this message.
    String
    getToolCallId()
    Get the toolCallId property: The ID of the tool call resolved by the provided content.
    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

    • ChatRequestToolMessage

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

  • Method Details

    • getContent

      public String 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.