refactor: Update LLM event docstrings for clarity

Improve docstrings for LLM call events to more accurately describe their purpose and lifecycle
This commit is contained in:
Lorenze Jay
2025-02-24 11:48:20 -08:00
parent 46ac490009
commit cefc57e2a3

View File

@@ -12,7 +12,7 @@ class LLMCallType(Enum):
class LLMCallStartedEvent(CrewEvent): class LLMCallStartedEvent(CrewEvent):
"""Event emitted when a task starts""" """Event emitted when a LLM call starts"""
type: str = "llm_call_started" type: str = "llm_call_started"
messages: Union[str, List[Dict[str, str]]] messages: Union[str, List[Dict[str, str]]]
@@ -22,7 +22,7 @@ class LLMCallStartedEvent(CrewEvent):
class LLMCallCompletedEvent(CrewEvent): class LLMCallCompletedEvent(CrewEvent):
"""Event emitted when a task completes""" """Event emitted when a LLM call completes"""
type: str = "llm_call_completed" type: str = "llm_call_completed"
response: Any response: Any
@@ -30,7 +30,7 @@ class LLMCallCompletedEvent(CrewEvent):
class LLMCallFailedEvent(CrewEvent): class LLMCallFailedEvent(CrewEvent):
"""Event emitted when a task fails""" """Event emitted when a LLM call fails"""
error: str error: str
type: str = "llm_call_failed" type: str = "llm_call_failed"