Package com.azure.ai.openai.models

Class ChatRole

java.lang.Object
com.azure.core.util.ExpandableStringEnum<ChatRole>
com.azure.ai.openai.models.ChatRole
public final class ChatRole extends com.azure.core.util.ExpandableStringEnum<ChatRole>
A description of the intended purpose of a message within a chat completions interaction.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ChatRole
    ASSISTANT
    The role that provides responses to system-instructed, user-prompted input.
    static final ChatRole
    SYSTEM
    The role that instructs or sets the behavior of the assistant.
    static final ChatRole
    USER
    The role that provides input for chat completions.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ChatRole()
    Deprecated.
    Use the fromString(String) factory method.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ChatRole
    fromString(String name)
    Creates or finds a ChatRole from its string representation.
    static Collection<ChatRole>
    values()
    Gets known ChatRole values.

    Methods inherited from class com.azure.core.util.ExpandableStringEnum

    equals, fromString, hashCode, toString, values

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • SYSTEM

      public static final ChatRole SYSTEM
      The role that instructs or sets the behavior of the assistant.

    • ASSISTANT

      public static final ChatRole ASSISTANT
      The role that provides responses to system-instructed, user-prompted input.

    • USER

      public static final ChatRole USER
      The role that provides input for chat completions.

  • Constructor Details

  • Method Details

    • fromString

      public static ChatRole fromString(String name)
      Creates or finds a ChatRole from its string representation.
      Parameters:
      name - a name to look for.
      Returns:
      the corresponding ChatRole.

    • values

      public static Collection<ChatRole> values()
      Gets known ChatRole values.
      Returns:
      known ChatRole values.