Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.
chore: add typing and docstrings to base_token_process module (#3486)
Greyson LaLonde1dc4f2e8977e
diff --git a/src/crewai/agents/agent_builder/utilities/base_token_process.py b/src/crewai/agents/agent_builder/utilities/base_token_process.pyindex 3ce5cfb82..1fa46dd61 100644--- a/src/crewai/agents/agent_builder/utilities/base_token_process.py+++ b/src/crewai/agents/agent_builder/utilities/base_token_process.py@@ -1,8 +1,25 @@+"""Token usage tracking utilities.++This module provides utilities for tracking token consumption and request+metrics during agent execution.+"""+from crewai.types.usage_metrics import UsageMetricsclass TokenProcess:+ """Track token usage during agent processing.++ Attributes:+ total_tokens: Total number of tokens used.+ prompt_tokens: Number of tokens used in prompts.+ cached_prompt_tokens: Number of cached prompt tokens used.+ completion_tokens: Number of tokens used in completions.+ successful_requests: Number of successful requests made.+ """+def __init__(self) -> None:+ """Initialize token tracking with zero values."""self.total_tokens: int = 0self.prompt_tokens: int = 0self.cached_prompt_tokens: int = 0@@ -10,20 +27,45 @@ class TokenProcess:self.successful_requests: int = 0def sum_prompt_tokens(self, tokens: int) -> None:+ """Add prompt tokens to the running totals.++ Args:+ tokens: Number of prompt tokens to add.+ """self.prompt_tokens += tokensself.total_tokens += tokensdef sum_completion_tokens(self, tokens: int) -> None:+ """Add completion tokens to the running totals.++ Args:+ tokens: Number of completion tokens to add.+ """self.completion_tokens += tokensself.total_tokens += tokensdef sum_cached_prompt_tokens(self, tokens: int) -> None:+ """Add cached prompt tokens to the running total.++ Args:+ tokens: Number of cached prompt tokens to add.+ """self.cached_prompt_tokens += tokensdef sum_successful_requests(self, requests: int) -> None:+ """Add successful requests to the running total.++ Args:+ requests: Number of successful requests to add.+ """self.successful_requests += requestsdef get_summary(self) -> UsageMetrics:+ """Get a summary of all tracked metrics.++ Returns:+ UsageMetrics object with current totals.+ """return UsageMetrics(total_tokens=self.total_tokens,prompt_tokens=self.prompt_tokens,