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 full)

BasePlanner
- BuiltInPlanner
- PlanReActPlanner

Index

Constructors

Methods

buildPlanningInstruction processPlanningResponse

Constructors

constructor

new BasePlanner(): BasePlanner
Returns BasePlanner

Methods

`Abstract`buildPlanningInstruction

buildPlanningInstruction(readonlyContext, llmRequest): string
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
The planning system instruction, or undefined if no instruction is needed
- Defined in packages/adk/src/planners/base-planner.ts:19

`Abstract`processPlanningResponse

processPlanningResponse(callbackContext, responseParts): Part[]
Processes the LLM response for planning.
Parameters
- callbackContext: CallbackContext
  The callback context of the invocation
- responseParts: Part[]
  The LLM response parts. Readonly.
Returns Part[]
The processed response parts, or undefined if no processing is needed
- Defined in packages/adk/src/planners/base-planner.ts:31