Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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
disableAIProvAWSBedrock	boolean	Indicates whether AWS Bedrock is turned off and access to its models are blocked. The default value is `false`.
disableAIProvAzureOpenAI	boolean	Indicates whether Azure OpenAI is turned off and access to its models are blocked. The default value is `false`.
disableAIProvOpenAI	boolean	Indicates whether OpenAI is turned off and access to its models are blocked. The default value is `false`.
disableAIProvVertexGemini	boolean	Indicates whether Vertex AI (Google) is turned off and access to its models are blocked. The default value is `false`.
disableAIProviderRegionFallback	boolean	Indicates whether the fallback of Azure OpenAI requests outside the model endpoint region for your org is turned off. The default value is `false`.
enableAIModelBeta	boolean	Indicates whether to turn on beta models for Einstein generative AI features. The default value is `false`.
enableEinsteinGptAllowUnsafePTInputChanges	boolean	Reserved for internal use.
enableEinsteinGPTDeployPromptTemplatesAsActive	boolean	Indicates whether to turn on the Deploy Active Prompt Template Versions Only setting. Deploys only the active version of prompt templates to this org, and skips inactive versions. If a template doesn't have an active version, the deployment fails. The default value is `false`.
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>

Metadata API Developer Guide

EinsteinGptSettings

File Suffix and Directory Location

Version

Fields

Declarative Metadata Sample Definition