サポートされているエンティティタイプ4 min read

エンティティタイプは、ユーザーの発話から想定されるデータのタイプをNLPインタプリターに提供し、認識およびシステムパフォーマンスを向上させます。Kore.aiのNLPインタプリターは、ユーザーの発話からエンティティを抽出します。ユーザーが必須のエンティティを入力しなかった場合、ボットレスポンスノードを定義して、ユーザーにエンティティの入力を指示することができます。詳細情報は、ボットレスポンスノードの操作をご参照ください。また、ユーザーの入力を検証するためのエンティティルールを定義することもできます。詳細はこちらをご参照ください。エンティティノードには、以下のエンドユーザータイプが指定されます。

アドレス

アメリカとドイツの標準的な住所形式で書かれた住所をキャプチャします。例：200 E Main ST Pheonix AZ 85123 USA。完全な住所が文字列としてキャプチャされます。“200 E Main ST Pheonix AZ 85123 USA.”

"entities":
{
"AddressEntity": "200 E Main ST Pheonix AZ 85123 USA"
}

その他の国の住所については、認識可能な都市名や国名で終わる文字列をキャプチャします。詳細については、市内エンティティをご参照ください。

v8.1以降では、コンテキストオブジェクトから住所エンティティの完全なフォーマット化された住所にアクセスできるようになりました。コンテキストオブジェクトは以下のような形式になり、個別のフィールド値を取得することができます。

"autoFormattedEntities": {
     "Address": {
        "streetNumber": "200"
        "streetName": "E Main ST"
        "streetType":
        "POBox":
        "roadPrefix":
        "roadNumber":
        "city": "Pheonix"
        "county": "USA"
        "zip": "AZ 85123"
    }
 }

なお、すべてのシナリオですべてのフィールドが利用できるというわけではなく、国によって住所のタイプが異なります。

空港

以下の入力で空港の詳細をキャプチャします。

• 都市名
• 空港名
• IATAコード
• ICAO
• アメリカの都市の略語。

空港の詳細は、以下の要素を持つJSONエンティティとして返されます。

"AirportEntity":
  {"IATA": "LHR",
   "AirportName": "London Heathrow Airport",
   "City": "London",
   "ICAO": "EGLL",
   "Latitude": "51.4775", "Longitude": "-0.461389"
  }

すべての空港の詳細については、 https://github.com/opentraveldata/opentraveldata を使用しています。

添付ファイル（画像/ファイル）

ユーザーは25MBまでのファイル、画像、メールを添付することができます。

"entities":
{
"AttachmentEntity": "send"
}

メモ：現在、アタッチメントエンティティは以下の、Facebook、Twitter、Web/Mobile、Slackの各チャネルでのみサポートされています。

都市名

ニューヨークの気温はどのくらいですかのような発話における都市の名前。ボットは、人口5000人以上の都市名を文字列の形でキャプチャします。すべての市内の詳細については、www.geonames.org を使用しています。

"entities":
{
"CityEntity": "New York"
}

国名

アメリカ合衆国の首都はどこですかのようなユーザーの発話から、国名をキャプチャします。国の詳細は、下記の要素を持つJSONエンティティとして返されます。

"CountryEntity": {
      "alpha3": "USA",
      "alpha2": "US",
      "localName": "United States of America",
      "shortName": "United States",
      "numericalCode": 840
}

国名および国名コード表：https://www.nationsonline.org/oneworld/country_code_list.htm

会社名または組織名

Amazonの最寄りの支店のようになユーザーの発話から、企業名をキャプチャします。会社名の値は、文字列として返されます（Amazon）。サポートされている企業のリストをご覧ください。会社名コーパスには、言語固有の名前も含まれています。これにより、たとえばAmazon、Amazon.com、Amazon Inc.などの会社名が1つの会社として認識されます。サポートされている企業とは別に、ボットは、大文字で始まり、以下のような企業タイプの接尾語が続く単語を認識します。Inc, Incorporated, Corp, Corporation, Group, Ltd, Limited, Co, Company, LP, LLP, LLLP, LLC, PLLC。

 "entities":
{
"OrganizationEntity": "amazon"
}

