エンティティ

エンティティ タイプを使用して、エンドユーザー入力からデータを抽出する方法を制御します。

会話エージェント(Dialogflow CX)には、多数の一般的なデータタイプに対応する事前に定義されたシステム エンティティが用意されています。たとえば、日付、時刻、色、メールアドレスなどを照合するシステム エンティティがあります。カスタムデータを一致させる独自のカスタム エンティティを作成することもできます。たとえば、食料品店エージェントで購入可能な野菜の種類に一致する野菜エンティティを定義できます。

エンティティの用語

エンティティという用語は、このドキュメントおよび Dialogflow CX コンソールでエンティティの一般的なコンセプトを説明する目的で使用されています。エンティティの詳細を説明するときには、より具体的な用語を理解しておくことが重要です。

  • エンティティ タイプ: ユーザー入力から抽出する情報のタイプを定義します。 たとえば、「野菜」はエンティティ タイプの表示名になり得ます。Dialogflow CX コンソールの [エンティティ タイプ] セクションで [作成] をクリックすると、エンティティ タイプが作成されます。API を使用する際は、エンティティ タイプという用語が、EntityType タイプを指します。

    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 利用不可 利用できません

  • (省略可)説明: エンティティ タイプの目的を説明します(例: 「このエンティティは、ユーザーが野菜に言及したときにトリガーされます」)。AI 生成を使用して参照値の類義語を自動生成する場合、このフィールドはモデルによって高品質な結果を生成するために使用されます。

  • エンティティ エントリ: エンティティ タイプごとに多数のエンティティ エントリを指定できます。各エンティティ エントリには、同等と見なされる単語または句のセットが含まれています。1 列目には基準値、2 列目にはその基準値の 1 つ以上の類義語を指定します。たとえば、エンティティ タイプが野菜の場合、次のエンティティ エントリを定義できます。

    参照値 類義語
    青ネギ 新玉ねぎ、分葱
    ピーマン ピーマン、パプリカ
    carrot carrot
    ジャガイモ ジャガイモ

    エンティティ エントリと類義語を手動で入力する代わりに、新しいエンティティ エントリを作成するときに [エンティティごとに __ 個の類義語を自動生成] チェックボックスをオンにします。デフォルト値は 3 個の類義語です。AI は、参照値とエンティティ タイプの説明に基づいて類義語を生成し、テーブルに入力します。同義語リストに元の参照値を含める必要があります。そうしないと、その値と一致する値が生成されません。

    Dialogflow CX コンソールでエンティティ タイプを編集する場合、表示される各行がエンティティ エントリになります。API を使用する際はエンティティ エントリという用語が Entity タイプ(一部のクライアント ライブラリ言語では EntityType.Entity または EntityType_Entity)を指します。

  • エンティティ参照値と類義語: エンティティ エントリの中には、上記の新玉ねぎ(分葱)の例のように複数の単語や語句が含まれる場合があります。これらのエンティティ エントリには、1 つの基準値と 1 つ以上の類義語を定義します。