Getting Started
.env
Domain Agent
async initialize() -> None
async activate() -> None
async deactivate() -> None
async shutdown() -> None
state() -> AgentState
get_state() -> AgentState
async execute_task(task: Dict[str, Any], context: Dict[str, Any]) -> Dict[str, Any]
async process_message(message: str, sender_id: Optional[str] = None) -> Dict[str, Any]
async execute_tool(tool_name: str, parameters: Dict[str, Any]) -> Any
async execute_tools_parallel(tool_calls: List[Dict[str, Any]], max_concurrency: int = 5) -> List[Dict[str, Any]]
async execute_tool_with_cache(tool_name: str, parameters: Dict[str, Any]) -> Any
invalidate_cache(tool_name: Optional[str] = None, pattern: Optional[str] = None) -> int
get_cache_stats() -> Dict[str, Any]
async execute_task_streaming(task: Dict[str, Any], context: Dict[str, Any]) -> AsyncIterator[Dict[str, Any]]
async process_message_streaming(message: str, sender_id: Optional[str] = None) -> AsyncIterator[str]
async add_to_memory(key: str, value: Any, memory_type: MemoryType = MemoryType.SHORT_TERM) -> None
async retrieve_memory(key: str, default: Any = None) -> Any
async clear_memory(memory_type: Optional[MemoryType] = None) -> None
get_memory_summary() -> Dict[str, Any]
set_goal(goal_id: str, description: str, priority: GoalPriority = GoalPriority.MEDIUM, deadline: Optional[datetime] = None) -> AgentGoal
get_goals(status: Optional[GoalStatus] = None) -> List[AgentGoal]
get_goal(goal_id: str) -> Optional[AgentGoal]
update_goal_status(goal_id: str, status: GoalStatus, notes: Optional[str] = None) -> None
get_config() -> AgentConfiguration
update_config(updates: Dict[str, Any]) -> None
declare_capability(capability_type: str, description: str, level: CapabilityLevel = CapabilityLevel.BASIC) -> None
has_capability(capability_type: str) -> bool
get_capabilities() -> List[AgentCapabilityDeclaration]
get_metrics() -> AgentMetrics
update_metrics(execution_time: Optional[float] = None, success: Optional[bool] = None, tokens_used: Optional[int] = None, tool_calls: Optional[int] = None) -> None
track_operation_time(operation_name: str) -> OperationTimer
get_performance_metrics() -> Dict[str, Any]
get_health_status() -> Dict[str, Any]
get_comprehensive_status() -> Dict[str, Any]
reset_metrics() -> None
to_dict() -> Dict[str, Any]
@classmethod from_dict(data: Dict[str, Any]) -> BaseAIAgent
async save_checkpoint(session_id: Optional[str] = None) -> Optional[str]
async load_checkpoint(checkpoint_id: str) -> bool
async delegate_task(task_description: str, target_agent_id: Optional[str] = None, required_capabilities: Optional[List[str]] = None, context: Optional[Dict[str, Any]] = None) -> Dict[str, Any]
async find_capable_agents(required_capabilities: List[str]) -> List[Any]
async request_peer_review(task: Dict[str, Any], result: Dict[str, Any], reviewer_id: Optional[str] = None) -> Dict[str, Any]
async collaborate_on_task(task: Dict[str, Any], strategy: str = "parallel", required_capabilities: Optional[List[str]] = None, agent_weights: Optional[Dict[str, float]] = None) -> Dict[str, Any]
async record_experience(task: Dict[str, Any], result: Dict[str, Any], approach: str, tools_used: Optional[List[str]] = None) -> None
async get_recommended_approach(task: Dict[str, Any]) -> Optional[Dict[str, Any]]
async get_learning_insights() -> Dict[str, Any]
async adapt_strategy(task: Dict[str, Any]) -> Dict[str, Any]
async check_resource_availability() -> Dict[str, Any]
async wait_for_resources(timeout: Optional[float] = None) -> bool
async get_resource_usage() -> Dict[str, Any]
async execute_with_recovery(task: Dict[str, Any], context: Dict[str, Any], strategies: Optional[List[str]] = None) -> Dict[str, Any]
async get_relevant_context(query: str, max_items: int = 10, min_score: float = 0.5) -> List[Dict[str, Any]]
async score_context_relevance(context_items: List[Dict[str, Any]], query: str) -> List[float]
async prune_context(context_items: List[Dict[str, Any]], max_tokens: int, query: Optional[str] = None, preserve_types: Optional[List[str]] = None) -> List[Dict[str, Any]]
is_available() -> bool
is_busy() -> bool
async _execute_tool_with_observation(tool_name: str, operation: Optional[str], parameters: Dict[str, Any]) -> ToolObservation
get_available_tools() -> List[str]
async add_message(role: str, content: str, session_id: Optional[str] = None, metadata: Optional[Dict[str, Any]] = None) -> None
async get_messages(session_id: Optional[str] = None, limit: Optional[int] = None) -> List[LLMMessage]
async clear(session_id: Optional[str] = None) -> None
async get_session(session_id: str) -> Optional[Session]
async create_session(session_id: Optional[str] = None, user_id: Optional[str] = None, metadata: Optional[Dict[str, Any]] = None) -> Session
async end_session(session_id: str, status: str = "completed") -> None
async list_sessions(active_only: bool = False) -> List[Session]
add_message(role: str, content: str, metadata: Optional[Dict[str, Any]] = None) -> None
track_request(processing_time: float, is_error: bool = False) -> None
get_metrics() -> Dict[str, Any]
is_active() -> bool
end(status: str = "completed") -> None
is_expired(max_idle_seconds: int = 1800) -> bool
async create_session(session_id: Optional[str] = None, user_id: Optional[str] = None, metadata: Optional[Dict[str, Any]] = None) -> str
async get_session(session_id: str) -> Optional[SessionMetrics]
async add_message(session_id: str, role: str, content: str, metadata: Optional[Dict[str, Any]] = None) -> None
async get_messages(session_id: str, limit: Optional[int] = None, offset: int = 0) -> List[ConversationMessage]
async clear_messages(session_id: str) -> None
async compress_conversation(session_id: str, strategy: Optional[str] = None, target_length: Optional[int] = None, custom_prompt: Optional[str] = None) -> Dict[str, Any]
async summarize_conversation(session_id: str, max_messages: Optional[int] = None, custom_prompt: Optional[str] = None) -> str
async truncate_conversation(session_id: str, keep_last: int) -> int
async semantic_compress_conversation(session_id: str, query: Optional[str] = None, max_messages: Optional[int] = None) -> Dict[str, Any]
async store_context(session_id: str, key: str, value: Any, metadata: Optional[Dict[str, Any]] = None) -> None
async get_context(session_id: str, key: str, default: Any = None) -> Any
async list_context_keys(session_id: str) -> List[str]
async cleanup_expired_sessions(max_idle_seconds: int = 1800) -> int
execute_tool_with_cache(tool_name: str, parameters: Dict[str, Any]) -> Any
execute_tools_parallel(tool_calls: List[Dict[str, Any]], max_concurrency: int = 5) -> List[Dict[str, Any]]
analyze_tool_dependencies(tool_calls: List[Dict[str, Any]]) -> Dict[str, List[str]]
execute_tools_with_dependencies(tool_calls: List[Dict[str, Any]], max_concurrency: int = 5) -> List[Dict[str, Any]]
execute_task_streaming(task: Dict[str, Any], context: Dict[str, Any]) -> AsyncIterator[Dict[str, Any]]
process_message_streaming(message: str, sender_id: Optional[str] = None) -> AsyncIterator[str]
execute_with_recovery(task: Dict[str, Any], context: Dict[str, Any], strategies: Optional[List[str]] = None) -> Dict[str, Any]
check_resource_availability() -> Dict[str, Any]
wait_for_resources(timeout: Optional[float] = None) -> bool
get_resource_usage() -> Dict[str, Any]
save_checkpoint(session_id: Optional[str] = None) -> Optional[str]
load_checkpoint(checkpoint_id: str) -> bool
update_session_metrics(session_id: str, processing_time: float, is_error: bool = False) -> None
Tools and Configuration
data_loader
data_profiler
data_transformer
data_visualizer
statistical_analyzer
model_trainer
ai_data_analysis_orchestrator
ai_insight_generator
ai_report_orchestrator
LLM Integration
LLMMessage
LLMResponse
LLMClientError
ProviderNotAvailableError
RateLimitError
BaseLLMClient
generate_text
stream_text
close
_count_tokens_estimate
_estimate_cost
Domain Modules
Infrastructure
WebSocketManager
UserConfirmation
TaskStepResult
start_server
stop_server
notify_user
broadcast_message
send_to_user
send_heartbeat
get_connection_count
get_status
CeleryTaskManager
execute_task
execute_heavy_task
execute_dsl_task_step
batch_execute_tasks
get_task_result
cancel_task
get_queue_info
get_worker_stats
TracingManager
start_span
finish_span
with_tracing
trace_database_operation
trace_external_call
trace_tool_execution
ExecutorMetrics
record_operation_latency
record_operation_success
record_operation_failure
record_retry
with_metrics
get_metrics_summary
record_operation
record_duration
DatabaseManager
init_connection_pool
init_database_schema
save_task_history
load_task_history
mark_task_as_cancelled
check_task_status
get_user_tasks
cleanup_old_tasks
FileStorage
FileStorageConfig
initialize
store
retrieve
delete
exists
list_keys
get_stats
get_file_storage
initialize_file_storage
RedisClient
get_client
set
get
hset
hget
hgetall
hincrby
expire
ping
info
initialize_redis_client
close_redis_client
get_redis_client
Core and Application
tasks/worker.py
main.py
infrastructure/messaging/celery_task_manager.py
aiecs_client.py
pydantic_settings.BaseSettings
socket_server.py
tools/tool_executor/tool_executor.py
utils/execution_utils.py
tools/__init__.py
domain/execution/model.py
API Reference
IToolProvider
IToolProvider.get_tool()
IToolProvider.has_tool()
IToolExecutor
IToolExecutor.execute()
IToolExecutor.execute_async()
ICacheProvider
ICacheProvider.generate_cache_key()
ICacheProvider.get_from_cache()
ICacheProvider.add_to_cache()
IOperationExecutor
IOperationExecutor.execute_operation()
IOperationExecutor.batch_execute_operations()
IOperationExecutor.execute_operations_sequence()
IOperationExecutor.execute_parallel_operations()
ExecutionInterface
ExecutionInterface.execute_operation()
ExecutionInterface.execute_task()
ExecutionInterface.batch_execute_operations()
ExecutionInterface.batch_execute_tasks()
ExecutionInterface.register_executor()
ISessionStorage
ISessionStorage.create_session()
ISessionStorage.get_session()
ISessionStorage.update_session()
ISessionStorage.end_session()
IConversationStorage
IConversationStorage.add_conversation_message()
IConversationStorage.get_conversation_history()
ICheckpointStorage
ICheckpointStorage.store_checkpoint()
ICheckpointStorage.get_checkpoint()
ICheckpointStorage.list_checkpoints()
ITaskContextStorage
ITaskContextStorage.get_task_context()
ITaskContextStorage.store_task_context()
IStorageBackend
IStorageBackend.initialize()
IStorageBackend.close()
IStorageBackend.health_check()
IStorageBackend.get_metrics()
IStorageBackend.cleanup_expired_sessions()
IPermanentStorageBackend
IPermanentStorageBackend.append_session_event()
IPermanentStorageBackend.append_conversation_message()
IPermanentStorageBackend.append_checkpoint()
IPermanentStorageBackend.append_checkpoint_writes()
IPermanentStorageBackend.append_conversation_session()
IPermanentStorageBackend.append_task_context_snapshot()
IPermanentStorageBackend.initialize()
IPermanentStorageBackend.close()
ICheckpointerBackend
ICheckpointerBackend.put_checkpoint()
ICheckpointerBackend.get_checkpoint()
ICheckpointerBackend.list_checkpoints()
ICheckpointerBackend.put_writes()
ICheckpointerBackend.get_writes()
OperationTimer
CacheConfig
BaseAIAgent
DateTimeEncoder
SessionMetrics
ConversationMessage
CompressionConfig
ContextEngine
ContextUpdate
TaskContext
build_context()
task_context()
DSLStep
OperationExecutor
OperationExecutor.__init__()
OperationExecutor.execute_operation()
OperationExecutor.batch_execute_operations()
OperationExecutor.execute_operations_sequence()
OperationExecutor.batch_tool_calls()
OperationExecutor.extract_tool_calls()
OperationExecutor.execute_parallel_operations()
OperationExecutor.get_tool_instance()
OperationExecutor.clear_tool_cache()
OperationExecutor.get_stats()
FileStorageError
get_file_storage()
initialize_file_storage()
initialize_redis_client()
close_redis_client()
get_redis_client()
initialize_global_metrics()
get_global_metrics()
close_global_metrics()
is_metrics_initialized()
get_metrics_summary()
record_operation()
record_duration()
record_operation_success()
record_operation_failure()
record_retry()
ToolConfigLoader
get_tool_config_loader()
BaseTool
BaseTool.__init__()
BaseTool.settings
BaseTool.get_schema_coverage()
BaseTool.run()
BaseTool.run_async()
BaseTool.run_batch()
SearchTool
SearchTool.Config
SearchTool.Search_webSchema
SearchTool.Search_imagesSchema
SearchTool.Search_newsSchema
SearchTool.Search_videosSchema
SearchTool.Get_metricsSchema
SearchTool.Get_metrics_reportSchema
SearchTool.Get_health_scoreSchema
SearchTool.Get_quota_statusSchema
SearchTool.Get_search_contextSchema
SearchTool.Search_batchSchema
SearchTool.description
SearchTool.category
SearchTool.__init__()
SearchTool.clear_search_cache()
SearchTool.service
SearchTool.rate_limiter
SearchTool.circuit_breaker
SearchTool.search_web()
SearchTool.search_batch()
SearchTool.search_images()
SearchTool.search_news()
SearchTool.search_videos()
SearchTool.get_metrics()
SearchTool.get_metrics_report()
SearchTool.get_health_score()
SearchTool.get_quota_status()
SearchTool.get_search_context()
SearchType
SearchType.WEB
SearchType.IMAGE
SearchType.NEWS
SearchType.VIDEO
SearchType.__new__()
SafeSearch
SafeSearch.OFF
SafeSearch.MEDIUM
SafeSearch.HIGH
SafeSearch.__new__()
ImageSize
ImageSize.ICON
ImageSize.SMALL
ImageSize.MEDIUM
ImageSize.LARGE
ImageSize.XLARGE
ImageSize.XXLARGE
ImageSize.HUGE
ImageSize.__new__()
ImageType
ImageType.CLIPART
ImageType.FACE
ImageType.LINEART
ImageType.STOCK
ImageType.PHOTO
ImageType.ANIMATED
ImageType.__new__()
ImageColorType
ImageColorType.COLOR
ImageColorType.GRAY
ImageColorType.MONO
ImageColorType.TRANS
ImageColorType.__new__()
QueryIntentType
QueryIntentType.DEFINITION
QueryIntentType.HOW_TO
QueryIntentType.COMPARISON
QueryIntentType.FACTUAL
QueryIntentType.RECENT_NEWS
QueryIntentType.ACADEMIC
QueryIntentType.PRODUCT
QueryIntentType.CAUSAL
QueryIntentType.DEMOGRAPHIC
QueryIntentType.BRAND
QueryIntentType.GENERAL
QueryIntentType.__new__()
CredibilityLevel
CredibilityLevel.HIGH
CredibilityLevel.MEDIUM
CredibilityLevel.LOW
CredibilityLevel.__new__()
CircuitState
CircuitState.CLOSED
CircuitState.OPEN
CircuitState.HALF_OPEN
CircuitState.__new__()
SearchToolError
AuthenticationError
QuotaExceededError
CircuitBreakerOpenError
SearchAPIError
ValidationError
CacheError
AIProvider
AIProvider.OPENAI
AIProvider.VERTEX
AIProvider.GOOGLEAI
AIProvider.XAI
AIProvider.OPENROUTER
AIProvider.ANTHROPIC_VERTEX
AIProvider.VERTEX_MAAS
AIProvider.__new__()
LLMClientFactory
LLMClientFactory.register_custom_provider()
LLMClientFactory.get_client()
LLMClientFactory.close_all()
LLMClientFactory.close_client()
LLMClientFactory.reload_config()
LLMClientManager
LLMClientManager.__init__()
LLMClientManager.generate_text()
LLMClientManager.stream_text()
LLMClientManager.close()
get_llm_manager()
generate_text()
stream_text()
OpenAIClient
VertexAIClient
XAIClient
ModelCostConfig
ModelCapabilities
ModelDefaultParams
ModelConfig
ProviderConfig
LLMModelsConfig
LLMConfigLoader
get_llm_config_loader()
get_llm_config()
reload_llm_config()
Development
Deprecated — removed in AIECS 2.0.0
See MIGRATION_2_0.md and the archived copy.