FunctionSchema

class pipecat.adapters.schemas.function_schema.FunctionSchema(name, description, properties, required)

Bases: object

Standardized function schema representation for tool definition.

Provides a structured way to define function tools used with AI models like OpenAI. This schema defines the function’s name, description, parameter properties, and required parameters, following specifications required by AI service providers.

Parameters:

• name (str) – Name of the function to be called.

• description (str) – Description of what the function does.

• properties (Dict[str, Any]) – Dictionary defining parameter types, descriptions, and constraints.

• required (List[str]) – List of property names that are required parameters.

to_default_dict()

Converts the function schema to a dictionary.

Returns:

Dictionary representation of the function schema.

Return type:

Dict[str, Any]

property name: str

Get the function name.

Returns:

The function name.

property description: str

Get the function description.

Returns:

The function description.

property properties: Dict[str, Any]

Get the function properties.

Returns:

Dictionary of parameter specifications.

property required: List[str]

Get the required parameters.

Returns:

List of required parameter names.