Metadata API Developer Guide
jNewer Version Available
EinsteinGptSettings
Represents settings for Einstein Generative
AI features in an org.
This type extends the Metadata metadata
type and inherits its fullName field
In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.
File Suffix and Directory Location
EinsteinGptSettings values are stored in the EinsteinGpt.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.
Version
EinsteinGptSettings components are available in API version 61.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| enableEinsteinGptGlobalLangSupport | boolean | Indicates whether to turn on global languages with prompt templates. The default value is false. |
| enableEinsteinGptPlatform | boolean | Indicates whether to turn on generative AI features across Salesforce. The default value is false. |
Declarative Metadata Sample Definition
The following is an example of an EinsteinGptSettings component.
1<?xml version="1.0" encoding="UTF-8"?>
2<EinsteinGptSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <enableEinsteinGptGlobalLangSupport>true</einsteinAgentRecommendations>
4 <enableEinsteinGptPlatform>true</reRunAttributeBasedRules>
5</EinsteinGptSettings>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>EinsteinGpt</members>
5 <name>Settings</name>
6 </types>
7 <version>63.0</version>
8</Package>