Class ToolMessage

Namespace

Glitch9.AIDevKit

API don't send these anymore. It is only used to send the tool outputs from the 'client' side.

public class ToolMessage : Message, IPromptWithFiles, IPrompt, IModeratable

Inheritance

object

ConversationItem

StatefulItem

Message

ToolMessage

Implements

IPromptWithFiles

IPrompt

IModeratable

Inherited Members

Message.Content

Message.ThreadId

Message.Name

Message.CreatedAt

Message.DisplayMessage

Message.Create(MessageContent, UnixTime?, string)

Message.Create(ChatRole, MessageContent, UnixTime?, string)

Message.ToString()

Message.GetMessageText()

Message.RequiresLoading()

Message.LoadFilesAsync()

Message.ToModerationPrompt()

Message.GetInputFiles()

Message.PromptType

Message.IsValid()

Message.GetInputText()

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

ToolMessage()

public ToolMessage()

ToolMessage(MessageContent)

public ToolMessage(MessageContent content)

Parameters

content MessageContent

ToolMessage(string, string)

public ToolMessage(string toolCallId, string result)

Parameters

toolCallId string

result string

Properties

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 override ChatRole Role { get; }

Property Value

ChatRole

ToolCallId

Required. The ID of the tool call that produced this output.

public string ToolCallId { get; set; }

Property Value

string

Operators

implicit operator string(ToolMessage)

public static implicit operator string(ToolMessage message)

Parameters

message ToolMessage

Returns

string