GenAiPlanner

Represents a planner for an agent. It’s a container for all the topics and actions used to interact with a large language model (LLM).

This type extends Metadata and inherits its fields.

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

GenAiPlannerBundle replaces GenAiPlanner in API version 64.0 and later.

GenAiPlanner components are available in API version 60.0 to 63.0.

GenAiPlanner is available only if Agents is enabled in your org.

• Type: GenAiPlannerAttrMapping[]
• Required: No
• Description: A list of action attribute mappings.

• Type: string
• Required: No

• Type: string
• Required: No
• Description: A set of tags associated with the agent.

• Type: string
• Required: No
• Description: A description explaining the general purpose and domain of the agent.

• Type: GenAiPlannerFunctionDef[]
• Required: No
• Description: A list of agent action definitions, such as a knowledge action, that are not contained in a topic.

• Type: GenAiPlannerRuleExpr[]
• Required: No
• Description: Deprecated. Use ruleExpressions instead.

• Type: GenAiPlannerFunctionDef[]
• Required: No
• Description: A list of agent topic definitions.

• Type: string
• Required: Yes
• Description: Required. The master label for the planner.

• Type: PlannerType (enumeration of type string)

• Required: Yes

• Description: Required. A particular approach to problem solving that is given as prompt instructions to a large language model (LLM).

  The only supported value is:

• Possible values:

  • 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.

• Type: GenAiPlannerRuleExprAsgn[]
• Required: No
• Description: A list of rule expression assignments.

• Type: GenAiPlannerRuleExprDef[]
• Required: No
• Description: A list of rule expressions.

Represents a custom agent topic.

• Type: AiPluginUtteranceDef[]
• Required: No
• Description: A list of utterances that can be used to pick a topic during runtime.

• Type: boolean
• Required: No

• Type: string
• Required: Yes
• Description: The description of the topic.

• Type: GenAiPluginFunctionDef[]
• Required: No
• Description: A list of functions in the topic.

• Type: GenAiPluginInstructionDef[]
• Required: No
• Description: A list of instructions in the topic.

• Type: string

• Required: Yes

• Description: Required.

  The language of the topic.

• Type: string
• Required: No

• Type: string

• Required: Yes

• Description: Required.

  The master label for the topic.

• Type: string

• Required: Yes

• 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.

• Type: PluginType (enumeration of type string)

• Required: Yes

• Description: Required.

  Values are:

• Possible values:

  • Topic

• Type: string
• Required: No
• Description: A specific job description for a topic.

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.

• Type: string
• Required: Yes
• Description: Required. The attribute name in the format: Namespace.TopicName.ActionName.AttributeName.

• Type: AttributeType (enumeration of type string)
• Required: Yes
• Description: Required. The attribute type. Values are:
• Possible values:
  • CustomPluginFunctionAttribute — Map to a custom action input or output
  • StandardPluginFunctionInput — Map to a standard action input
  • StandardPluginFunctionOutput — Map output to a variable

• Type: string
• Required: No
• Description: Reserved for future use.

• Type: string
• Required: No
• Description: The target name for the attribute mapping.

• Type: AttributeMappingType (enumeration of type string)
• Required: Yes
• Description: Required. The target type. Values are:
• Possible values:
  • ActionAttribute
  • Constant
  • Variable
  • ContextVariable

Represents an agent topic or action definition.

• Type: GenAiLocalPlugin
• Required: No
• Description: A list of custom agent topics.

• Type: string
• Required: No
• Description: The name of the agent action.

• Type: string
• Required: No
• Description: The name of the agent topic.

• Type: GenAiPlannerRuleExprCondition[]
• Required: No

• Type: string
• Required: No

• Type: string
• Required: Yes

• Type: string
• Required: Yes

• Type: ExpressionType (enumeration of type string)
• Required: No

Represents a rule-expression assignment to either a topic or an action.

• Type: string
• Required: Yes
• Description: Required. The name of the rule expression.

• Type: string
• Required: Yes
• Description: Required. The target of the assignment, which is a Namespace.TopicName.ActionName or a TopicName.

• Type: string (enumeration of type string)
• Required: Yes
• Description: Required. The type of the target. Values are:
• Possible values:
  • Function — A knowledge action
  • Plugin — A topic
  • PluginFunction — An action in a topic

Represents a condition for a rule expression.

• Type: string
• Required: Yes
• Description: Required. The left operand in the expression.

• Type: GenAiAgentVariableType (enumeration of type string)
• Required: Yes
• Description: Required. The type for the left operand. Values are:
• Possible values:
  • Variable
  • ContextVariable
  • Attribute

• Type: GenAiRuleExpressionOperator (enumeration of type string)
• Required: Yes
• Description: Required. The operator in the expression. Values are:
• Possible values:
  • equal
  • greaterThan
  • greaterThanOrEqual
  • lessThan
  • lessThanOrEqual
  • notEqual
  • isEmpty
  • isNotEmpty

• Type: string
• Required: No
• Description: The value for the right operand.

Represents a rule expression, which conditionally locks or unlocks topics and actions based on defined security criteria.

• Type: GenAiPlannerRuleExprCondition[]
• Required: No
• Description: A list of conditions for a rule expression.

• Type: string
• Required: No
• Description: An expression with the combined conditions.

• Type: string
• Required: Yes
• Description: Required. The expression label.

• Type: string
• Required: Yes
• Description: Required. The expression name.

• Type: ExpressionType (enumeration of type string)
• Required: No
• Description: The expression type. Values are:
• Possible values:
  • handlebars — Reserved for future use
  • sel — Salesforce Expression Language, as used in formula fields

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 reasoning engine 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>

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.