chore: add missing docstrings

Author: stainless-app[bot]

src/agentex/types/agent_rpc_result.py

@@ -20,6 +20,8 @@
 
 
 class StreamTaskMessageStart(BaseModel):
+    """Event for starting a streaming message"""
+
     content: TaskMessageContent
 
     index: Optional[int] = None
@@ -35,6 +37,8 @@ class StreamTaskMessageStart(BaseModel):
 
 
 class StreamTaskMessageDelta(BaseModel):
+    """Event for streaming chunks of content"""
+
     delta: Optional[TaskMessageDelta] = None
     """Delta for text updates"""
 
@@ -51,6 +55,8 @@ class StreamTaskMessageDelta(BaseModel):
 
 
 class StreamTaskMessageFull(BaseModel):
+    """Event for streaming the full content"""
+
     content: TaskMessageContent
 
     index: Optional[int] = None
@@ -66,6 +72,8 @@ class StreamTaskMessageFull(BaseModel):
 
 
 class StreamTaskMessageDone(BaseModel):
+    """Event for indicating the task is done"""
+
     index: Optional[int] = None
 
     parent_task_message: Optional[TaskMessage] = None

src/agentex/types/data_delta.py

@@ -9,6 +9,8 @@
 
 
 class DataDelta(BaseModel):
+    """Delta for data updates"""
+
     data_delta: Optional[str] = None
 
     type: Optional[Literal["data"]] = None

src/agentex/types/reasoning_content_delta.py

@@ -9,6 +9,8 @@
 
 
 class ReasoningContentDelta(BaseModel):
+    """Delta for reasoning content updates"""
+
     content_index: int
 
     content_delta: Optional[str] = None

src/agentex/types/reasoning_summary_delta.py

@@ -9,6 +9,8 @@
 
 
 class ReasoningSummaryDelta(BaseModel):
+    """Delta for reasoning summary updates"""
+
     summary_index: int
 
     summary_delta: Optional[str] = None

src/agentex/types/state.py

@@ -9,6 +9,16 @@
 
 
 class State(BaseModel):
+    """Represents a state in the agent system.
+
+    A state is associated uniquely with a task and an agent.
+
+    This entity is used to store states in MongoDB, with each state
+    associated with a specific task and agent. The combination of task_id and agent_id is globally unique.
+
+    The state is a dictionary of arbitrary data.
+    """
+
     id: str
     """The task state's unique id"""
 

src/agentex/types/task_list_response.py

@@ -11,6 +11,8 @@
 
 
 class TaskListResponseItem(BaseModel):
+    """Task response model with optional related data based on relationships"""
+
     id: str
 
     agents: Optional[List[Agent]] = None

src/agentex/types/task_message.py

@@ -11,6 +11,12 @@
 
 
 class TaskMessage(BaseModel):
+    """Represents a message in the agent system.
+
+    This entity is used to store messages in MongoDB, with each message
+    associated with a specific task.
+    """
+
     content: TaskMessageContent
     """The content of the message.
 

src/agentex/types/task_message_update.py

@@ -19,6 +19,8 @@
 
 
 class StreamTaskMessageStart(BaseModel):
+    """Event for starting a streaming message"""
+
     content: TaskMessageContent
 
     index: Optional[int] = None
@@ -34,6 +36,8 @@ class StreamTaskMessageStart(BaseModel):
 
 
 class StreamTaskMessageDelta(BaseModel):
+    """Event for streaming chunks of content"""
+
     delta: Optional[TaskMessageDelta] = None
     """Delta for text updates"""
 
@@ -50,6 +54,8 @@ class StreamTaskMessageDelta(BaseModel):
 
 
 class StreamTaskMessageFull(BaseModel):
+    """Event for streaming the full content"""
+
     content: TaskMessageContent
 
     index: Optional[int] = None
@@ -65,6 +71,8 @@ class StreamTaskMessageFull(BaseModel):
 
 
 class StreamTaskMessageDone(BaseModel):
+    """Event for indicating the task is done"""
+
     index: Optional[int] = None
 
     parent_task_message: Optional[TaskMessage] = None

src/agentex/types/task_retrieve_by_name_response.py

@@ -11,6 +11,8 @@
 
 
 class TaskRetrieveByNameResponse(BaseModel):
+    """Task response model with optional related data based on relationships"""
+
     id: str
 
     agents: Optional[List[Agent]] = None

src/agentex/types/task_retrieve_response.py

@@ -11,6 +11,8 @@
 
 
 class TaskRetrieveResponse(BaseModel):
+    """Task response model with optional related data based on relationships"""
+
     id: str
 
     agents: Optional[List[Agent]] = None