Package com.azure.ai.inference.models

Class ChatRequestDeveloperMessage

java.lang.Object
com.azure.ai.inference.models.ChatRequestMessage
com.azure.ai.inference.models.ChatRequestDeveloperMessage
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatRequestMessage>
public final class ChatRequestDeveloperMessage extends ChatRequestMessage
A request chat message containing developer instructions that influence how the model will generate a chat completions response. Some AI models support a developer message instead of a system message.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ChatRequestDeveloperMessage(String content)
    Creates an instance of ChatRequestDeveloperMessage class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ChatRequestDeveloperMessage
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ChatRequestDeveloperMessage from the JsonReader.
    String
    getContent()
    Get the content property: The contents of the developer message.
    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

    • ChatRequestDeveloperMessage

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

  • Method Details

    • getRole

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

    • getContent

      public String getContent()
      Get the content property: The contents of the developer message.
      Returns:
      the content 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 ChatRequestDeveloperMessage fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ChatRequestDeveloperMessage from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ChatRequestDeveloperMessage 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 ChatRequestDeveloperMessage.