Package com.azure.ai.inference.models

Class ChatRequestUserMessage

java.lang.Object
com.azure.ai.inference.models.ChatRequestMessage
com.azure.ai.inference.models.ChatRequestUserMessage
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatRequestMessage>
public final class ChatRequestUserMessage extends ChatRequestMessage
A request chat message representing user input to the assistant.

  • Constructor Details

    • ChatRequestUserMessage

      public ChatRequestUserMessage(com.azure.core.util.BinaryData content)
      Creates an instance of ChatRequestUserMessage class.
      Parameters:
      content - the content value to set.

    • ChatRequestUserMessage

      public ChatRequestUserMessage(String content)
      Creates an instance of ChatRequestUserMessage class.
      Parameters:
      content - the string 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 com.azure.core.util.BinaryData getContent()
      Get the content property: The contents of the user message, with available input types varying by selected model.
      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 ChatRequestUserMessage fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ChatRequestUserMessage from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ChatRequestUserMessage 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 ChatRequestUserMessage.

    • fromString

      public static ChatRequestUserMessage fromString(String content)
      Creates an instance of ChatRequestUserMessage class.
      Parameters:
      content - the content value to set.
      Returns:
      An instance of ChatRequestUserMessage if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      RuntimeException - If the deserialized JSON object was missing any required properties.

    • fromContentItems

      public static ChatRequestUserMessage fromContentItems(List<ChatMessageContentItem> contentItems)
      Creates an instance of ChatRequestUserMessage class.
      Parameters:
      contentItems - An array of content items to include in the message.
      Returns:
      An instance of ChatRequestUserMessage if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      RuntimeException - If the deserialized JSON object was missing any required properties.