Skip to content

Commit 7f81914

Browse files
chore: add missing docstrings
1 parent c8e85dc commit 7f81914

2 files changed

Lines changed: 24 additions & 0 deletions

File tree

src/agentbase/types/agent_run_params.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,11 @@ class Agent(TypedDict, total=False):
109109

110110

111111
class Callback(TypedDict, total=False):
112+
"""A callback endpoint configuration to send agent message events back to.
113+
114+
Use with background true.
115+
"""
116+
112117
url: Required[str]
113118
"""The webhook URL to send events to."""
114119

@@ -125,6 +130,11 @@ class Datastore(TypedDict, total=False):
125130

126131

127132
class FinalOutput(TypedDict, total=False):
133+
"""
134+
Configuration for an extra final output event that processes the entire agent
135+
message thread and produces a structured output based on the provided JSON schema.
136+
"""
137+
128138
name: Required[str]
129139
"""Name for the final output."""
130140

@@ -155,6 +165,8 @@ class Query(TypedDict, total=False):
155165

156166

157167
class WorkflowStepRetryPolicy(TypedDict, total=False):
168+
"""Retry configuration for the step."""
169+
158170
backoff: str
159171

160172
max_attempts: int

src/agentbase/types/client_run_agent_params.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,11 @@ class Agent(TypedDict, total=False):
109109

110110

111111
class Callback(TypedDict, total=False):
112+
"""A callback endpoint configuration to send agent message events back to.
113+
114+
Use with background true.
115+
"""
116+
112117
url: Required[str]
113118
"""The webhook URL to send events to."""
114119

@@ -125,6 +130,11 @@ class Datastore(TypedDict, total=False):
125130

126131

127132
class FinalOutput(TypedDict, total=False):
133+
"""
134+
Configuration for an extra final output event that processes the entire agent
135+
message thread and produces a structured output based on the provided JSON schema.
136+
"""
137+
128138
name: Required[str]
129139
"""Name for the final output."""
130140

@@ -155,6 +165,8 @@ class Query(TypedDict, total=False):
155165

156166

157167
class WorkflowStepRetryPolicy(TypedDict, total=False):
168+
"""Retry configuration for the step."""
169+
158170
backoff: str
159171

160172
max_attempts: int

0 commit comments

Comments
 (0)