autogen_core.components.tools#

class autogen_core.components.tools.BaseTool(args_type: Type[ArgsT], return_type: Type[ReturnT], name: str, description: str)[source]#

Bases: ABC, Tool, Generic[ArgsT, ReturnT]

args_type() → Type[BaseModel][source]#

property description: str#

load_state_json(state: Mapping[str, Any]) → None[source]#

property name: str#

return_type() → Type[Any][source]#

return_value_as_string(value: Any) → str[source]#

abstract async run(args: ArgsT, cancellation_token: CancellationToken) → ReturnT[source]#

async run_json(args: Mapping[str, Any], cancellation_token: CancellationToken) → Any[source]#

save_state_json() → Mapping[str, Any][source]#

property schema: ToolSchema#

state_type() → Type[BaseModel] | None[source]#

class autogen_core.components.tools.BaseToolWithState(args_type: Type[ArgsT], return_type: Type[ReturnT], state_type: Type[StateT], name: str, description: str)[source]#

Bases: BaseTool[ArgsT, ReturnT], ABC, Generic[ArgsT, ReturnT, StateT]

abstract load_state(state: StateT) → None[source]#

load_state_json(state: Mapping[str, Any]) → None[source]#

abstract save_state() → StateT[source]#

save_state_json() → Mapping[str, Any][source]#

pydantic model autogen_core.components.tools.CodeExecutionInput[source]#

Bases: BaseModel

Show JSON schema

{
   "title": "CodeExecutionInput",
   "type": "object",
   "properties": {
      "code": {
         "description": "The contents of the Python code block that should be executed",
         "title": "Code",
         "type": "string"
      }
   },
   "required": [
      "code"
   ]
}

Fields:

code (str)

field code: str [Required]#: The contents of the Python code block that should be executed

pydantic model autogen_core.components.tools.CodeExecutionResult[source]#

Bases: BaseModel

Show JSON schema

{
   "title": "CodeExecutionResult",
   "type": "object",
   "properties": {
      "success": {
         "title": "Success",
         "type": "boolean"
      },
      "output": {
         "title": "Output",
         "type": "string"
      }
   },
   "required": [
      "success",
      "output"
   ]
}