---
schema_version: "1"
id: 07fb13d21a49a2f370fc23873b7437972ebb2a5495e7ab3e8f3151aeccce18b2
title: ServiceAISetupDefinition
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_serviceAIsetupdefinition.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_serviceAIsetupdefinition.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6616592a32547b4468aaa9dcb0b53f28a40e80e9359f52f6b67b10aab1ee0149
description: 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.
---
# 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

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d851989e99">Field Name</th>

              <th class="featureTableHeader  " id="d851989e102">Field Type</th>

              <th class="featureTableHeader  " id="d851989e105">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d851989e99" data-title="Field Name"><span class="keyword parmname">appSourceType</span></td>

              <td class="entry" headers="d851989e102" data-title="Field Type">ApplicationSourceType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d851989e105" data-title="Description">Required. The target application for the configuration. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">REPLY_RECOMMENDATION</samp>—Einstein Reply
                    Recommendations
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ARTICLE_RECOMMENDATION</samp>—Einstein Article
                    Recommendations
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UTTERANCE_RECOMMENDATION</samp>—Einstein Bot
                    utterances
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FAQ</samp>—Einstein Bot frequently asked
                    questions
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d851989e99" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d851989e102" data-title="Field Type">string</td>

              <td class="entry" headers="d851989e105" data-title="Description">Required. A reference to the configuration.</td>

            </tr>

            <tr>
              <td class="entry" headers="d851989e99" data-title="Field Name"><span class="keyword parmname">setupStatus</span></td>

              <td class="entry" headers="d851989e102" data-title="Field Type">ServiceAISetupDefStatus (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d851989e105" data-title="Description">Required. The status of the configuration. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">FIELDS_SELECTED</samp></li>

                  <li class="li"><samp class="codeph nolang">TRAINING</samp></li>

                  <li class="li"><samp class="codeph nolang">READY_TO_ACTIVATE</samp></li>

                  <li class="li"><samp class="codeph nolang">SERVING</samp></li>

                  <li class="li"><samp class="codeph nolang">RETIRED</samp></li>

                  <li class="li"><samp class="codeph nolang">ARCHIVED</samp></li>

                  <li class="li"><samp class="codeph nolang">READY_FOR_REVIEW</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d851989e99" data-title="Field Name"><span class="keyword parmname">supportedLanguages</span></td>

              <td class="entry" headers="d851989e102" data-title="Field Type">string</td>

              <td class="entry" headers="d851989e105" data-title="Description">Required when <span class="keyword parmname">appSourceType</span> is <samp class="codeph nolang">ARTICLE_RECOMMENDATION</samp>. Language codes for selected and supported
                languages. </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

Here’s an example of a ServiceAISetupDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<ServiceAISetupDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <appSourceType\>ARTICLE\_RECOMMENDATION</appSourceType\>
    <name\>SA1601228426202</name\>
    <setupStatus\>ARCHIVED</setupStatus\>
    <supportedLanguages\>en,de,fr,it,es,pt,nl</supportedLanguages\>
</ServiceAISetupDefinition\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ServiceAISetupDefinition</name\>
    </types\>
</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](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.").