enum OpenAI::ChatMessageRole

Defined in:

openai/api/chat.cr

Enum Members

User = 0

Can be generated by the end users of an application, or set by a developer as an instruction.

System = 1

The system message helps set the behavior of the assistant. GPT 3 does not always pay strong attention to system messages

Assistant = 2

The assistant messages help store prior responses. They can also be written by a developer to help give examples of desired behavior.

Function = 3

function

Tool = 4

tool

Instance Method Summary

Instance Method Detail

def assistant? #

[View source]
def function? #

[View source]
def system? #

[View source]
def to_s(io : IO) : Nil #
Description copied from struct Enum

Appends a String representation of this enum member to the given io.

See also: #to_s.


[View source]
def to_s : String #
Description copied from struct Enum

Returns a String representation of this enum member. In the case of regular enums, this is just the name of the member. In the case of flag enums, it's the names joined by vertical bars, or "None", if the value is zero.

If an enum's value doesn't match a member's value, the raw value is returned as a string.

Color::Red.to_s                     # => "Red"
IOMode::None.to_s                   # => "None"
(IOMode::Read | IOMode::Write).to_s # => "Read | Write"

Color.new(10).to_s # => "10"

[View source]
def tool? #

[View source]
def user? #

[View source]