Package com.microsoft.semantickernel.services.chatcompletion

Enum AuthorRole

java.lang.Object

java.lang.Enum<AuthorRole>

com.microsoft.semantickernel.services.chatcompletion.AuthorRole

All Implemented Interfaces:

Serializable, Comparable<AuthorRole>

public enum AuthorRole
extends Enum<AuthorRole>

Role of the author of a chat message

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSISTANT	An assistant message is a message generated by the assistant.
SYSTEM	A system message helps set the behavior of the assistant.
TOOL	A tool message is a message generated by a tool.
USER	A user message is a message generated by the user.

Method Summary

Modifier and Type	Method	Description
String	toString()
static AuthorRole	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AuthorRole[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SYSTEM

public static final AuthorRole SYSTEM

A system message helps set the behavior of the assistant.

ASSISTANT

public static final AuthorRole ASSISTANT

An assistant message is a message generated by the assistant.

USER

public static final AuthorRole USER

A user message is a message generated by the user.

TOOL

public static final AuthorRole TOOL

A tool message is a message generated by a tool.

Method Detail

values

public static AuthorRole[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AuthorRole c : AuthorRole.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AuthorRole valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<AuthorRole>