MlDomain (ベータ) | メタデータ API 開発者ガイド

ファイルのサフィックスおよびディレクトリの場所

NLU 機能はプレビュー版であり、Salesforce とのマスターサブスクリプション契約における「サービス」には含まれません。この機能はお客様各自の裁量で使用し、購入するときは、現在正式にリリースされている製品および機能に基づいて判断してください。Salesforce はこの機能の特定期間内の正式リリースまたはリリースの有無を保証せず、いつでも中止できます。この機能は評価のみを目的とし、本番環境での使用はできません。この機能は現状のまま提供され、サポートの対象外です。この機能に起因あるいは関連して生じた危害または損害に対して Salesforce は一切の責任を負わないものとします。制限、Salesforce の権利の留保、サービスに関するお客様の義務、関連する Salesforce 以外のアプリケーションおよびコンテンツの使用規約はすべて、お客様によるこの機能の使用にも同様に適用されます。

MlDomain コンポーネントのサフィックスは .mlDomain で、mlDomains フォルダに保存されます。

バージョン

MlDomain コンポーネントは、API バージョン 43.0 以降で使用できます。

特別なアクセスルール

このオブジェクトを使用できるのは、組織で Live Agent と Einstein Bots が有効になっている場合のみです。

項目

項目名	項目種別	説明
description	string	Einstein Intent セットの説明。
label	string	Einstein Intent セットの名前。
mlIntents	MlIntent[]	この Einstein Intent セットの Intent のリスト。
mlSlotClasses	MlSlotClass[]	この Einstein Intent セットのエンティティのリスト。

MlIntent

Einstein Intent セットの Intent。

項目名	項目種別	説明
description	string	Einstein Intent セットの説明。
developerName	string	必須。一意の名前を使用して、同じボットバージョンに関連付けられた他の Einstein Intent セットとの競合を回避します。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
label	string	Einstein Intent セットの名前。
mlIntentUtterances	MlIntentUtterance[]	この Intent への顧客の入力のリスト。
relatedMlIntents	MlRelatedIntent[]	この Intent への顧客の入力を展開するために使用する Einstein Intent セットの Intent のリスト。ローカルの Einstein Intent セットの Intent にのみ、関連する Intent があります。

MlIntentUtterance

この Intent への顧客の入力。

項目名	項目種別	説明
utterance	string	親 Intent をトリガする、顧客の入力または自然言語によるクエリ。

MlRelatedIntent

この Intent への顧客の入力を展開するために使用する Einstein Intent セットの Intent。ローカルの Einstein Intent セットの Intent にのみ、関連する Intent があります。

項目名	項目種別	説明
relatedMlIntent	string	現在の親 Intent の顧客の入力を展開するために使用する Intent の名前。

MlSlotClass

この Einstein Intent セットのエンティティ。

項目名	項目種別	説明
description	string	Einstein Bot エンティティの説明。
developerName	string	必須。一意の名前を使用して、Einstein Intent セット内の他のエンティティとの競合を回避します。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
extractionRegex	string	種別が `Pattern` に設定されている場合にエンティティを抽出するために使用する正規表現。
extractionType	MlSlotClassExtractionType (string 型の列挙)	必須。有効な値は、次のとおりです。 `Pattern` `Value`
label	string	Salesforce ユーザインターフェース全体でエンティティを識別する表示ラベル。
mlSlotClassValues	MlSlotClassValue[]	`Value` 種別のエンティティに関連付けられたエンティティ値のリスト。

MlSlotClassValue

Value 種別のエンティティに関連付けられたエンティティ値。

項目名	項目種別	説明
synonymGroup	SynonymGroup	現在のエンティティ値の用語またはシノニムのリストを表します。
value	文字列型	`Value` 種別のエンティティを抽出するために使用する 1 つの値。

SynonymGroup

同義の単語または語句のグループを表します。

項目名	項目種別	説明
languages	Language (string 型の列挙)	必須。値リストを適用する言語を指定します。値リスト項目が 1 つの言語に固有である場合は、その言語のみを指定します。値リスト項目を複数の言語に適用する場合は、1 つの値リストに複数の言語を指定します。
terms	string	必須。値リストの他の用語と同義の単語または語句です。

宣言的なメタデータの定義のサンプル

次に、MlDomain の例を示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<MlDomain xmlns="http://soap.sforce.com/2006/04/metadata">
3    <label>TestDomainMetadata</label>
4    <description>This is domain 2 for metadata testing</description>
5    <mlIntents>
6        <developerName>Test_Intent_New</developerName>
7        <label>Test Intent New</label>
8        <mlIntentUtterances>
9            <utterance>Utterance Hello</utterance>
10        </mlIntentUtterances>
11        <mlIntentUtterances>
12            <utterance>Utterance Hi</utterance>
13        </mlIntentUtterances>
14        <mlIntentUtterances>
15            <utterance>Utterance What</utterance>
16        </mlIntentUtterances>
17    </mlIntents>
18    <mlIntents>
19        <developerName>Test_Intent_New2</developerName>
20        <label>Test Intent New 2</label>
21    </mlIntents>
22    <mlSlotClasses>
23        <developerName>Test_Entity1</developerName>
24        <label>Test Entity 1</label>
25        <extractionType>Value</extractionType>
26        <mlSlotClassValues>
27                <value>Choice value 1</value>
28            </mlSlotClassValues>
29            <mlSlotClassValues>
30                <value>Choice value 2</value>
31            </mlSlotClassValues>
32    </mlSlotClasses>
33    <mlSlotClasses>
34        <developerName>Test_Entity2</developerName>
35        <label>Test Entity 2</label>
36        <extractionType>Pattern</extractionType>
37    </mlSlotClasses>
38    <mlSlotClasses>
39        <developerName>airport</developerName>
40        <extractionType>Value</extractionType>
41        <label>airport</label>
42        <mlSlotClassValues>
43            <synonymGroup>
44                <languages>en_US</languages>
45                <terms>San Francisco</terms>
46                <terms>The City</terms>
47            </synonymGroup>
48            <value>SFO</value>
49        </mlSlotClassValues>
50        <mlSlotClassValues>
51            <synonymGroup>
52                <languages>en_US</languages>
53                <terms>Oakland</terms>
54                <terms>The Town</terms>
55            </synonymGroup>
56            <value>OAK</value>
57        </mlSlotClassValues>
58    </mlSlotClasses>
59</MlDomain>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>TestDomainMetadata</members>
5        <name>MlDomain</name>
6    </types>
7    <version>43.0</version>
8</Package>