Class ToolMessage

Hierarchy (View Summary)

BaseMessage
- ToolMessage

Implements

MessageClass

Index

Constructors

constructor

Properties

_content _name _rawData? _role _tool_call_id

Accessors

content name rawData role tool_call_id

Methods

contentToString toAnthropicMessage toGoogleMessage toJSON toOllamaMessage toOpenAIMessage toOpenAIResponseInputItem fromJSON

Constructors

constructor

new ToolMessage(
content: string | TextPart[],
options: { name: string; rawData?: any; tool_call_id: string },
): ToolMessage
Parameters
- content: string | TextPart[]
- options: { name: string; rawData?: any; tool_call_id: string }
Returns ToolMessage

Overrides BaseMessage.constructor

Properties

_content

_content: string | TextPart[]

_name

_name: string

`Optional`_rawData

_rawData?: any

_role

_role: "tool" = ...

_tool_call_id

_tool_call_id: string

Accessors

content

get content(): string

Returns string

Implementation of MessageClass.content
set content(value: string): void
Parameters
- value: string
Returns void

Implementation of MessageClass.content

name

get name(): string

Returns string

Implementation of MessageClass.name

rawData

get rawData(): any

Returns any

Implementation of MessageClass.rawData

role

get role(): "tool"

Returns "tool"

Implementation of MessageClass.role

tool_call_id

get tool_call_id(): string

Returns string

Methods

`Protected`contentToString

contentToString(content: string | unknown[] | null | undefined): string
Parameters
- content: string | unknown[] | null | undefined
Returns string

Inherited from BaseMessage.contentToString

toAnthropicMessage

toAnthropicMessage(): {
    content: { content: string; tool_use_id: string; type: "tool_result" }[];
    role: "user";
}

Returns {
    content: { content: string; tool_use_id: string; type: "tool_result" }[];
    role: "user";
}

toGoogleMessage

toGoogleMessage(): Content

Returns Content

Implementation of MessageClass.toGoogleMessage

toJSON

toJSON(): {
    content: string
    | { text: string; type: "text" }[];
    name: string;
    rawData?: any;
    role: "tool";
    tool_call_id: string;
}

Returns {
    content: string | { text: string; type: "text" }[];
    name: string;
    rawData?: any;
    role: "tool";
    tool_call_id: string;
}

Implementation of MessageClass.toJSON

toOllamaMessage

toOllamaMessage(): Message

Returns Message

Implementation of MessageClass.toOllamaMessage

toOpenAIMessage

toOpenAIMessage(): ChatCompletionMessageParam

Returns ChatCompletionMessageParam

Implementation of MessageClass.toOpenAIMessage

toOpenAIResponseInputItem

toOpenAIResponseInputItem(): ResponseInputItem

Returns ResponseInputItem

Implementation of MessageClass.toOpenAIResponseInputItem

`Static`fromJSON

fromJSON(json: unknown): ToolMessage
Parameters
- json: unknown
Returns ToolMessage