{
"sections": [
"title",
"description",
"file_information",
"fields",
"sub_types",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "GenAiPlannerBundle - Metadata API",
"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).",
"file_information": "GenAiPlannerBundle components have the suffix .genAiPlannerBundle and are stored in a subfolder for the agent in the genAiPlannerBundles folder.",
"fields_columns": [
"type",
"description",
"required"
],
"fields": {
"attributeMappings": {
"type": "GenAiPlannerAttrMapping[]",
"description": "A list of action attribute mappings."
},
"botTemplate": {
"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": {
"type": "string",
"description": "A set of tags associated with the agent."
},
"description": {
"type": "string",
"description": "A description explaining the general purpose and domain of the agent."
},
"genAiFunctions": {
"type": "GenAiPlannerFunctionDef[]",
"description": "A list of agent action definitions, such as a knowledge action, that are not contained in a topic."
},
"genAiPlugins": {
"type": "GenAiPlannerFunctionDef[]",
"description": "A list of agent topic definitions."
},
"masterLabel": {
"type": "string",
"required": true,
"description": "The master label for the planner."
},
"plannerType": {
"type": "PlannerType (enumeration of type string)",
"required": true,
"description": "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."
},
"ruleExpressionAssignments": {
"type": "GenAiPlannerRuleExprAsgn[]",
"description": "A list of rule expression assignments."
},
"ruleExpressions": {
"type": "GenAiPlannerRuleExprDef[]",
"description": "A list of rule expressions."
}
},
"sub_types": {
"GenAiPlannerAttrMapping": {
"attributeName": {
"type": "string",
"required": true,
"description": "The attribute name in the format: Namespace.TopicName.ActionName.AttributeName."
},
"attributeType": {
"type": "AttributeType (enumeration of type string)",
"required": true,
"description": "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": {
"type": "string",
"description": "Reserved for future use."
},
"mappingTargetName": {
"type": "string",
"description": "The target name for the attribute mapping."
},
"mappingType": {
"type": "AttributeMappingType (enumeration of type string)",
"required": true,
"description": "The target type. Values are: ActionAttribute Constant Variable ContextVariable"
}
},
"GenAiPlannerFunctionDef": {
"genAiCustomizedPlugin": {
"type": "GenAiLocalPlugin[]",
"description": "A list of custom agent topics."
},
"genAiFunctionName": {
"type": "string",
"description": "The name of the agent action."
},
"genAiPluginName": {
"type": "string",
"description": "The name of the agent topic."
}
},
"GenAiLocalPlugin": {
"aiPluginUtterances": {
"type": "AiPluginUtteranceDef[]",
"description": "A list of utterances that can be used to pick a topic during runtime."
},
"canEscalate": {
"type": "boolean",
"description": "Determines whether this topic is applicable for escalation to a rep."
},
"description": {
"type": "string",
"required": true,
"description": "The description of the topic."
},
"genAiFunctions": {
"type": "GenAiPluginFunctionDef[]",
"description": "A list of functions in the topic."
},
"genAiPluginInstructions": {
"type": "GenAiPluginInstructionDef[]",
"description": "A list of instructions in the topic."
},
"language": {
"type": "string",
"required": true,
"description": "The language of the topic."
},
"masterLabel": {
"type": "string",
"required": true,
"description": "The master label for the topic."
},
"name": {
"type": "string",
"required": true,
"description": "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": {
"type": "PluginType (enumeration of type string)",
"required": true,
"description": "Values are: Topic APICustomTopic"
},
"scope": {
"type": "string",
"description": "A specific job description for a topic."
}
},
"GenAiPlannerRuleExprAsgn": {
"ruleExpressionName": {
"type": "string",
"required": true,
"description": "The name of the rule expression."
},
"targetName": {
"type": "string",
"required": true,
"description": "The target of the assignment, which is a Namespace.TopicName.ActionName or a TopicName."
},
"targetType": {
"type": "string",
"required": true,
"description": "The type of the target. Values are: Function—A knowledge action Plugin—A topic PluginFunction—An action in a topic"
}
},
"GenAiPlannerRuleExprDef": {
"conditions": {
"type": "GenAiPlannerRuleExprCondition[]",
"description": "A list of conditions for a rule expression."
},
"expression": {
"type": "string",
"description": "An expression with the combined conditions."
},
"expressionLabel": {
"type": "string",
"required": true,
"description": "The expression label."
},
"expressionName": {
"type": "string",
"required": true,
"description": "The expression name."
},
"expressionType": {
"type": "string",
"description": "The expression type. Values are: handlebars—Reserved for future use sel—Salesforce Expression Language, as used in formula fields"
}
},
"GenAiPlannerRuleExprCondition": {
"leftOperand": {
"type": "string",
"required": true,
"description": "The left operand in the expression."
},
"leftOperandType": {
"type": "GenAiAgentVariableType (enumeration of type string)",
"required": true,
"description": "The type for the left operand. Values are: Variable ContextVariable Attribute"
},
"operator": {
"type": "GenAiRuleExpressionOperator (enumeration of type string)",
"required": true,
"description": "The operator in the expression. Values are: equal greaterThan greaterThanOrEqual lessThan lessThanOrEqual notEqual isEmpty isNotEmpty"
},
"rightOperandValue": {
"type": "string",
"description": "The value for the right operand."
}
}
},
"wsdl_segment": "```xml\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n\n```",
"declarative_metadata_sample_definition": [
{
"description": "Here’s an example of a GenAiPlannerBundle component.",
"code": "\n\n \n attributeName>SvcCopilotTmpl__CaseManagement.SvcCopilotTmpl__CreateCaseEnhancedData.verifiedCustomerID\n StandardPluginFunctionInput\n VerifiedCustomerId\n Variable\n \n \n SvcCopilotTmpl__CaseManagement.SvcCopilotTmpl__GetCasesForVerifiedContact.verifiedContactID\n StandardPluginFunctionInput\n VerifiedCustomerId\n Variable\n \n \n SvcCopilotTmpl__CaseManagement.SvcCopilotTmpl__GetCaseByVerifiedCaseNumber.verifiedContactID\n StandardPluginFunctionInput\n VerifiedCustomerId\n Variable\n \n \n SvcCopilotTmpl__ServiceCustomerVerification.SvcCopilotTmpl__SendEmailVerificationCode.authenticationKey\n StandardPluginFunctionOutput\n authenticationKey\n Variable\n \n \n SvcCopilotTmpl__ServiceCustomerVerification.SvcCopilotTmpl__SendEmailVerificationCode.customerId\n StandardPluginFunctionOutput\n customerId\n Variable\n \n \n SvcCopilotTmpl__ServiceCustomerVerification.SvcCopilotTmpl__SendEmailVerificationCode.customerType\n StandardPluginFunctionOutput\n customerType\n Variable\n \n \n SvcCopilotTmpl__ServiceCustomerVerification.SvcCopilotTmpl__VerifyCustomer.authenticationKey\n StandardPluginFunctionInput\n authenticationKey\n Variable\n \n \n SvcCopilotTmpl__ServiceCustomerVerification.SvcCopilotTmpl__VerifyCustomer.customerId\n StandardPluginFunctionInput\n customerId\n Variable\n \n \n SvcCopilotTmpl__ServiceCustomerVerification.SvcCopilotTmpl__VerifyCustomer.customerType\n StandardPluginFunctionInput\n customerType\n Variable\n \n \n SvcCopilotTmpl__ServiceCustomerVerification.SvcCopilotTmpl__VerifyCustomer.isVerified\n StandardPluginFunctionOutput\n isVerified\n Variable\n \n \n SvcCopilotTmpl__ServiceCustomerVerification.SvcCopilotTmpl__VerifyCustomer.customerId\n StandardPluginFunctionOutput\n VerifiedCustomerId\n Variable\n \n \n SvcCopilotTmpl__AccountManagement.SvcCopilotTmpl__ResetSecurePassword.verifiedContactID\n StandardPluginFunctionInput\n VerifiedCustomerId\n Variable\n \n \n SvcCopilotTmpl__AccountManagement.SvcCopilotTmpl__UpdateVerifiedContact.verifiedContactID\n StandardPluginFunctionInput\n VerifiedCustomerId\n Variable\n \n Deliver personalized customer interactions with an autonomous AI agent. Agentforce Service Agent intelligently supports your customers with common inquiries and escalates complex issues.\n \n EmployeeCopilot__AnswerQuestionsWithKnowledge\n \n \n SvcCopilotTmpl__AccountManagement\n \n \n SvcCopilotTmpl__CaseManagement\n \n \n SvcCopilotTmpl__Escalation\n \n \n SvcCopilotTmpl__GeneralFAQ\n \n \n SvcCopilotTmpl__ServiceCustomerVerification\n \n ASA Template Base\n AiCopilot__ReAct\n \n Verified_User\n SvcCopilotTmpl__AccountManagement\n Plugin\n \n \n Verified_User\n SvcCopilotTmpl__CaseManagement\n Plugin\n \n \n \n isVerified\n Variable\n equal\n true\n \n Verified_User\n Verified User\n Verified_User\n sel\n \n"
}
]
}