Message

Defines the message schema.

Authors

Henry Wicaksono (henry.wicaksono@gdplabs.id)

References

NONE

Message

Bases: BaseModel

Defines a message schema to be used as inputs for a language model.

Attributes:

Name	Type	Description
role	MessageRole	The role of the message.
contents	list[MessageContent]	The contents of the message.
metadata	dict[str, Any]	The metadata of the message.

assistant(contents, metadata=None) classmethod

Create an assistant message.

Parameters:

Name	Type	Description	Default
contents	MessageContent | list[MessageContent]	The message contents. If a single content is provided, it will be wrapped in a list.	required
metadata	dict[str, Any]	Additional metadata for the message. Defaults to None.	None

Returns:

Name	Type	Description
Message	Message	A new message with ASSISTANT role.

system(contents, metadata=None) classmethod

Create a system message.

Parameters:

Name	Type	Description	Default
contents	MessageContent | list[MessageContent]	The message contents. If a single content is provided, it will be wrapped in a list.	required
metadata	dict[str, Any]	Additional metadata for the message. Defaults to None.	None

Returns:

Name	Type	Description
Message	Message	A new message with SYSTEM role.

user(contents, metadata=None) classmethod

Create a user message.

Parameters:

Name	Type	Description	Default
contents	MessageContent | list[MessageContent]	The message contents. If a single content is provided, it will be wrapped in a list.	required
metadata	dict[str, Any]	Additional metadata for the message. Defaults to None.	None

Returns:

Name	Type	Description
Message	Message	A new message with USER role.