Add your own topics to the in-app help

Extend AI Engine's in-app help assistant with your org's own topics, such as custom fields and internal processes, using a JSON static resource.

AI Engine has a built-in help assistant: users reach it with the ? Help mode in the Sales Agent chat, and admins with Ask AI Assistant on the ? Help & Setup tab. It answers from AI Engine's own help content. With a help extension you add topics that are specific to your org, for example what your custom fields mean or how your team qualifies a lead, and the assistant uses them in its answers.

Before you start#

You need permission to create Static Resources in Setup (usually a System Administrator).
Decide which topics users ask about that the standard help cannot know.

Create the extension#

Create a text file, for example help-extension.json, with this structure:

{
  "version": 1,
  "publisher": "Your company",
  "entries": [
    {
      "topic": "Delivery risk field",
      "description": "The Delivery Risk field on Opportunity is set by the logistics team and shows whether the promised date is at risk.",
      "steps": [
        "Open the Opportunity.",
        "Check Delivery Risk in the Logistics section.",
        "If it is High, ask the chat for the open cases on the account before calling the customer."
      ]
    }
  ]
}

Check the file in a JSON validator. A file that is not valid JSON is ignored without an error message.
In Salesforce, go to Setup, enter Static Resources in the Quick Find box, select Static Resources and click New.
Enter the Name AIEngineHelpExtension exactly as written.
Under File, choose your JSON file. Upload the file itself, not a ZIP archive.
Set Cache Control to Private and click Save.
Test it: open the Sales Agent, switch on Help mode with ? and ask about one of your topics.

The assistant picks up the extension with the next help question. Nothing else needs to be configured.

Format#

Key	Required	Meaning
`version`	Optional	Use `1`
`publisher`	Optional	Your company or team name. The assistant presents the entries as custom features from this publisher; without it, as features of this org
`entries`	Required	A list of topics
`entries[].topic`	Required	The topic name. Entries without a topic are skipped
`entries[].description`	Optional	One or two sentences explaining the topic
`entries[].steps`	Optional	A list of steps, passed to the assistant as a numbered list

Good to know#

Both assistants use it. The extension is added to the knowledge of the user Help mode and of the admin assistant, so write entries that make sense for both audiences.
It is sent to your AI provider. The extension text goes to your configured AI provider with each help question, like the rest of the help content. Do not include passwords, personal data or anything confidential.
Keep it short. Every entry is included with every help question, which adds tokens to each call. Help questions are logged in the Activity Monitor as User Help and Admin Help.
Invalid JSON is ignored. If the file cannot be read as JSON, or has no entries list, the assistant answers from the standard help only and shows no error.
To update it, open the Static Resource, click Edit, choose the new file and save. To remove the extension, delete the Static Resource.