FunctionCallingStepwisePlannerOptions Class

The Function Calling Stepwise Planner Options.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Constructor

FunctionCallingStepwisePlannerOptions(*, excluded_plugins: set[str] = None, excluded_functions: set[str] = None, get_available_functions: Callable[[PlannerOptions, str | None], list[KernelFunctionMetadata]] | None = None, max_tokens: int | None = None, max_tokens_ratio: float | None = 0.1, max_completion_tokens: int | None = None, max_prompt_tokens: int | None = None, get_initial_plan: Callable[[], str] | None = None, get_step_prompt: Callable[[], str] | None = None, max_iterations: int | None = 15, min_iteration_time_ms: int | None = 100, execution_settings: OpenAIPromptExecutionSettings | None = None)

Keyword-Only Parameters

Name	Description
excluded_plugins Required
excluded_functions Required
get_available_functions Required
max_tokens Required
max_tokens_ratio	Default value: 0.1
max_completion_tokens Required
max_prompt_tokens Required
get_initial_plan Required
get_step_prompt Required
max_iterations	Default value: 15
min_iteration_time_ms	Default value: 100
execution_settings Required

Methods

calculate_token_limits

Calculate the token limits based on the max_tokens and max_tokens_ratio.

calculate_token_limits

Calculate the token limits based on the max_tokens and max_tokens_ratio.

calculate_token_limits(data: Any) -> Any

Parameters

Name	Description
data Required

Attributes

execution_settings

execution_settings: OpenAIPromptExecutionSettings | None

get_initial_plan

get_initial_plan: Callable[[], str] | None

get_step_prompt

get_step_prompt: Callable[[], str] | None

max_completion_tokens

max_completion_tokens: int | None

max_iterations

max_iterations: int | None

max_prompt_tokens

max_prompt_tokens: int | None

max_tokens

max_tokens: int | None

max_tokens_ratio

max_tokens_ratio: float | None

min_iteration_time_ms

min_iteration_time_ms: int | None