Configure a Component for Use in Setup with Agentforce (Beta)
Add an AI-related description to your component to make it accessible to Agentforce in Setup. AI component descriptions are used only in orgs that have Setup with Agentforce (Beta) enabled. For more information about the Setup with Agentforce beta program, see Streamline Administrative Tasks with Setup with Agentforce (Beta).
When Setup with Agentforce is enabled in an org, the Setup agent can analyze and recommend custom components when creating a new Lightning page from a user utterance. For Agentforce to successfully analyze whether your custom component fits the requirements outlined in the user’s utterance, the component must contain an AI-related description of what it does as well as descriptions of its properties.
Setup with Agentforce is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.
In the component’s js-meta.xml file, add the ai tag set at the top level. Specify the ai tag only once. The ai tag at the top level contains one description tag, and can contain multiple property tags. The description tag contains the overall AI-related component description.
Each property tag in the ai tag set at the top level contains the AI-related description for a single component property, and supports only the name and aiDescription attributes.
Define the component properties using the property tag in the targetConfig tag set just like usual.
To specify target-specific AI descriptions for each component property, add an aiDescription attribute to the property tag in the targetConfig tag set. This attribute isn’t required, but it’s useful if you want different AI-related property descriptions for each target page type.
You can also add an ai tag set within the targetConfig tag set to specify a target-specific AI description for the component. This ai tag contains one description tag. This tag set isn’t required, but it’s useful if you want different component descriptions for each target page type.
If you don’t specify an aiDescription attribute on a property tag in the targetConfig section, the property’s AI description is taken from the aiDescription value that’s defined for the property in the top-level ai tag set. For example, in the record page targetConfig section of the codeblock below, the “prop2” property doesn’t have an aiDescription attribute defined. As a result, on record pages, that property’s AI description comes from the aiDescription value for that property defined in the top-level ai tag set.
Similarly, if you don’t add an ai tag set in the targetConfig section, the component’s AI description is taken from the description that’s defined in the top-level ai tag set.
Unless you need target-specific descriptions for your component and properties, we recommend using only the ai tag set at the top level.