カスタム エンティティ

カスタム エンティティを作成して、エージェント固有のデータをマッチングできます。たとえば、食料品店エージェントで購入可能な野菜の種類に一致する vegetable エンティティ タイプを定義できます。

注: エージェントを作成する際、インテントにトレーニング フレーズを追加する前にエンティティを定義することをおすすめします。コンソールは、既存のエンティティを使ってトレーニング フレーズに自動的にアノテーションを付けます。トレーニング フレーズの後にエンティティを作成する場合は、トレーニング フレーズに手動でアノテーションを付けることができます。

カスタム エンティティの作成

カスタム エンティティを作成するには、次の手順を行います。

コンソール

1. Dialogflow CX コンソールを開きます。
2. ご自身の Google Cloud プロジェクトを選択します。
3. エージェントを選択します。
4. [Manage] タブを選択します。
5. [エンティティ タイプ] をクリックします。
6. [作成] をクリックします。
7. エンティティ データを入力します。
8. [保存] をクリックします。

API

EntityType の create メソッドを使用します。EntityType API リファレンスに移動

EntityType リファレンスのプロトコルとバージョンを選択:

プロトコル	V3	V3beta1
REST	EntityType リソース	EntityType リソース
RPC	EntityType インターフェース	EntityType インターフェース
C++	EntityTypesClient	利用できません
C#	EntityTypesClient	利用できません
Go	EntityTypesClient	利用できません
Java	EntityTypesClient	EntityTypesClient
Node.js	EntityTypesClient	EntityTypesClient
PHP	利用不可	利用できません
Python	EntityTypesClient	EntityTypesClient
Ruby	利用不可	利用できません

終了

制限事項

次の制限が適用されます。

• カスタム エンティティ タイプの表示名は、エージェントごとに一意です。エンティティ タイプの表示名の先頭は英字にしてください。その後には A-Z、a-z、0-9、_（アンダースコア）、-（ダッシュ）を使用できます。エンティティの参照と類義語の値にこのような制限はありません。

カスタム エンティティのエクスポートとインポート

プレビュー

このプロダクトまたは機能には、サービス固有の利用規約の「一般的なサービス規約」の「pre-GA サービス規約」が適用されます。 一般提供前のプロダクトと機能は「現状のまま」ご利用いただけますが、サポートが制限される場合があります。 詳しくは、リリース ステージの説明をご覧ください。

エンティティをエクスポートおよびインポートして、エージェント間で共有できます。

エクスポート形式のオプションの 1 つは Json パッケージです。これは、ディレクトリと JSON ファイルの階層を含む zip ファイルです。 ディレクトリ構造は次のとおりです。

• entityTypes: このディレクトリにはエンティティ タイプが含まれます。
  • <entity type name>: これらのディレクトリが 1 つ以上存在し、ディレクトリ名はエンティティ タイプの表示名に対応しています。
    • entities: このディレクトリには、エンティティ エントリ ファイルが含まれています。
      • <language tag>.json: これらのファイルが 1 つ以上存在し、ファイル名は言語タグに対応しています。 各ファイルには、言語固有のエンティティ エントリが含まれています。
    • <excludedPhrases>: このディレクトリには、除外フレーズ ファイルが含まれています。
      • <language tag>.json: これらのファイルが 1 つ以上存在し、ファイル名は言語タグに対応しています。 各ファイルには、言語固有のフレーズの除外が含まれています。
    • <entity type name>.json: このファイル名はエンティティ タイプの表示名に対応します。 このファイルには、他のファイルでは見つからないエンティティ タイプ固有のデータが含まれています。

次に例を示します。

 entityTypes
 ⤷  Entity Type A
    ⤷  entities
       ⤷  en.json
       ⤷  en-gb.json
       ⤷  en-ca.json
    ⤷  excludedPhrases
       ⤷  en.json
       ⤷  en-gb.json
       ⤷  en-ca.json
    ⤷  Entity Type A.json
 ⤷  Entity Type B
    ⤷  entities
       ⤷  en.json
       ⤷  en-gb.json
       ⤷  en-ca.json
    ⤷  excludedPhrases
       ⤷  en.json
       ⤷  en-gb.json
       ⤷  en-ca.json
    ⤷  Entity Type B.json

エンティティ タイプをインポートする際に、既存のエージェントのエンティティ タイプの表示名がインポートされたエンティティ タイプの表示名と一致すると、マージの競合が発生する可能性があります。 エンティティ タイプの表示名が一致する場合のマージ動作は、次のいずれかを選択して制御できます。

• 既存のエンティティ タイプを置き換える: インポートされたエンティティ タイプは、既存のエージェントにある同じ名前のエンティティ タイプを上書きします。
• 既存のエンティティ タイプとマージする: インポートされたエンティティ タイプのエンティティ エントリは、既存のエンティティ タイプに追加されます。同じエンティティ エントリが存在する場合、重複は発生せず、それらのエントリの下の類義語がマージされます。
• 名前を変更して新しいエンティティ タイプとしてインポートする: インポートされたエンティティ タイプは名前が変更され、表示名に「_1」が追加されます。
• エンティティ タイプをスキップする: 既存のエンティティ タイプは変更されず、インポートしたエンティティ タイプは無視されます。

エンティティ タイプをエクスポートするには:

コンソール

1. Dialogflow CX コンソールを開きます。
2. ご自身の Google Cloud プロジェクトを選択します。
3. エージェントを選択します。
4. [Manage] タブを選択します。
5. [エンティティ タイプ] をクリックします。
6. エクスポートするエンティティ タイプをすべて選択します。
7. [選択したエンティティをエクスポート] をクリックします。
8. 形式とエクスポート先を選択します。
9. [送信] をクリックします。

エンティティ タイプをインポートするには:

コンソール

1. Dialogflow CX コンソールを開きます。
2. ご自身の Google Cloud プロジェクトを選択します。
3. エージェントを選択します。
4. [Manage] タブを選択します。
5. [エンティティ タイプ] をクリックします。
6. [インポート] をクリックします。
7. ソースとマージ動作を選択します。
8. [送信] をクリックします。

エンティティのエントリをインポートする

プレビュー

このプロダクトまたは機能には、サービス固有の利用規約の「一般的なサービス規約」の「pre-GA サービス規約」が適用されます。 一般提供前のプロダクトと機能は「現状のまま」ご利用いただけますが、サポートが制限される場合があります。 詳しくは、リリース ステージの説明をご覧ください。

エンティティ エントリを既存のエンティティ タイプにインポートできます。

エンティティ エントリのインポートに使用されるファイル形式は、エンティティ タイプのインポートに使用される形式と同じです。ただし、インポート ファイルに含めることができるエンティティ タイプは 1 つだけです。また、その下のすべてのエントリが、選択したエンティティ タイプにインポートされます。 同じエンティティ エントリが存在する場合、重複は発生せず、それらのエントリの下の類義語がマージされます。

エンティティ タイプのエンティティ エントリをインポートするには:

コンソール

1. Dialogflow CX コンソールを開きます。
2. ご自身の Google Cloud プロジェクトを選択します。
3. エージェントを選択します。
4. [Manage] タブを選択します。
5. [エンティティ タイプ] をクリックします。
6. エンティティを選択します。
7. [エンティティにインポート] をクリックします。
8. ファイルを選択してください。
9. [送信] をクリックします。