Package com.azure.ai.openai.models

Class ChatRequestFunctionMessage

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    ChatRequestFunctionMessage(String name, String content)
    Creates an instance of ChatRequestFunctionMessage class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ChatRequestFunctionMessage
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ChatRequestFunctionMessage from the JsonReader.
    String
    getContent()
    Get the content property: The output of the function as requested by the function call.
    String
    getName()
    Get the name property: The name of the function that was called to produce output.
    ChatRole
    getRole()
    Get the role property: The chat role associated with this message.
    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

    • ChatRequestFunctionMessage

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

  • Method Details

    • getName

      public String getName()
      Get the name property: The name of the function that was called to produce output.
      Returns:
      the name value.

    • getContent

      public String getContent()
      Get the content property: The output of the function as requested by the function call.
      Returns:
      the content 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 ChatRequestFunctionMessage fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ChatRequestFunctionMessage from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ChatRequestFunctionMessage 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 ChatRequestFunctionMessage.