Camel.toolkits.function tool

​

_remove_a_key

def _remove_a_key(d: Dict, remove_key: Any):

​

_remove_title_recursively

def _remove_title_recursively(data, parent_key = None):

​

get_openai_function_schema

def get_openai_function_schema(func: Callable):

• func (Callable): The OpenAI function to generate the schema for.

​

get_openai_tool_schema

def get_openai_tool_schema(func: Callable):

• func (Callable): The Python function to be converted into an OpenAI JSON schema.

​

sanitize_and_enforce_required

def sanitize_and_enforce_required(parameters_dict):

• Removes invalid ‘default’ fields from the parameters schema.
• Ensures all fields are marked as required or have null type for optional fields.
• Recursively adds additionalProperties: false to all nested objects.

• parameters_dict (dict): The dictionary representing the function schema.

​

generate_docstring

def generate_docstring(code: str, model: Optional[BaseModelBackend] = None):

• code (str): The source code of the function.
• model (Optional[BaseModelBackend]): An optional language model backend instance. If not provided, a default gpt-4o-mini is used.

​

FunctionTool

class FunctionTool:

• func (Callable): The function to call. The tool schema is parsed from the function signature and docstring by default.
• openai_tool_schema (Optional[Dict[str, Any]], optional): A user-defined OpenAI tool schema to override the default result. (default: :obj:None)
• synthesize_schema (Optional[bool], optional): Whether to enable the use of a schema assistant model to automatically synthesize the schema if validation fails or no valid schema is provided. (default: :obj:False)
• synthesize_schema_model (Optional[BaseModelBackend], optional): An assistant model (e.g., an LLM model) used to synthesize the schema if synthesize_schema is enabled and no valid schema is provided. (default: :obj:None)
• synthesize_schema_max_retries (int, optional): The maximum number of attempts to retry schema synthesis using the schema assistant model if the previous attempts fail. (default: 2)
• synthesize_output (Optional[bool], optional): Flag for enabling synthesis output mode, where output is synthesized based on the function’s execution. (default: :obj:False)
• synthesize_output_model (Optional[BaseModelBackend], optional): Model used for output synthesis in synthesis mode. (default: :obj:None)
• synthesize_output_format (Optional[Type[BaseModel]], optional): Format for the response when synthesizing output. (default: :obj:None)

​

init

def __init__(
    self,
    func: Callable,
    openai_tool_schema: Optional[Dict[str, Any]] = None,
    synthesize_schema: Optional[bool] = False,
    synthesize_schema_model: Optional[BaseModelBackend] = None,
    synthesize_schema_max_retries: int = 2,
    synthesize_output: Optional[bool] = False,
    synthesize_output_model: Optional[BaseModelBackend] = None,
    synthesize_output_format: Optional[Type[BaseModel]] = None
):

​

call

def __call__(self, *args: Any, **kwargs: Any):

​

is_async

def is_async(self):

​

validate_openai_tool_schema

def validate_openai_tool_schema(openai_tool_schema: Dict[str, Any]):

• openai_tool_schema (Dict[str, Any]): The OpenAI tool schema to validate.

​

get_openai_tool_schema

def get_openai_tool_schema(self):

​

set_openai_tool_schema

def set_openai_tool_schema(self, schema: Dict[str, Any]):

• schema (Dict[str, Any]): The OpenAI tool schema to set.

​

get_openai_function_schema

def get_openai_function_schema(self):

​

set_openai_function_schema

def set_openai_function_schema(self, openai_function_schema: Dict[str, Any]):

• openai_function_schema (Dict[str, Any]): The function schema to set within the OpenAI tool schema.

​

get_function_name

def get_function_name(self):

​

set_function_name

def set_function_name(self, name: str):

• name (str): The name of the function to set.

​

get_function_description

def get_function_description(self):

​

set_function_description

def set_function_description(self, description: str):

• description (str): The description for the function.

​

get_parameter_description

def get_parameter_description(self, param_name: str):

• param_name (str): The name of the parameter to get the description.

​

set_parameter_description

def set_parameter_description(self, param_name: str, description: str):

• param_name (str): The name of the parameter to set the description for.
• description (str): The description for the parameter.

​

get_parameter

def get_parameter(self, param_name: str):

• param_name (str): The name of the parameter to get the schema.

​

set_parameter

def set_parameter(self, param_name: str, value: Dict[str, Any]):

• param_name (str): The name of the parameter to set the schema for.
• value (Dict[str, Any]): The schema to set for the parameter.

​

synthesize_openai_tool_schema

def synthesize_openai_tool_schema(self, max_retries: Optional[int] = None):

• max_retries (Optional[int], optional): The maximum number of retries for schema synthesis and validation if the process fails. (default: :obj:None)

​

synthesize_execution_output

def synthesize_execution_output(
    self,
    args: Optional[tuple[Any, ...]] = None,
    kwargs: Optional[Dict[str, Any]] = None
):

• args (Optional[tuple]): Positional arguments to pass to the function during synthesis. (default: :obj:None)
• kwargs (Optional[Dict[str, Any]]): Keyword arguments to pass to the function during synthesis. (default: :obj:None)

​

parameters

def parameters(self):

​

parameters

def parameters(self, value: Dict[str, Any]):

• value (Dict[str, Any]): the new dictionary value for the function’s parameters.