Class Message

Namespace

Glitch9.AIDevKit

public abstract class Message : StatefulItem, IPromptWithFiles, IPrompt, IModeratable

Inheritance

object

ConversationItem

StatefulItem

Message

Implements

IPromptWithFiles

IPrompt

IModeratable

Derived

ThreadMessage

ResponseMessage

SystemMessage

ToolMessage

UserMessage

Inherited Members

StatefulItem.Status

ConversationItem.Id

ConversationItem.Type

Extension Methods

FluentApiRequestCallerExt.GENResponse(ConversationItem)

FluentApiRequestCallerExt.GENModeration(IModeratable, IEnumerable<SafetySetting>)

IPromptExtensions.Validate(IPrompt)

ConversationExtensions.ToConversationItems(Message)

FluentApiRequestCallerExt.CountTokens(Message)

FluentApiRequestCallerExt.GENCompletion(Message)

MessageMapper.Add(Message, AudioClip)

MessageMapper.Add(Message, IFile)

MessageMapper.Add(Message, Texture2D)

MessageMapper.AddImageUrls(Message, List<string>)

MessageMapper.AddRange(Message, IEnumerable<AudioClip>)

MessageMapper.AddRange(Message, IEnumerable<IFile>)

MessageMapper.AddRange(Message, IEnumerable<Texture2D>)

MessageMapper.ExtractImageDataList(Message)

MessageMapper.GetPromptInputFiles(Message)

MessageMapper.IsPromptValid(Message)

MessageMapper.LoadPromptFilesAsync(Message)

MessageMapper.PromptRequiresLoading(Message)

MessageMapper.ToModerationPromptInternal(Message)

ThreadMessageExtensions.ToThreadMessageRequest(Message)

PerplexityMapper_Input.ToPerplexityMessage(Message)

Constructors

Message()

protected Message()

Message(MessageContent)

protected Message(MessageContent content = null)

Parameters

content MessageContent

Properties

Content

The contents of the user message.

public MessageContent Content { get; set; }

Property Value

MessageContent

CreatedAt

public UnixTime CreatedAt { get; }

Property Value

UnixTime

DisplayMessage

public string DisplayMessage { get; set; }

Property Value

string

Name

Optional. An optional name for the participant. Provides the model information to differentiate between participants of the same role.

public string Name { get; set; }

Property Value

string

PromptType

public override PromptType PromptType { get; }

Property Value

PromptType

Role

The role of the messages author.

Role is abstract and overridden in derived classes to enforce consistency.
This avoids relying on constructor or deserialization logic to set the role.
JSON.NET does not call parameterized constructors or set get-only properties during deserialization.

public abstract ChatRole Role { get; }

Property Value

ChatRole

ThreadId

The conversation thread that this message belongs to.

public string ThreadId { get; set; }

Property Value

string

Methods

Create(ChatRole, MessageContent, UnixTime?, string)

public static Message Create(ChatRole role, MessageContent content = null, UnixTime? createdAt = null, string threadId = null)

Parameters

role ChatRole

content MessageContent

createdAt UnixTime?

threadId string

Returns

Message

Create(MessageContent, UnixTime?, string)

public static Message Create(MessageContent content, UnixTime? createdAt = null, string threadId = null)

Parameters

content MessageContent

createdAt UnixTime?

threadId string

Returns

Message

GetInputFiles()

public List<IFile> GetInputFiles()

Returns

List<IFile>

GetInputText()

public override string GetInputText()

Returns

string

GetMessageText()

public string GetMessageText()

Returns

string

IsValid()

public override bool IsValid()

Returns

bool

LoadFilesAsync()

public UniTask LoadFilesAsync()

Returns

UniTask

RequiresLoading()

public bool RequiresLoading()

Returns

bool

ToModerationPrompt()

public ModerationPrompt ToModerationPrompt()

Returns

ModerationPrompt

ToString()

public override string ToString()

Returns

string

Operators

implicit operator string(Message)

public static implicit operator string(Message message)

Parameters

message Message

Returns

string

implicit operator Message(Prompt)

public static implicit operator Message(Prompt prompt)

Parameters

prompt Prompt

Returns

Message

implicit operator Message(string)

public static implicit operator Message(string message)

Parameters

message string

Returns

Message