色

ユーザーの発話から色の名前をキャプチャします。例：ステータスをグリーンに設定します。グリーンの色の値を文字列で返します。サポートされている色のリストをご覧ください。

"entities":
{
"ColorEntity": "green"
}

通貨

ユーザーの発話から、通貨の金額と種類をキャプチャします。例として、このハンドバッグの価格は200ドルです、200は金額で、米ドルは通貨です。このエンティティタイプは、以下を認識します。

• 完全な通貨名（ドル、ルピー、インド国民ルピー、ディナール）
• 通貨記号($, S$, £)
• 標準通貨の略語（INR、USD）
• 通貨によく使われるスラング（バック、ニッケル、ダイム、クイッド、 ルーニー、 トゥーニー、ベンジャミン、ジャクソン、ハミルトン。）

"CurrencyEntity":[
{
"code": "SGD",
"amount": 20
}

カスタム

表示された 正規表現フィールドに、ユーザー入力を検証するための正規の表現を定義します。たとえば、次のように入力します。[a-zA-Z]{3}[-]d{4} とすると、以下のようなサンプル応答を返すことができます。 {"regex":"NLP-1234"} 詳細情報は、正規の表現をご参照ください。

コンポジット

複合エンティティは、複数のエンティティ値を1つのエンティティでキャプチャするために使用されます。例として、自動車販売へ販売の問い合わせを考えてみましょう。一般的な質問は以下のようなものです。「テスラモデルSの2018年モデルに関心があります」、または「レッドのテスラ2010年モデルはいくらですか」、または「テスラモデルSについて教えてください」。 ご覧のように、ボットは通常、これらのクエリに応答するために、メーカー、モデル、年式、色などの詳細を組み合わせて処理する必要があります。これらのシナリオは、複合エンティティタイプによって処理されます。複合エンティティタイプの詳細については、こちらをご参照ください。

日付

ユーザーの発話から日付への言及をキャプチャします。例として、「10月10日のフライトを予約します」の場合、ISO8601の日付形式の値は、YYYY-MM-DDです。ボットは、以下のように、日付の可能性のあるあらゆる方法と形式を認識します。

• YYYY-MM-DD、DD-MM-YYY、DD-MM-YYY、YYY/MM/DD、DD/MM/YY、YYY.MM.DD、DD.MM.YYY、DD.MM.YYのようにフォーマット化された日付。
• 20180518および09102013などのYMDとDMYのようなすべて数字の日付。
• YYYY MM DD. dd/mm yyyy, dd-mm, dd-mm-yyy, mm-dd, dd / mm / yyyy, dd . mm . yyyy, ddmm yyyy, mmdd のようにスペース区切りでフォーマット化した日付。
• yyyy/dd/monthNames または yyyy-dd-monthNames または dd.monthNames.yyyy 2018/28/Dec または 2018-28-Dec または 28.Dec.2018 のような名前付きの月。
• 今日、明日、昨日、今夜、今日の夕方、今日の午後、明後日、一昨日、昨日の朝、明日の夜、明日の1時間前、3日前、24時間前、3日後、2ヶ月後の今日、去年の来月の今日、来年の6月、再来年の6月26日、1週間後、2週間前、今月の22日、来月の今日、来月の25日、今月の30日、今月の27日、3月、今月の2日のように現在に関連する絶対的な日付。
• クリスマスの日、クリスマスイブ、今年のメモリアルデー、サンクスギビング2018年、最後のサンクスギビング、サンクスギビングの翌週、過越祭、新年の前日、クリスマスの翌日といった名前のついた日付。
• 明日からあと2日、7月4日から3日後、今から3日後、今日から5日後、あと2日必要、2日後のように絶対的な日付から相対的な日付。
• 土曜日、来週の月曜日、日曜日、土曜日、次の週末、来年度の第1土曜日、来月の第1日曜日、来月の第1土曜日、来年度の第1日曜日などの曜日。

"entities":
{
"DateEntity": "1982-04-13"
}

日時

ユーザーの発話の中で、時間で日付をグループ化してキャプチャします。例として、「10月10日午後6時のフライト予約する」と入力すると、これは、YYYY-MM-DDThh: mm: ss.sTZDとしてISO8601の日付形式の日付の値で返されます。ボットは、日付と時刻のあらゆる可能性のある表現方法と形式を認識します。

"entities":
{
"DateEntity": "2017-10-10T18:00:00+05:30"
}

日付期間

ユーザー入力から開始日と終了日をキャプチャします。例：5月5日から5日間ホテルを予約する。ユーザー入力に日付の一方または両方が含まれていない場合、ボットはユーザーに必要な入力提示を指示します。

次のテーブルは、さまざまなシナリオでエンティティがどのように機能するかをリストアップしています。

説明

ユーザーの発話からテキストの文やパラグラフをキャプチャします。説明の値は文字列として返され、ワイルド文字を含めることができます。

"entities":
{
"Description": "text here"
}

メール

発話からメールアドレスをキャプチャします。例として、「メールを help@koremessenger.comに送信する」 は、メールの値を文字列として返します。

"entities":
{
"Email": "help@koremessenger.com"
}

アイテムのリスト（列挙型）

値のリストをエンドユーザーに表示します。リストタイプを定義するには、

1. アイテムのリスト（列挙型） タイプフィールドの横にある 設定アイコンをクリックします。
2. 「アイテムのリスト(列挙型) セットアップ」ページで、以下のリストタイプのいずれかを定義します。
   • 静的リスト
   • コンテクストからのリスト

この機能はすべての言語で完全にサポートされているわけではありません。詳細はこちらをクリックしてください。

• 静的リスト – キーの表示名、値、同義語を入力します。ユーザー入力の 自動修正値をセットアップします。
• コンテキストからのリスト表示 – このアイテムに使用するコンテキスト変数を以下のフィールドで定義します。
  • 使用するコンテキスト変数の指定 – コンテキストオブジェクトのタイプを定義します。例：EnterpriseContext、BotContext、UserContexts、またはcontext.entityのようなセッション変数。context.を入力して、コンテキストオブジェクトのタイプを選択します。
  • 表示名キー – エンドユーザーに表示される名前。
  • 値キー – リスト内のアイテムの値を表すキー。
  • 同義語キー – キーの同義語を1つ以上入力します（詳細はこちらをクリックしてください）。
• 自動修正– LOVエンティティタイプに自動修正のしきい値をセットアップして、完全に一致するものだけでなく、小さい変化を伴う最も近い発話も受け入れるようにします。例として、Appleというリストの値に、appel のようなタイプミスがしきい値設定に基づいて受け入れられると考えましょう。自動修正の設定は、以下のように機能します。
  1. ボットは、ユーザー入力において変更（挿入、削除、置換）される文字数を特定し、リストの値に一致させます。
  2. この数字は、入力された文字の総数に対する割合に変換されます。
  3. 設定された割合以上のスコアがある場合、最も類似性の高いリストの値が入力と見なされます。
  辞書に載っている単語や英数字の入力には、スペルの修正が適用されません。

v7.1以降では、以下のキーがコンテキストオブジェクトに追加され、以下のような使用方法になります。

• ambiguousEntityValues：このキーには、複数アイテムのエンティティに対するユーザー入力が不明瞭な場合の値が含まれます。これにより、不明瞭な値があったかどうかを確認し、その不明瞭さを解決するためのフローを構築することができます。このキーは、ダイアログ中にエンティティが再指示されると、リセットされます。値はJSONオブジェクトの配列で、各オブジェクトにはタイトル、値、同義語が含まれています。
• synonymsUsed: このキーは、アイテムを特定するために使用される同義語を保持します。この値は、必要に応じてボット応答をパーソナライズするために使用できます。このキーは、ダイアログ中にエンティティが再指示されると、リセットされます。

ユーザーにリストを表示するには、値リストの表示を「はい」に設定する必要があります。これは、チャネル固有の形式でユーザーに値リストを提示しますが、要件に応じてテンプレートを使用したくなります（詳細はこちらをご覧ください）。

アイテムのリスト（ルックアップ）

値リストをエンドユーザーに表示します。ルックアップリストを定義するには、

1. アイテムのリスト（ルックアップ型） タイプフィールドの横にある 設定アイコンをクリックします。
2. アイテムのリスト(ルックアップ型)のセットアップページで、以下のリストタイプのいずれかを定義します。
   • 静的リスト
   • リモートリスト

この機能は、すべての言語で完全にサポートされているわけではありません。詳細はこちらをクリックしてください。静的リスト：静的リストを使用して、エンティティの値を以下のリストタイプのいずれかとして定義します。

• JSONタブ – キー／値のペアおよび同義語のリストを入力します（詳細はこちらをクリックしてください） 。例：

  [{
  "title": "United States",
  "value": "US",
  "synonyms": ["united states", "USA", "US", "U.S.A", "America"]
  },
  {
  "title": "John F. Kennedy International Airport",
  "value": "JFK",
  "synonyms": ["John F. Kennedy International Airport", "New York International Airport", "JFK"]
  }
  ]

• エディター – キーの表示名、値、同義語を入力します。
• ファイルのアップロード – ファイルのアップロードをクリックして、JSON形式のファイルリスト、または.csvファイル形式のキー/値ペアのリストを検索します。例：

v7.1以降では、以下のキーがコンテキストオブジェクトに追加され、以下のような使用方法になります。

• ambiguousEntityValues：このキーには、複数アイテムのエンティティに対するユーザー入力が不明瞭な場合の値が含まれます。これにより、不明瞭な値があったかどうかを確認し、その不明瞭さを解決するためのフローを構築することができます。このキーは、ダイアログ中にエンティティが再指示されると、リセットされます。値はJSONオブジェクトの配列で、各オブジェクトにはタイトル、値、同義語が含まれています。
• synonymsUsed: このキーは、アイテムを特定するために使用される同義語を保持します。この値は、必要に応じてボット応答をパーソナライズするために使用できます。このキーは、ダイアログ中にエンティティが再指示されると、リセットされます。

ユーザーにリストを表示するには、値リストの表示を「はい」に設定する必要があります。これは、チャネル固有の形式でユーザーに値リストを提示しますが、要件に応じてテンプレートを使用したくなります（詳細はこちらをご覧ください）。

リモートリスト

リモートリストは、セキュリティ上の制限やその他の理由で、エンティティの抽出を外部のサービスで行う必要がある場合に使用します。また、大規模なデータを扱う場合にも使用できます。その手順は以下のとおりです。

1. サービスコールの定義：現在のサービスノードのセットアップと同様の方法で、サービスコールをセットアップすることができます。ヘッダーや本文（POSTの場合）などを設定できます。(詳しくはこちらをクリックしてください)。呼び出された外部サービスは、プラットフォームが入力するユーザーの発話データを受け入れて処理するための規定を備えている必要があります。以下のフィールドを持つcontext.inputDataオブジェクトは、その目的のために使用されます。
   • input – 現在のダイアログに関して、ユーザーから受け取った入力リストを含む配列。
   • usedUp – 既に他のエンティティやインテントに使用されている単語のインデックス形式。形式は、以下のx-y-zです
     • xは、文/発話インデックス（0からnまで）を表します。
     • yは、x発話の中で使用された単語の開始インデックスを表します。
     • zは、使用し終わった単語の終了インデックスを表します。
     • sentenceindex-x-x は、その文の中で使われていない単語を表します。
     • 1つの文章の中で複数の単語が使われている場合は、カンマで区切って入力する必要があります。
   • isMultiItem – フラグは、サービスコールで複数の値が想定される場合に設定する必要があります。

       "inputData": {
         "input": [
           "get account"
         ],
         "usedUp": [
           "0-x-x"
         ],
         "isMultiItem": false
       }

2. マップ応答：サービスコールからの応答には、以下のフィールドをマッピングできます。
   • サービスコールからの応答データを保持する コンテキスト変数。これは、配列形式である必要があります。
   • 表示キー名 – このフィールドを参照するために使用される名前。この名前はユーザーとの対話時に使用されます。例：明瞭にされたシナリオ時にこれには、{{context.entities.<entity-name>.title}}を使用してアクセスできます。
   • 値キー – 値を保持するサービスコールの応答本文内のフィールド名。エンティティにはこの値が割り当てられます。これには、{{context.entities.<entity-name>.value}}を使用してアクセスできます。
   • 同義語キー – このフィールドの同義語を含むフィールド（もしあれば）。これは、ユーザーが参照する値です。例：明瞭にされた質問に対して。これには、{{context.entities.<entity-name>.synonym}}を使用してアクセスできます。
   • 一致ワードインデックス – エンティティ抽出に使用された inputData内の単語を示すこと（context.inputData オブジェクトの usedUp 値と同じ形式）。これは、プラットフォームがユーザーの発話で使用された単語をマークするために使用されます。

フロー：このプラットフォームは、

1. context.inputData に上記の値を入力します。
2. サービスコールで設定した値を渡して、エンティティの値を取得するサービスコールを行います。
3. 応答マッピングに従って返された値を使用します。
   • リモートシステムから単一の値が返された場合は、その値がエンティティに割り当てられます。
   • リモートシステムから複数の値が返された場合、プラットフォームはこのリストからエンティティを抽出します。
     • 一致が見つかった場合、そのエンティティに割り当てられます。
     • 一致が見つからなかった場合、ユーザーには選択する値のリストが表示されます。ユーザー入力がリスト内のいずれかのアイテムと一致した場合、そのアイテムはエンティティに割り当てられます。ユーザー入力がいずれのアイテムにも一致しない場合は、入力がコンテキストオブジェクトで更新され、リモートサービスへの別の呼び出しが開始されます。
     • 1つ以上の一致が見つかった場合は、不明瞭であるとみなされ、ユーザーに選択肢が提示されます。ユーザー入力がリスト内のいずれかのアイテムと一致した場合、そのアイテムはエンティティに割り当てられます。ユーザー入力がいずれのアイテムにも一致しない場合は、入力がコンテキストオブジェクトで更新され、リモートサービスへの別の呼び出しが開始されます。
   • エンティティが複数アイテムのエンティティとしてマークされている場合は、リモートサーバーから返された値のリストが再評価され、すべての有効な（エンティティタイプごとに有効な）リストアイテムがエンティティ値として割り当てられます。無効なリストアイテムは破棄されます。
4. 以下の例外を処理します。
   • サービスコールからの応答が空であったり、想定した形式でない場合、エンティティのユーザープロンプト設定を使用して、ユーザーに入力を指示します。
   • 例として、1つの値を想定していたのに、サービスが複数の値を返してきた場合など、不明瞭である場合には、ユーザーは、サービスが返してきた値のリストから1つを選択するように指示されます。

位置

ユーザーの発話から、都市や州の位置情報をキャプチャします。例として、ベラージオ、ラスベガスでは、エンティティはラスベガスの位置の詳細をキャプチャします。エンティティは、オブジェクトの位置情報を、JSONレ応答として住所と座標で返します。

"Location":
{
"formatted_address": "Las Vegas, NV, USA",
"lat": 36.1699412,
"lng": -115.1398296
}

数字

ユーザーの発話から数字への言及をキャプチャします。例：16人用の部屋を予約する。この例では、値16が数字として返されます。ボットプラットフォームは、スペルアウトされた数字や、1Mなどの標準的な略語も認識します。連続した数字の単語が1つの数字にまとめられます。例として、いち、に、さんは123になります。メモ：最大許容桁数は18桁です。

"entities":
{
"NumberEntity": 16
}

個人名

ユーザーの発話から個人のフルネームをキャプチャします。例として、「ジョン・スミス宛にメールを送信する」では、 ジョン・スミスが個人名として特定されます。Kore.ai Botプラットフォームは、ユーザーの発話の中の最初の単語が大文字であればファーストネームであり、次の2つの単語はキャメルケースで名前の一部として表示されると想定しています。例として、ユーザーの発話が「I want to talk to John Smith（私はジョン・スミスと話したい）」の場合、John Smithを名前として認識します。「I want to talk to John smith」 という発話があった場合、名前としては Johnだけを認識します。

"entities":
{
"PersonName": "John Smith"
}

パーセンテージ

ユーザーの発話からパーセント値をキャプチャします。例として、「The chance of rain today is more than 60 percent（今日の雨の確率は60％以上です）」のように、60はパーセンテージで、0.0～1.0の範囲で0.6のフロート値として返されます。パーセント、パーセンテージ、および％記号がサポートされています。

"entities":
{
"PercentageEntity": 0.6
}

電話番号

10桁または12桁の標準的な電話番号をキャプチャします。例として、「4075551212に電話してください」の場合、電話番号の値は 4075551212となり、数字として返されます。

"entities":
{
"PhoneNumber": "+4075551212"
}

数量

ユーザーの発話から、以下の詳細を含む発話の量をキャプチャします。

• 数量のタイプ（長さ、面積、体積など）。
• 測定単位（キロメートル、平方キロメートル、立方メートルなど）。
• 金額（100、500、1.5など）。

数量のエンティティタイプを選択する際には、数量の単位タイプとデフォルトの測定値も選択する必要があります。例として、体積をキャプチャする場合、 単位元のタイプに体積 、 デフォルトの単位にキロリットルを選択します。つまり、ユーザーの発話が「500mlの水を加える」の場合、次のようなJSONが返されます。

"Quantity":
{
"unit": "millilitre",
"amount": 500,
"type": "volume",
"source": "500 ml"
}

ボットプラットフォームは、これらの数量や単位を、標準的な略語やコード、記号で識別します。

文字列

説明エンティティタイプ と同じ作品ですが、一文に限定されています。トレーニングされていない限り、ユーザーの発話に対して文字列エンティティの検証を行うことはありません。したがって、このエンティティタイプは、プラットフォームでサポートされているどのエンティティタイプでも要件が満たされない場合の最終手段として使用されます。

時間

ユーザーの発話で時間をキャプチャします。例として、「アラームを午前6時にセットする」の場合、時間の値はISO 8601時間形式でhh:mm:ss.sZDとして返されます。以下のような明示的意味が認識されています。

• • am、a.m.、AM、pm、p.m.、PM、P.M.
  • 数字を綴り。例：6 AM。
  • 朝と夜。例：夕方の6時。

"entities":
{
"TimeZoneEntity": "-06:00"
}

タイムゾーン

あるタイムゾーン。東部標準時は、タイムゾーンをGMTに変換し、その結果の値を保存します。例として、ESTと入力すると、-6:00と保存されます。ボットプラットフォームは標準タイムゾーンを認識しています。

"entities":
{
"URLEntity": "www.kore.ai"
}

URL

発話からWebのURLをキャプチャします。ボットは、あらゆる標準形式のURLを認識します。例として、「私たちのWebサイト： www.kore.ai 訪問してください。」URLの値を文字列で返します。

"entities": { "URLEntity": "www.kore.ai" }

郵便番号

ユーザーの発話から米国の郵便番号をキャプチャします。例：「32746の天気はどうですか？」郵便番号の値は32746で、文字列として返されます。

"entities": { "ZipcodeEntity": "32746" }