Skip to main content

portia.planning_agents.base_planning_agent

PlanningAgents module creates plans from queries.

This module contains the PlanningAgent interfaces and implementations used for generating plans based on user queries. It supports the creation of plans using tools and example plans, and leverages LLMs to generate detailed step-by-step plans. It also handles errors gracefully and provides feedback in the form of error messages when the plan cannot be created.

BasePlanningAgent Objects​

class BasePlanningAgent(ABC)

Interface for planning.

This class defines the interface for PlanningAgents that generate plans based on queries. A PlanningAgent will implement the logic to generate a plan or an error given a query, a list of tools, and optionally, some example plans.

Attributes:

  • config Config - Configuration settings for the PlanningAgent.

__init__​

def __init__(config: Config) -> None

Initialize the PlanningAgent with configuration.

Arguments:

  • config Config - The configuration to initialize the PlanningAgent.

generate_steps_or_error​

@abstractmethod
def generate_steps_or_error(
        ctx: ExecutionContext,
        query: str,
        tool_list: list[Tool],
        examples: list[Plan] | None = None) -> StepsOrError

Generate a list of steps for the given query.

This method should be implemented to generate a list of steps to accomplish the query based on the provided query and tools.

Arguments:

  • ctx ExecutionContext - The context for execution.
  • query str - The user query to generate a list of steps for.
  • tool_list list[Tool] - A list of tools available for the plan.
  • examples list[Plan] | None - Optional list of example plans to guide the PlanningAgent.

Returns:

  • StepsOrError - A StepsOrError instance containing either the generated steps or an error.

StepsOrError Objects​

class StepsOrError(BaseModel)

A list of steps or an error.

This model represents either a list of steps for a plan or an error message if the steps could not be created.

Attributes:

  • steps list[Step] - The generated steps if successful.
  • error str | None - An error message if the steps could not be created.