Package com.azure.ai.inference.models

Class ChatRequestSystemMessage

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

  • Constructor Summary

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

  • Method Summary

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

    • ChatRequestSystemMessage

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