LLMMessage#

class council.llm.LLMMessage(role: LLMMessageRole, content: str, name: str | None = None, data: Sequence[LLMMessageData] | None = None)[source]#

Bases: object

Represents chat messages. Used in the payload

Parameters:

  • role (LLMMessageRole) – the role/persona the message is coming from. Could be either user, system or assistant

  • content (str) – the message content

  • name (str) – name of the author of this message

  • data (Sequence[LLMMessageData]) – the data associated with this message

__init__(role: LLMMessageRole, content: str, name: str | None = None, data: Sequence[LLMMessageData] | None = None) → None[source]#

Initialize a new instance of LLMMessage

add_content(*, path: str | None = None, url: str | None = None) → None[source]#

Add content to the message.

add_data(data: LLMMessageData) → None[source]#

Add data to the message.

static assistant_message(content: str, name: str | None = None) → LLMMessage[source]#

Create a new assistant message instance

Parameters:

  • content (str) – the message content

  • name (str) – name of the author of this message

property content: str#

Retrieve the content of this instance

property data: Sequence[LLMMessageData]#

Get the list of data associated with this message

format(role_prefix: str = '#') → str[source]#

Format message to string, including role and LLMMessageData if any

static from_chat_message(chat_message: ChatMessage) → LLMMessage | None[source]#

Convert ChatMessage into LLMMessage

property has_data: bool#

Check if this message has data associated with it

is_of_role(role: LLMMessageRole) → bool[source]#

Check the role of this instance

property name: str | None#

Retrieve the name authoring the content of this instance

property role: LLMMessageRole#

Retrieve the role of this instance

static system_message(content: str, name: str | None = None, data: Sequence[LLMMessageData] | None = None) → LLMMessage[source]#

Create a new system message instance

Parameters:

  • content (str) – the message content

  • name (str) – name of the author of this message

  • data (Sequence[LLMMessageData]) – list of data associated with this message

static user_message(content: str, name: str | None = None, data: Sequence[LLMMessageData] | None = None) → LLMMessage[source]#

Create a new user message instance

Parameters:

  • content (str) – the message content

  • name (str) – name of the author of this message

  • data (Sequence[LLMMessageData]) – list of data associated with this message