Class SystemMessage

Represents a system message in a conversation.

Hierarchy (view full)

BaseMessage
- SystemMessage

Index

Constructors

Properties

additional_kwargs content response_metadata name?

Accessors

Methods

toDict toJSON toJSONNotImplemented

Constructors

constructor

new SystemMessage(fields, kwargs?): SystemMessage
Parameters
- fields: string | BaseMessageFields
- Optional kwargs: Record<string, unknown>
  Deprecated
Returns SystemMessage
Inherited from BaseMessage.constructor
- Defined in langchain-core/src/messages/base.ts:176

Properties

additional_kwargs

additional_kwargs: {
    function_call?: FunctionCall;
    tool_calls?: ToolCall[];
    [key: string]: unknown;
}

Additional keyword arguments

Type declaration

[key: string]: unknown
Optional function_call?: FunctionCall
Optional tool_calls?: ToolCall[]

content

content: MessageContent

The content of the message.

response_metadata

response_metadata: Record<string, any>

Response metadata. For example: response headers, logprobs, token counts.

`Optional` name

name?: string

The name of the message sender in a multi-user chat.

Accessors

text

get text(): string
Returns string

⚠️ Deprecated ⚠️

Use BaseMessage.content instead.

This feature is deprecated and will be removed in the future.

It is not recommended for use.
Inherited from BaseMessage.text
- Defined in langchain-core/src/messages/base.ts:157

Methods

toDict

toDict(): StoredMessage
Returns StoredMessage
Inherited from BaseMessage.toDict
- Defined in langchain-core/src/messages/base.ts:205

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseMessage.toJSON
- Defined in langchain-core/src/load/serializable.ts:147

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseMessage.toJSONNotImplemented
- Defined in langchain-core/src/load/serializable.ts:221

Generated using TypeDoc