Skip to content

Messages

AIMessage

Bases: BaseModel

A message in the LLM conversation.

Attributes:

Name Type Description
role Literal[USER, MODEL, SYSTEM]

The role of the message sender.
chunks list[AIChunks]

The content chunks.
Source code in src/llmir/messages.py 
 7
 8
 9
10
11
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
class AIMessage(BaseModel):
    """
    A message in the LLM conversation.

    Attributes:
        role: The role of the message sender.
        chunks: The content chunks.
    """

    role: Literal[AIRoles.USER, AIRoles.MODEL, AIRoles.SYSTEM]
    chunks: list[AIChunks] = Field(default_factory=list[AIChunks])

    Roles: ClassVar = AIRoles

    class Chunk:
        Text: ClassVar = AIChunkText
        File: ClassVar = AIChunkFile
        ImageURL: ClassVar = AIChunkImageURL
        ToolCall: ClassVar = AIChunkToolCall

        Any: ClassVar = AIChunks


    @classmethod
    def text(cls,
        text: str,
        role: Literal[AIRoles.USER, AIRoles.MODEL, AIRoles.SYSTEM],
    ) -> AIMessage:
        return AIMessage(
            role=role,
            chunks=[
                AIChunkText(text=text)
            ]
        )

AIMessageToolResponse

Bases: BaseModel

A special tool response message in the LLM conversation.

Attributes:

Name Type Description
role Literal[TOOL]

The role of the message sender.
chunks list[AIChunks]

The content chunks.
id str

The id of the tool.
name str

The name of the tool.
Source code in src/llmir/messages.py 
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
class AIMessageToolResponse(BaseModel):
    """
    A special tool response message in the LLM conversation.

    Attributes:
        role: The role of the message sender.
        chunks: The content chunks.
        id: The id of the tool.
        name: The name of the tool.
    """

    Roles: ClassVar = AIRoles

    class Chunk:
        Text: ClassVar = AIChunkText
        File: ClassVar = AIChunkFile
        ImageURL: ClassVar = AIChunkImageURL
        ToolCall: ClassVar = AIChunkToolCall

        Any: ClassVar = AIChunks

    role: Literal[AIRoles.TOOL] = AIRoles.TOOL
    chunks: list[AIChunks] = Field(default_factory=list[AIChunks])
    id: str
    name: str