Skip to content

events

Class info

Classes

Name Children Inherits
ChatMessage
llmling_agent.messaging.messages
Common message format for all UI types.
    StreamCompleteEvent
    llmling_agent.agent.events
    Event indicating streaming is complete with final message.
      ToolCallProgress
      llmling_agent.agent.events
      Event indicating the tool call progress.

        🛈 DocStrings

        Event stream events.

        StreamCompleteEvent dataclass

        Event indicating streaming is complete with final message.

        Source code in src/llmling_agent/agent/events.py
        11
        12
        13
        14
        15
        16
        17
        18
        @dataclass(kw_only=True)
        class StreamCompleteEvent[TContent]:
            """Event indicating streaming is complete with final message."""
        
            message: ChatMessage[TContent]
            """The final chat message with all metadata."""
            event_kind: Literal["stream_complete"] = "stream_complete"
            """Event type identifier."""
        

        event_kind class-attribute instance-attribute

        event_kind: Literal['stream_complete'] = 'stream_complete'
        

        Event type identifier.

        message instance-attribute

        message: ChatMessage[TContent]
        

        The final chat message with all metadata.

        ToolCallProgress dataclass

        Event indicating the tool call progress.

        Source code in src/llmling_agent/agent/events.py
        21
        22
        23
        24
        25
        26
        27
        28
        29
        30
        31
        32
        33
        34
        35
        36
        @dataclass(kw_only=True)
        class ToolCallProgress:
            """Event indicating the tool call progress."""
        
            progress: int
            """The current progress of the tool call."""
            total: int
            """The total progress of the tool call."""
            message: str
            """Progress message."""
            tool_name: str
            """The name of the tool being called."""
            tool_call_id: str
            """The ID of the tool call."""
            tool_input: str
            """The input provided to the tool."""
        

        message instance-attribute

        message: str
        

        Progress message.

        progress instance-attribute

        progress: int
        

        The current progress of the tool call.

        tool_call_id instance-attribute

        tool_call_id: str
        

        The ID of the tool call.

        tool_input instance-attribute

        tool_input: str
        

        The input provided to the tool.

        tool_name instance-attribute

        tool_name: str
        

        The name of the tool being called.

        total instance-attribute

        total: int
        

        The total progress of the tool call.