--- schema_version: "1" id: 46d60d95acf68997c17fac74581e4276b39baf11abbd7137bdd3925801f751d4 title: GenAiPlannerBundle collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_genaiplannerbundle.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplannerbundle.htm source_site: developer.salesforce.com content_type: documentation content_hash: 8ece3bd8bfcfa67eb7ab8c580f7328f1e6302ea90d8a10283a9592b30507c509 description: Represents a planner for an agent or agent template. It’s a container for all the topics and actions used to interact with a large language model (LLM). --- # GenAiPlannerBundle Represents a planner for an agent or agent template. It’s a container for all the topics and actions used to interact with a large language model (LLM). ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. ## File Suffix and Directory Location GenAiPlannerBundle components have the suffix .genAiPlannerBundle and are stored in a subfolder for the agent in the genAiPlannerBundles folder. ## Version GenAiPlannerBundle components are available in API version 64.0 and later. GenAiPlannerBundle replaces GenAiPlanner, which is available in API version 63.0 and earlier. ## Special Access Rules GenAiPlannerBundle is available only if Agents is enabled in your org. ## Fields | Field Name | Description | | --- | --- | | attributeMappings | Field Type [GenAiPlannerAttrMapping](#section_GenAiPlannerAttrMapping)\[\] Description A list of action attribute mappings. | | botTemplate | Field Type string Description If this planner is used by an agent template instead of an agent, this field is the template associated with the planner. | | capabilities | Field Type string Description A set of tags associated with the agent. | | description | Field Type string Description A description explaining the general purpose and domain of the agent. | | genAiFunctions | Field Type [GenAiPlannerFunctionDef](#GenAiPlannerFunctionDef)\[\] Description A list of agent action definitions, such as a knowledge action, that are not contained in a topic. | | genAiPlugins | Field Type [GenAiPlannerFunctionDef](#GenAiPlannerFunctionDef)\[\] Description A list of agent topic definitions. | | masterLabel | Field Type string Description Required. The master label for the planner. | | 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). The supported values are: - AiCopilot\_\_AgileAppDev—Uses an iterative development strategy to assist with building applications using the LLM. This strategy prompts the LLM to generate modular, testable components based on evolving user input and context. Unlike linear workflows, it supports continuous refinement and feedback loops throughout the development process. - AiCopilot\_\_ReAct—Uses a reactive reasoning 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 reasoning engine in that it doesn’t plan more than one step ahead of time. - Atlas\_\_ConcurrentMultiAgentOrchestration—Uses a unified orchestration strategy to solve problems with the LLM across text and voice agent interactions. This strategy prompts the LLM to plan and execute multiple steps concurrently, coordinating across sub-agents and tools. Unlike single-step reactive strategies, it supports parallel tool calling and multi-agent coordination within a single interaction. | | ruleExpressionAssignments | Field Type [GenAiPlannerRuleExprAsgn](#section_GenAiPlannerRuleExprAsgn)\[\] Description A list of rule expression assignments. | | ruleExpressions | Field Type [GenAiPlannerRuleExprDef](#section_GenAiPlannerRuleExprDef)\[\] Description A list of rule expressions. | ## GenAiPlannerAttrMapping Represents an attribute mapping, which enables you to map the output of one action attribute to the input of another attribute. This mapping enables you to propagate sensitive data safely without relying on untrusted user input. | Field Name | Description | | --- | --- | | attributeName | Field Type string Description Required. The attribute name in the format: Namespace.TopicName.ActionName.AttributeName. | | attributeType | Field Type AttributeType (enumeration of type string) Description Required. The attribute type. Values are: - CustomPluginFunctionAttribute—Map to a custom action input or output - StandardPluginFunctionInput—Map to a standard action input - StandardPluginFunctionOutput—Map output to a variable | | constantValue | Field Type string Description Reserved for future use. | | mappingTargetName | Field Type string Description The target name for the attribute mapping. | | mappingType | Field Type AttributeMappingType (enumeration of type string) Description Required. The target type. Values are: - ActionAttribute - Constant - Variable - ContextVariable | ## GenAiPlannerFunctionDef Represents an agent topic or action definition. | Field Name | Description | | --- | --- | | genAiCustomizedPlugin | Field Type [GenAiLocalPlugin](#section_GenAiLocalPlugin)\[\] Description A list of custom agent topics. | | genAiFunctionName | Field Type string Description The name of the agent action. | | genAiPluginName | Field Type string Description The name of the agent topic. | ## GenAiLocalPlugin Represents a custom agent topic. | Field Name | Description | | --- | --- | | aiPluginUtterances | Field Type [AiPluginUtteranceDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_aipluginutterancedef.htm "Represents an utterance that can be used to pick a topic during runtime.")\[\] Description A list of utterances that can be used to pick a topic during runtime. | | canEscalate | Field Type boolean Description Determines whether this topic is applicable for escalation to a rep. | | description | Field Type string Description Required. The description of the topic. | | genAiFunctions | Field Type [GenAiPluginFunctionDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugin.htm#GenAiPluginFunctionDef)\[\] Description A list of functions in the topic. | | genAiPluginInstructions | Field Type [GenAiPluginInstructionDef](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugininstructiondef.htm "Represents a topic instruction.")\[\] Description A list of instructions in the topic. | | language | Field Type string Description Required. The language of the topic. | | masterLabel | Field Type string Description Required. The master label for the topic. | | name | Field Type string Description Required. Represents the API name of the topic. This name must be unique across all custom and customized topics. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. | | pluginType | Field Type PluginType (enumeration of type string) Description Required. Values are: - Topic - APICustomTopic | | scope | Field Type string Description A specific job description for a topic. | ## GenAiPlannerRuleExprAsgn Represents a rule-expression assignment to either a topic or an action. | Field Name | Description | | --- | --- | | ruleExpressionName | Field Type string Description Required. The name of the rule expression. | | targetName | Field Type string Description Required. The target of the assignment, which is a Namespace.TopicName.ActionName or a TopicName. | | targetType | Field Type string Description Required. The type of the target. Values are: - Function—A knowledge action - Plugin—A topic - PluginFunction—An action in a topic | ## GenAiPlannerRuleExprDef Represents a rule expression, which conditionally locks or unlocks topics and actions based on defined security criteria. | Field Name | Description | | --- | --- | | conditions | Field Type [GenAiPlannerRuleExprCondition](#section_GenAiPlannerRuleExprCondition)\[\] Description A list of conditions for a rule expression. | | expression | Field Type string Description An expression with the combined conditions. | | expressionLabel | Field Type string Description Required. The expression label. | | expressionName | Field Type string Description Required. The expression name. | | expressionType | Field Type string Description The expression type. Values are: - handlebars—Reserved for future use - sel—Salesforce Expression Language, as used in formula fields | ## GenAiPlannerRuleExprCondition Represents a condition for a rule expression. | Field Name | Description | | --- | --- | | leftOperand | Field Type string Description Required. The left operand in the expression. | | leftOperandType | Field Type GenAiAgentVariableType (enumeration of type string) Description Required. The type for the left operand. Values are: - Variable - ContextVariable - Attribute | | operator | Field Type GenAiRuleExpressionOperator (enumeration of type string) Description Required. The operator in the expression. Values are: - equal - greaterThan - greaterThanOrEqual - lessThan - lessThanOrEqual - notEqual - isEmpty - isNotEmpty | | rightOperandValue | Field Type string Description The value for the right operand. | ## Usage In Winter ‘26 orgs and later, use GenAiPlannerBundle to retrieve topics and actions created in an agent. To retrieve global topics and actions, or those created in the Asset Library, use [GenAiPlugin](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugin.htm "Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents.") and [GenAiFunction](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaifunction.htm "Represents an agent action that can be added to an AI agent."). In Summer ‘25 orgs and earlier, deploy topic and action metadata using [GenAiPlugin](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugin.htm "Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents.") and [GenAiFunction](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaifunction.htm "Represents an agent action that can be added to an AI agent."). When deploying topic or action metadata to a Summer '25 (version 64.0) org, retrieve the metadata using Metadata API version 64.0, even if your source org is Winter '26 or later (version 65.0). For Winter \`26 and later, use Metadata API version 65.0 and later. ## Declarative Metadata Sample Definition Here’s an example of a GenAiPlannerBundle component. attributeName>SvcCopilotTmpl\_\_CaseManagement.SvcCopilotTmpl\_\_CreateCaseEnhancedData.verifiedCustomerID StandardPluginFunctionInput VerifiedCustomerId Variable SvcCopilotTmpl\_\_CaseManagement.SvcCopilotTmpl\_\_GetCasesForVerifiedContact.verifiedContactID StandardPluginFunctionInput VerifiedCustomerId Variable SvcCopilotTmpl\_\_CaseManagement.SvcCopilotTmpl\_\_GetCaseByVerifiedCaseNumber.verifiedContactID StandardPluginFunctionInput VerifiedCustomerId Variable SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_SendEmailVerificationCode.authenticationKey StandardPluginFunctionOutput authenticationKey Variable SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_SendEmailVerificationCode.customerId StandardPluginFunctionOutput customerId Variable SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_SendEmailVerificationCode.customerType StandardPluginFunctionOutput customerType Variable SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_VerifyCustomer.authenticationKey StandardPluginFunctionInput authenticationKey Variable SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_VerifyCustomer.customerId StandardPluginFunctionInput customerId Variable SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_VerifyCustomer.customerType StandardPluginFunctionInput customerType Variable SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_VerifyCustomer.isVerified StandardPluginFunctionOutput isVerified Variable SvcCopilotTmpl\_\_ServiceCustomerVerification.SvcCopilotTmpl\_\_VerifyCustomer.customerId StandardPluginFunctionOutput VerifiedCustomerId Variable SvcCopilotTmpl\_\_AccountManagement.SvcCopilotTmpl\_\_ResetSecurePassword.verifiedContactID StandardPluginFunctionInput VerifiedCustomerId Variable SvcCopilotTmpl\_\_AccountManagement.SvcCopilotTmpl\_\_UpdateVerifiedContact.verifiedContactID StandardPluginFunctionInput VerifiedCustomerId Variable Deliver personalized customer interactions with an autonomous AI agent. Agentforce Service Agent intelligently supports your customers with common inquiries and escalates complex issues. EmployeeCopilot\_\_AnswerQuestionsWithKnowledge SvcCopilotTmpl\_\_AccountManagement SvcCopilotTmpl\_\_CaseManagement SvcCopilotTmpl\_\_Escalation SvcCopilotTmpl\_\_GeneralFAQ SvcCopilotTmpl\_\_ServiceCustomerVerification ASA Template Base AiCopilot\_\_ReAct Verified\_User SvcCopilotTmpl\_\_AccountManagement Plugin Verified\_User SvcCopilotTmpl\_\_CaseManagement Plugin isVerified Variable equal true Verified\_User Verified User Verified\_User sel The following is an example package.xml that references the previous definition. \* GenAiPlannerBundle 64.0 ## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").