Class AssistantMessage

Hierarchy (View Summary)

BaseMessage
- AssistantMessage

Implements

MessageClass

Index

Constructors

constructor

Properties

_audio? _content _cost? _name? _rawData? _refusal? _role _thinkingBlocks? _toolCalls? _usage?

Accessors

audio content cost name rawData refusal role thinkingBlocks toolCalls usage

Methods

contentToString toAnthropicMessage toGoogleMessage toJSON toOllamaMessage toOpenAIMessage toOpenAIResponseInputItem fromJSON

Constructors

constructor

new AssistantMessage(
    content: string | TextPart[] | null,
    options?: {
        audio?: any;
        cost?: CostEstimate;
        name?: string;
        rawData?: any;
        refusal?: string | null;
        thinkingBlocks?: ThinkingBlock[];
        toolCalls?: ToolCall[];
        usage?: TokenUsage;
    },
): AssistantMessage
Parameters
- content: string | TextPart[] | null
- options: {
      audio?: any;
      cost?: CostEstimate;
      name?: string;
      rawData?: any;
      refusal?: string | null;
      thinkingBlocks?: ThinkingBlock[];
      toolCalls?: ToolCall[];
      usage?: TokenUsage;
  } = {}
Returns AssistantMessage

Overrides BaseMessage.constructor

Properties

`Optional`_audio

_audio?: any

_content

_content: string | TextPart[] | null

`Optional`_cost

_cost?: CostEstimate

`Optional`_name

_name?: string

`Optional`_rawData

_rawData?: any

`Optional`_refusal

_refusal?: string | null

_role

_role: "assistant" = ...

`Optional`_thinkingBlocks

_thinkingBlocks?: ThinkingBlock[]

`Optional`_toolCalls

_toolCalls?: ToolCall[]

`Optional`_usage

_usage?: TokenUsage

Accessors

audio

get audio(): any

Returns any

content

get content(): string

Returns string

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

Implementation of MessageClass.content

cost

get cost(): CostEstimate | undefined

Returns CostEstimate | undefined

name

get name(): string | undefined

Returns string | undefined

Implementation of MessageClass.name

rawData

get rawData(): any

Returns any

Implementation of MessageClass.rawData

refusal

get refusal(): string | null | undefined

Returns string | null | undefined

role

get role(): "assistant"

Returns "assistant"

Implementation of MessageClass.role

thinkingBlocks

get thinkingBlocks(): ThinkingBlock[] | undefined

Returns ThinkingBlock[] | undefined

toolCalls

get toolCalls(): ToolCall[] | undefined

Returns ToolCall[] | undefined

usage

get usage(): TokenUsage | undefined

Returns TokenUsage | undefined

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: | string
    | (
        | { signature: string; thinking: string; type: "thinking" }
        | { text: string; type: "text" }
        | {
            id: string;
            input: Record<string, any>;
            name: string;
            type: "tool_use";
        }
    )[];
    role: "assistant";
}

Returns {
    content:
        | string
        | (
            | { signature: string; thinking: string; type: "thinking" }
            | { text: string; type: "text" }
            | {
                id: string;
                input: Record<string, any>;
                name: string;
                type: "tool_use";
            }
        )[];
    role: "assistant";
}

toGoogleMessage

toGoogleMessage(): Content

Returns Content

Implementation of MessageClass.toGoogleMessage

toJSON

toJSON(): {
    audio?: any;
    content: string
    | { text: string; type: "text" }[]
    | null;
    cost?: {
        cachedInputCost?: number;
        currency: string;
        inputCost: number;
        outputCost: number;
        totalCost: number;
    };
    name?: string;
    rawData?: any;
    refusal?: string
    | null;
    role: "assistant";
    thinkingBlocks?: { signature: string; text: string }[];
    toolCalls?: { arguments: Record<string, any>; id: string; name: string }[];
    usage?: {
        cachedInputTokens?: number;
        inputTokens: number;
        outputTokens: number;
        totalTokens?: number;
    };
}

Returns {
    audio?: any;
    content: string | { text: string; type: "text" }[] | null;
    cost?: {
        cachedInputCost?: number;
        currency: string;
        inputCost: number;
        outputCost: number;
        totalCost: number;
    };
    name?: string;
    rawData?: any;
    refusal?: string
    | null;
    role: "assistant";
    thinkingBlocks?: { signature: string; text: string }[];
    toolCalls?: { arguments: Record<string, any>; id: string; name: string }[];
    usage?: {
        cachedInputTokens?: number;
        inputTokens: number;
        outputTokens: number;
        totalTokens?: number;
    };
}

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 | ResponseInputItem[]

Returns ResponseInputItem | ResponseInputItem[]

Implementation of MessageClass.toOpenAIResponseInputItem

`Static`fromJSON

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