--- schema_version: "1" id: 47491746ef599c6c8fef07e12f147d57be660a11aa692e0411571318fd9d9366 title: GenAiPlugin collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_genaiplugin.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplugin.htm source_site: developer.salesforce.com content_type: documentation content_hash: ec3cd3bbc3d803f4298b237ee531e5e7b24ca1d5c307c27a57757d3f0225b7d8 description: Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents. --- # GenAiPlugin Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents. ## 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 GenAiPlugin components have the suffix .genAiPlugin and are stored in the genAiPlugins folder. ## Version GenAiPlugin components are available in API version 62.0 and later. ## Special Access Rules GenAiPlugin is available only if Agents is enabled in your org. ## Fields | 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 Indicates whether this topic is eligible for escalation to a rep. | | description | Field Type string Description The description of the topic. | | developerName | 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. | | genAiFunctions | Field Type [GenAiPluginFunctionDef](#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. | | plannerField | Field Type string Description Represents the topic’s parent planner. | | 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. | ## GenAiPluginFunctionDef A function in the topic. | Field Name | Description | | --- | --- | | functionName | Field Type string Description Required. The API name of the function. | ## Usage In Winter '26 orgs and later, use [GenAiPlannerBundle](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiplannerbundle.htm "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).") to retrieve topics that are created within a particular agent. To retrieve topics in the asset library, use GenAiPlugin. 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 The following is an example of a GenAiPlugin component. Engages and interacts with the user about any request that could be CRM data related. This could be tasks such as identify and summarize records, answer queries, aggregate data, find and query objects, update records, or drafting and refining emails. General\_CRM\_Customized EmployeeCopilot\_\_IdentifyObjectByName EmployeeCopilot\_\_IdentifyRecordByName EmployeeCopilot\_\_QueryRecords EmployeeCopilot\_\_QueryRecordsWithAggregate EmployeeCopilot\_\_GetActivitiesTimeline EmployeeCopilot\_\_GetActivityDetails EmployeeCopilot\_\_GetRecordDetails EmployeeCopilot\_\_DraftOrReviseEmail EmployeeCopilot\_\_UpdateRecordFields EmployeeCopilot\_\_WebSearch EmployeeCopilot\_\_AnswerQuestionsWithKnowledge There are multiple available data retrieval functions at your disposal. You can use each one of them multiple times if needed. You should use functions as many times as necessary until you have all the data required to fulfill the request of the user. You can perform extra calls if you think you can get additional relevant information. therearemu0 therearemu Do not declare your intent i.e. "I will now retrieve the data" - Just fetch the data. donotdecla1 donotdecla Identify the object type (i.e., leads, opportunities, accounts) the user asks about. If unclear, confirm with the user and make a suggestion based on the query context and history. identifyth2 identifyth When only the name of a record is mentioned in the user request, you MUST call the IdentifyRecordByName action to get the necessary IDs. whenonlyth3 whenonlyth Always call QueryRecords & QueryRecordsWithAggregate passing plain natural language english as input. You must Include the record ID in the input if available. alwayscall4 alwayscall For accounts and contacts, combine the WebSearch action with the CRM data retrieval actions. MUST maintain citations in the answer. foraccount5 foraccount When a user asks for a summary or overview of a record, use GetRecordDetails to get an overview of the data of the record, then use other data retrieval actions as needed. whenausera6 whenausera When asked for a summary on multiple records, you must iterate over all record IDs and for each one, call GetRecordDetails. whenaskedf7 whenaskedf If the user asks about activities you must call GetActivitiesTimeline. iftheusera8 iftheusera When providing the Activity Types for GetActivitiesTimeline, choose all the types that are relevant to the user request. Examples - User Request 1 - "What questions does John Doe have that need addressing?", Activity Types - "Call", "Email". User Request 2 - "What are the next activities for John Doe?", Activity Types - "Task", "Event". whenprovid9 whenprovid When asked about recent activities, you should provide the answer, starting from the last 30 days and ending on the current date, unless a specific date range is specified by the user. whenaskeda10 whenaskeda When you are asked about a single Call, Meeting, Email or any other single specific activity, call GetActivityDetails. whenyouare11 whenyouare Always use DraftOrReviseEmail when asked to generate a new email or revise a previously generated email. alwaysused12 alwaysused ExtractRecordFieldsAndValuesFromUserInput must be called prior to UpdateRecordFields. extractrec13 extractrec Avoid using structured lists, bullet points, or numbered lists. Instead, present the information in complete sentences and paragraphs as if you were writing an article or a report. avoidusing14 avoidusing User questions which can be answered by knowledge articles or documents. These questions usually want information, instructions or guidance, including but not limited to customer questions about company information, policies and frequently asked questions. userquesti15 userquesti en\_US General CRM Customized Topic Your job is to interact and answer questions for the user about anything Salesforce or CRM data related, combining all data retrieval functions. i.e: QueryRecords(), GetRecordDetails(), GetActivitiesTimeline(), GetActivityDetails(), WebSearch() The following is an example package.xml that references the previous definition. \* GenAiPlugin 62.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.").