Metadata API Developer Guide
jNewer Version Available
GenAiPromptTemplate
Parent Type
This type extends the Metadata metadata type and inherits its
fullName field.
File Suffix and Directory Location
GenAiPromptTemplate components have the suffix .genAiPromptTemplate and are stored in the genAiPromptTemplates folder.
Version
GenAiPromptTemplate components are available in API version 60.0 and later.
Special Access Rules
GenAiPromptTemplate is available only if Prompt Builder is enabled in your org and you have the Prompt Template Manager permission.
To send GenAiPromptTemplate components from one Salesforce org to another, you must use change sets.
Fields
| Field Name | Description |
|---|---|
| activeVersion |
|
| description |
|
| masterLabel |
|
| relatedEntity |
|
| relatedField |
|
| templateVersions |
|
| type |
|
| visibility |
|
GenAiPromptTemplateVersion
Represents a version of a prompt template.
| Field Name | Description |
|---|---|
| content |
|
| description |
|
| inputs |
|
| primaryModel |
|
| status |
|
| templateDataProviders |
|
| versionNumber |
|
GenAiPromptTemplateInput
Represents an input for a prompt template, such as a Salesforce record, field, or Apex primitive data type.
| Field Name | Description |
|---|---|
| apiName |
|
| definition |
|
| description |
|
| masterLabel |
|
| referenceName |
|
| required |
|
GenAiPromptTemplateDataProvider
Represents a source of data for a prompt template version, such as an invocable action, flow, or Apex method.
| Field Name | Description |
|---|---|
| definition |
|
| parameters |
|
| referenceName |
|
GenAiPromptTemplateDataProviderParam
Represents a parameter that a data provider uses to retrieve information.
| Field Name | Description |
|---|---|
| definition |
|
| isRequired |
|
| parameterName |
|
| valueExpression |
|
Declarative Metadata Sample Definition
The following is an example of a GenAiPromptTemplate component.
1<?xml version="1.0" encoding="UTF-8"?>
2<GenAiPromptTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
3 <activeVersion>1</activeVersion>
4 <description>Recommend relevant financial products to client based on their needs and goals</description>
5 <masterLabel>Recommend Relevant Products</masterLabel>
6 <relatedEntity>Contact</relatedEntity>
7 <templateVersions>
8 <content>You are a financial advisor at {!$Input:Sender.CompanyName} and your name is {!$Input:Sender.Name}. You are writing an email to a prospective client recommending relevant financial products based on their data and goals. Reference the data below to generate your email, recommending only relevant products for the customer that match our recommendation criteria for each product.
9Client name: {!$Input:Recipient.Name}
10Client age: {!$Input:Recipient.Age__c}
11Client occupation: {!$Input:Recipient.Occupation__c}
12Client income: {!$Input:Recipient.Income__c}
13Client financial goals: {!$Input:Recipient.Financial_Goals__c}
14
15{!$Flow:Fetch_Products.Prompt}
16
17Generate a subject line that can increase the open rate using words and content that is related to the email body content. It must be no more than 10 words.
18Start the opening message of the email with an ice-breaker talking about relevant challenges or opportunities with personal finance and how you can help.
19Indirectly allude to a point of common interest, shared background, or relevant experience with {!$Input:Recipient.Name}. You aim to subtly reference or highlight this connection to establish rapport, demonstrate relevance, and foster a sense of familiarity.
20Indirectly encourage the lead {!$Input:Recipient.Name} to respond to your email by showing that you are willing to discuss opportunities for working together and answer any questions they may have.
21Be concise in your email.</content>
22 <inputs>
23 <apiName>Sender</apiName>
24 <definition>SOBJECT://User</definition>
25 <referenceName>Input:Sender</referenceName>
26 <required>true</required>
27 </inputs>
28 <inputs>
29 <apiName>Recipient</apiName>
30 <definition>SOBJECT://Contact</definition>
31 <referenceName>Input:Recipient</referenceName>
32 <required>true</required>
33 </inputs>
34 <primaryModel>sfdc_ai__DefaultOpenAIGPT4</primaryModel>
35 <status>Published</status>
36 <templateDataProviders>
37 <definition>flow://Fetch_Products</definition>
38 <parameters>
39 <definition>SOBJECT://User</definition>
40 <isRequired>true</isRequired>
41 <parameterName>Sender</parameterName>
42 <valueExpression>{!$Input:Sender}</valueExpression>
43 </parameters>
44 <parameters>
45 <definition>SOBJECT://Contact</definition>
46 <isRequired>true</isRequired>
47 <parameterName>Recipient</parameterName>
48 <valueExpression>{!$Input:Recipient}</valueExpression>
49 </parameters>
50 <referenceName>Flow:Fetch_Products</referenceName>
51 </templateDataProviders>
52 <versionNumber>1</versionNumber>
53 </templateVersions>
54 <type>einstein_gpt__salesEmail</type>
55 <visibility>Global</visibility>
56</GenAiPromptTemplate>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>GenAiPromptTemplate</name>
6 </types>
7 <version>60.0</version>
8</Package>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.