agents.planning_v2.base.models¶

Data models for planning agents.

This module contains Pydantic models for planning agent configurations, plans, steps, and other planning-related data structures.

Classes¶

`Plan`	Generic plan model that can work with any step type.
`Status`	Status for tasks and plans.
`Task`	Simple task model.

Module Contents¶

class agents.planning_v2.base.models.Plan(/, **data)¶

Bases: pydantic.BaseModel, Generic[StepType]

Generic plan model that can work with any step type.

Supports both linear and tree/split structures.

Parameters:: data (Any)

objective¶: What this plan aims to accomplish

steps¶: List of steps (can be Tasks or nested Plans)

result¶: The outcome of the plan execution

status¶: Current status of the plan

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.

add_parallel_steps(steps)¶

Add multiple steps that can be executed in parallel (same parent index).

Parameters:: steps (list[Union[StepType, Plan]])
Return type:: list[Union[StepType, Plan]]

add_step(step)¶

Add a step with auto-indexing.

Parameters:: step (Union[StepType, Plan])
Return type:: Union[StepType, Plan]

create_subplan(objective)¶

Create a nested subplan for tree structures.

Parameters:: objective (str)
Return type:: Plan

property completed_count: int¶

Number of completed steps.

Return type:: int

property completed_steps: list[StepType | Plan]¶

List of completed steps.

Return type:: list[Union[StepType, Plan]]

property current_step: StepType | Plan | None¶

The current step being executed (first in_progress or pending).

Return type:: Union[StepType, Plan] | None

property failed_steps: list[StepType | Plan]¶

List of failed steps.

Return type:: list[Union[StepType, Plan]]

property has_failures: bool¶

Whether any steps have failed.

Return type:: bool

property is_complete: bool¶

Whether all steps are completed.

Return type:: bool

property progress_percentage: float¶

Percentage of completion (0-100).

Return type:: float

property remaining_count: int¶

Number of steps remaining.

Return type:: int

property steps_remaining: list[StepType | Plan]¶

List of steps that haven’t been completed yet.

Return type:: list[Union[StepType, Plan]]

property total_steps: int¶

Total number of steps (including nested).

Return type:: int

class agents.planning_v2.base.models.Status¶

Bases: str, enum.Enum

Status for tasks and plans.

Initialize self. See help(type(self)) for accurate signature.

class agents.planning_v2.base.models.Task(/, **data)¶

Bases: pydantic.BaseModel

Simple task model.

Parameters:: data (Any)

objective¶: What this task aims to accomplish

result¶: The outcome of the task (None if not completed)

status¶: Current status of the task

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.