GenAiPlanner

Represents a copilot planner service that uses a large language model (LLM) and a reasoning strategy to decompose a given task into smaller subtasks, identify the most suitable actions for each subtask, and invoke them.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

GenAiPlanner components have the suffix .genAiPlanner and are stored in the genAiPlanners folder.

Version

GenAiPlanner components are available in API version 60.0 and later.

Special Access Rules

GenAiPlanner is available only if Einstein Copilot is enabled in your org.

Fields

Field Name	Description
capabilities	Field Type string Description Required. A set of tags associated with the copilot planner service definition.
description	Field Type string Description A description explaining the general purpose and domain of the copilot planner service definition.
genAiFunctions	Field Type GenAiPlannerFunctionDef[] Description A list of copilot action definitions.
masterLabel	Field Type string Description Required. The master label of the copilot planner service definition.
plannerType	Field Type PlannerType (enumeration of type string) Description Required. A particular approach to problem solving that is given as prompt instructions to a large language model (LLM). Values are: `AiCopilot__ReAct`—Uses a reactive planning strategy to solve problems with the LLM. This strategy consists of prompting the LLM to generate the next step in response to an event and the current context. It differs from a sequential planner in that it doesn’t plan more than one step ahead of time. `AiCopilot__SequentialPlannerIntentClassifier`—Uses an intent classifier prompt and a sequential planner prompt. With each text input, the planner asks the LLM to generate a step-by-step plan to finish the goal. It plans first, then executes.

GenAiPlannerFunctionDef

Represents a copilot action definition.

Field Name	Description
genAiFunctionName	Field Type string Description Required. The name of the copilot action.

Declarative Metadata Sample Definition

The following is an example of a GenAiPlanner component.

1<?xml version="1.0" encoding="UTF-8"?>
2<GenAiPlanner xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>Copilot planner description</description>
4    <masterLabel>EmployeeCopilotPlanner</masterLabel>
5    <plannerType>AiCopilot__SequentialPlannerIntentClassifier</plannerType>
6</GenAiPlanner>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3   <types>
4      <members>*</members>
5      <name>GenAiPlanner</name>
6   </types>
7   <version>60.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide