Class BasePlanner`Abstract`

Abstract base class for all planners.

The planner allows the agent to generate plans for the queries to guide its action.

Hierarchy (View Summary)

BasePlanner
- BuiltInPlanner
- PlanReActPlanner

Constructors

constructor

new BasePlanner(): BasePlanner
Returns BasePlanner

Properties

`Readonly`[BASE_PLANNER_SIGNATURE_SYMBOL]

"[BASE_PLANNER_SIGNATURE_SYMBOL]": true

A unique symbol to identify ADK base planner class.

Methods

`Abstract`buildPlanningInstruction

buildPlanningInstruction(
readonlyContext: ReadonlyContext,
llmRequest: LlmRequest,
): string | undefined
Builds the system instruction to be appended to the LLM request for planning.
Parameters
- readonlyContext: ReadonlyContext
  The readonly context of the invocation.
- llmRequest: LlmRequest
  The LLM request. Readonly.
Returns string | undefined
The planning system instruction, or undefined if no instruction is needed.
- Defined in core/src/planners/base_planner.ts:52

`Abstract`processPlanningResponse

processPlanningResponse(
callbackContext: Context,
responseParts: Part[],
): Part[] | undefined
Processes the LLM response for planning.
Parameters
- callbackContext: Context
  The callback context of the invocation.
- responseParts: Part[]
  The LLM response parts. Readonly.
Returns Part[] | undefined
The processed response parts, or undefined if no processing is needed.
- Defined in core/src/planners/base_planner.ts:65