Uses of Class
com.azure.ai.openai.models.ChatRole

Packages that use ChatRole
Package
Description
Package containing the data models for OpenAI.
  • Uses of ChatRole in com.azure.ai.openai.models

    Fields in com.azure.ai.openai.models declared as ChatRole
    Modifier and Type
    Field
    Description
    static final ChatRole
    ChatRole.ASSISTANT
    The role that provides responses to system-instructed, user-prompted input.
    static final ChatRole
    ChatRole.FUNCTION
    The role that provides function results for chat completions.
    static final ChatRole
    ChatRole.SYSTEM
    The role that instructs or sets the behavior of the assistant.
    static final ChatRole
    ChatRole.TOOL
    The role that represents extension tool activity within a chat completions operation.
    static final ChatRole
    ChatRole.USER
    The role that provides input for chat completions.
    Methods in com.azure.ai.openai.models that return ChatRole
    Modifier and Type
    Method
    Description
    static ChatRole
    ChatRole.fromString(String name)
    Creates or finds a ChatRole from its string representation.
    ChatRequestAssistantMessage.getRole()
    Get the role property: The chat role associated with this message.
    ChatRequestFunctionMessage.getRole()
    Get the role property: The chat role associated with this message.
    ChatRequestMessage.getRole()
    Get the role property: The chat role associated with this message.
    ChatRequestSystemMessage.getRole()
    Get the role property: The chat role associated with this message.
    ChatRequestToolMessage.getRole()
    Get the role property: The chat role associated with this message.
    ChatRequestUserMessage.getRole()
    Get the role property: The chat role associated with this message.
    ChatResponseMessage.getRole()
    Get the role property: The chat role associated with the message.
    Methods in com.azure.ai.openai.models that return types with arguments of type ChatRole
    Modifier and Type
    Method
    Description
    ChatRole.values()
    Gets known ChatRole values.