Skip to content

Message

llmfy.llmfy_core.messages.message

Message

Bases: BaseModel

Message class for input to the LLM models.

Parameters:

Name Type Description Default
id str

Id message default UUIDv4.

 required
role Role

Message role.

 required
content Optional[str] | Optional[List[Content]]

Use str if only using text, but if use image and text use List[Content].

 required
name Optional[str]

Message name.

 required
tool_calls Optional[List[ToolCall]]

[assistant role ONLY] Tool call list.

 required
tool_call_id Optional[str]

[tool role ONLY] Tool call id.

 required
tool_results Optional[List[Any]]

[tool role ONLY] Tool call results.

 required
request_call_id Optional[str]

[tool role ONLY] Tool call id request.

 required
Source code in llmfy/llmfy_core/messages/message.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class Message(BaseModel):
    """Message class for input to the LLM models.

    Args:
        id (str): Id message default UUIDv4.
        role (Role): Message role.
        content (Optional[str] | Optional[List[Content]]): Use str if only using text, but if use image and text use List[Content].
        name (Optional[str]): Message name.
        tool_calls (Optional[List[ToolCall]]): [`assistant` role ONLY] Tool call list.
        tool_call_id (Optional[str]): [`tool` role ONLY] Tool call id.
        tool_results (Optional[List[Any]]): [`tool` role ONLY] Tool call results.
        request_call_id (Optional[str]): [`tool` role ONLY] Tool call id request.
    """

    model_config = ConfigDict(extra="forbid")

    id: str = Field(default_factory=lambda: str(uuid.uuid4()))

    role: Role
    """Message role [SYSTEM, USER, ASSISTANT, TOOL]"""

    content: Optional[str] | Optional[List[Content]] = None
    """Use str if only using text, but if use image and text use List[Content]."""

    name: Optional[str] = None
    """Message name"""

    tool_calls: Optional[List[ToolCall]] = None  # For Message with `assistant` role
    """[`assistant` role ONLY] Tool call list."""

    tool_call_id: Optional[str] = None  # For Message with `tool` role
    """[`tool` role ONLY] Tool call id."""

    tool_results: Optional[List[Any]] = None  # For Message with `tool` role
    """[`tool` role ONLY] Tool call results."""

    request_call_id: Optional[str] = None  # For Message with `tool` role
    """[`tool` role ONLY] Tool call id request."""

    timestamp: str = Field(
        default_factory=lambda: datetime.now(timezone.utc).isoformat(),
        description="Message timestamp in ISO 8601. Default UTC",
    )
    """Message timestamp in ISO 8601. Default UTC"""

    # def __init__(self, **kwargs):
    def model_post_init(self, __context) -> None:
        # Ensure tool_results is only used when role is "tool"
        if self.tool_results is not None and self.role != Role.TOOL:
            raise ValueError("tool_results can only be set when role is 'tool'.")

        # Ensure expect tool_results used when role is "tool"
        if not self.tool_results and self.role == Role.TOOL:
            raise ValueError("Expected tool_results when role is 'tool'.")

        # Ensure tool_call_id is only used when role is "tool"
        if self.tool_call_id is not None and self.role != Role.TOOL:
            raise ValueError("tool_call_id can only be set when role is 'tool'.")

        # Ensure tool_calls is only used when role is "assistant"
        if self.tool_calls is not None and self.role != Role.ASSISTANT:
            raise ValueError("tool_calls can only be set when role is 'assistant'.")

model_config = ConfigDict(extra='forbid') class-attribute instance-attribute

id = Field(default_factory=(lambda: str(uuid.uuid4()))) class-attribute instance-attribute

role instance-attribute

Message role [SYSTEM, USER, ASSISTANT, TOOL]

content = None class-attribute instance-attribute

Use str if only using text, but if use image and text use List[Content].

name = None class-attribute instance-attribute

Message name

tool_calls = None class-attribute instance-attribute

[assistant role ONLY] Tool call list.

tool_call_id = None class-attribute instance-attribute

[tool role ONLY] Tool call id.

tool_results = None class-attribute instance-attribute

[tool role ONLY] Tool call results.

request_call_id = None class-attribute instance-attribute

[tool role ONLY] Tool call id request.

timestamp = Field(default_factory=(lambda: datetime.now(timezone.utc).isoformat()), description='Message timestamp in ISO 8601. Default UTC') class-attribute instance-attribute

Message timestamp in ISO 8601. Default UTC

model_post_init(__context)

Source code in llmfy/llmfy_core/messages/message.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def model_post_init(self, __context) -> None:
    # Ensure tool_results is only used when role is "tool"
    if self.tool_results is not None and self.role != Role.TOOL:
        raise ValueError("tool_results can only be set when role is 'tool'.")

    # Ensure expect tool_results used when role is "tool"
    if not self.tool_results and self.role == Role.TOOL:
        raise ValueError("Expected tool_results when role is 'tool'.")

    # Ensure tool_call_id is only used when role is "tool"
    if self.tool_call_id is not None and self.role != Role.TOOL:
        raise ValueError("tool_call_id can only be set when role is 'tool'.")

    # Ensure tool_calls is only used when role is "assistant"
    if self.tool_calls is not None and self.role != Role.ASSISTANT:
        raise ValueError("tool_calls can only be set when role is 'assistant'.")