ServiceAISetupDefinition

Represents settings for an Einstein for Service feature such as Einstein Article Recommendations. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ServiceAISetupDefinition components have the suffix .serviceAISetupDescription and are stored in the serviceAISetupDescriptions folder.

Version

ServiceAISetupDefinition components are available in API version 51.0 and later.

Special Access Rules

This type is available only when an org is configured to access the application in the appSourceType field. For example, if appSourceType is set to ARTICLE_RECOMMENDATION, this type is available only if Einstein Article Recommendations is enabled in the org and the Main Services Agreement has been accepted.

Fields

Field Name	Field Type	Description
appSourceType	ApplicationSourceType (enumeration of type string)	Required. The target application for the configuration. Valid values are: `REPLY_RECOMMENDATION`—Einstein Reply Recommendations `ARTICLE_RECOMMENDATION`—Einstein Article Recommendations `UTTERANCE_RECOMMENDATION`—Einstein Bot utterances `FAQ`—Einstein Bot frequently asked questions
name	string	Required. A reference to the configuration.
setupStatus	ServiceAISetupDefStatus (enumeration of type string)	Required. The status of the configuration. Valid values are: `FIELDS_SELECTED` `TRAINING` `READY_TO_ACTIVATE` `SERVING` `RETIRED` `ARCHIVED` `READY_FOR_REVIEW`
supportedLanguages	string	Required when appSourceType is `ARTICLE_RECOMMENDATION`. Language codes for selected and supported languages.

Declarative Metadata Sample Definition

The following is an example of a ServiceAISetupDefinition component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ServiceAISetupDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3    <appSourceType>ARTICLE_RECOMMENDATION</appSourceType>
4    <name>SA1601228426202</name>
5    <setupStatus>ARCHIVED</setupStatus>
6    <supportedLanguages>en,de,fr,it,es,pt,nl</supportedLanguages>
7</ServiceAISetupDefinition>

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>ServiceAISetupDefinition</name>
6    </types>
7</Package>

Usage

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.

Metadata API Developer Guide