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

エンティティタイプは、認識とシステムのパフォーマンスを向上させるために、ユーザーの発言から期待されるタイプのデータを NLP インタープリタに提供します。 Kore.ai NLP インタープリタはユーザの発言からエンティティを抽出します。ユーザーが必要なエンティティを入力しない場合は、エンティティを提供するようにユーザーに促すボットレスポンスノードを定義することができます。詳細については、ボットレスポンスノードの操作を参照してください。

エンティティノードには、以下のエンティティタイプを指定することができます。

住所

200 E Main ST Pheonix AZ 85123 USA のように、標準的な米国とドイツの住所フォーマットで書かれた住所をキャプチャします。完全な住所は文字列としてキャプチャされます。””200 E Main ST Pheonix AZ 85123 USA””

""エンティティ"":
{
""住所エンティティ"": ""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 エンティティとして返されます。

""空港エンティティ"":
 {""IATA"": ""LHR"",
  ""空港名"": ""ロンドン・ヒースロー空港"",
  ""都市"": ""ロンドン"",
  ""ICAO"": ""EGLL"",
  ""緯度"": ""51.4775"", ""経度"": ""-0.461389""
 }

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

添付書類 (画像／ファイル)

ユーザーは、最大25MBのファイル、画像、またはメールを添付することができます。ボットは、入力した添付書類の説明を文字列として返します。

""エンティティ"":
{
""添付書類エンティティ"": ""送信""
}

都市

「ニューヨークの気温は？」のような発言の中の都市名です。ボットは、文字列の形で5000人以上の人口を持つ任意の都市名をキャプチャします。都市の詳細については、www.geonames.orgを使用しています。

""エンティティ"":
{
""都市エンティティ"": ""ニューヨーク""
}

国

「アメリカ合衆国の首都はどこですか」などのユーザーの発言から、国の名前をキャプチャします。

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

""国エンティティ"": {
   ""アルファ3"": ""USA""、
   ""アルファ2"": ""US""、
   ""現地名"": ""アメリカ合衆国""、
   ""略称"": ""合衆国""、
   ""数字コード"": 840
}

国のリストについては、こちらを参照してくださいhttps://www.nationsonline.org/oneworld/country_code_list.htm。

会社名または組織名

「Amazon の最寄りの支店」のようなユーザーの発言から会社名をキャプチャします。会社名の値は文字列として返されます (Amazon) 。サポート対象企業 のリストを参照してください。

サポート対象企業とは別に、ボットは、大文字で始まり、以下のような接尾辞が続く単語を会社の種類として認識します。 Inc、Incorporated、Corp、 Corporation、Group、Ltd、Limited、CoCompany、LP、LLP、LLLP、 LLC、PLLC。

 ""エンティティ"":
{
""組織エンティティ"": ""アマゾン""
}

色

たとえば、「ステータスを緑に設定する」など、ユーザーの発言から色の名前をキャプチャして「緑」という色の値を文字列で返します。サポートされている色 の一覧を参照してください。

""エンティティ"":
{
""色エンティティ"": ""緑""
}

通貨

ユーザーの発言から通貨の金額と種類をキャプチャします。たとえば、「このハンドバッグの価格は 200 ドルです」 – この例では、200 は金額、USD は通貨です。

このエンティティタイプは以下を認識します。

• 全通貨名 (ドル、ルピー、インドルピー、ディナール) 、
• 通貨記号 ($, S$, £) 、
• 標準通貨の略称 (INR、USD) 、および
• 通貨の俗称 (バック、ニッケル、ダイム、クイド、ルーニー、トニー、ベンジャミン、ジャクソン、ハミルトン) 。

""通貨エンティティ"":[
{
""コード"": ""SGD""、
""金額"": 20
}

カスタム

表示されるRegexフィールドにおいて、ユーザーの入力を検証するための正規表現を定義します。

発言から、メールアドレスをキャプチャします。たとえば、[a-zA-Z]{3}[-]\d{4} と入力すると、
サンプルレスポンスは、{""regex"":""NLP-1234""}として返されます。

詳細については、正規表現を参照してください。

複合

複合エンティティを使用して、1つのエンティティに複数のエンティティ値を取り込むことができます。

たとえば、自動車販売への営業問い合わせについて考えてみましょう。通常の問い合わせの形式には、次のようなものがあります。「Tesla Model S 2018年モデルに興味があります」、「赤いTesla2010年モデルの費用はどのくらいですか」、または「Tesla Model Sについて教えてください」といったものです。

このようにボットは通常、メーカー、モデル、年式、色などの詳細項目を組み合わせて処理する必要があります。

これらのシナリオは、複合エンティティタイプによって処理されます。
複合エンティティタイプの詳細については、こちらを参照してください。

日付

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

日時

""エンティティ"" ：
{
""日付エンティティ"" ： ""2017-10-10T18:00+05:30""
}

期間の日付

説明

""エンティティ""：
{
""説明"" ：""ここにテキストが入ります""
}

メールアドレス

""エンティティ""：
{
""メールアドレス""：""help@koremessenger.com""
 }

項目のリスト (ルックアップ)

言語によっては、機能が完全にサポートされていない場合があります。詳細はこちらを参照してください。

静的リストまたはリモートリストのいずれかを定義することができます。

静的リスト

静的リストを使用して、エンティティ値を以下のリストタイプのいずれかとして定義します。

• JSON タブ − キー/値のペアと同義語のリストを入力します。 (詳細はこちらを参照してください) 、例) ：

  [{
  ""タイトル""：""合衆国""、
  ""値"": ""US""、
  ""同義語"": [""合衆国""、""USA""、""US""、""U.S.A""、""アメリカ""]
  }、
  {
  ""タイトル"": ""ジョン F ケネディ国際空港""、
  ""値"": ""JFK""、
  ""同義語"": [""ジョン F ケネディ国際空港""、""ニューヨーク国際空港""、""JFK""
  }
  ]

• エディタタブ − キーの表示名、キーの値、およびオプションでキーの同義語を入力します。
• ファイルのアップロード – クリックして、JSON 形式のファイルリスト、または .csv ファイル形式のキー/値のペアのリストに移動し、選択します。
  

投稿 ver7.1 では、下記のような使い方ができるよう、コンテキストオブジェクトに以下のキーが追加されています。

• ambiguousEntityValues： このキーには、マルチアイテムのエンティティに対するユーザー入力があいまいな場合に値が格納されます。これを使用すると、あいまいな値が識別されたかどうかを確認し、あいまいさを解消するためのフローを構築することができます。このキーは、ダイアログ中にエンティティが再プロンプトされるとリセットされます。値はJSONオブジェクトの配列形式となり、各オブジェクトにはタイトル、値、同義語が含まれます。
• synonymsUsed： このキーはアイテムを識別するために使用される同義語を保持します。必要に応じてボットの応答をパーソナライズするためにこの値を使用することができます。このキーはダイアログ中にエンティティが再プロンプトされるとリセットされます。

リストをユーザーに表示するには、値の表示リストをはいに設定する必要があります。これは、チャネル固有のフォーマットでユーザーに値のリストを表示します。 また、要件に応じてテンプレートを使用することができます。 (詳細については、こちらを参照してください) 。

List of items (lookup)

Display a list of values to the end-user. To define the lookup list,

1. Click the Settings icon next to the List of items (lookup) Type field.
2. On the List of items (lookup) Setup page, define one of the following list types.
   • Static List
   • Remote List

This feature is not fully supported in all languages. Click here for details.

Static List: Use Static List to define the entity values as one of the following list types:

• JSON tab – Enter a list of key/value pairs and synonyms (Click here for more). For example:

  [{
  "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"]
  }
  ]

• Editor tab – Enter the Display Name, Value, and Synonyms for the key.
• Upload File – Click Upload File to locate a JSON formatted file list or a .csv file formatted list of key/value pairs. For example,
  

Post v7.1, the following keys are added to the context object for the below-mentioned usage:

• ambiguousEntityValues: This key contains values when the user input for a multi-item entity is ambiguous. Using this, you can check if any ambiguous values were identified and construct the flow to resolve the ambiguity. This key is reset if the entity is re-prompted during the dialog. The values are an array of JSON objects, each object containing title, value, and synonym.
• synonymsUsed: This key holds the synonym used to identify the item. You can use this value to personalize the bot response accordingly if needed. This key is reset if the entity is re-prompted during the dialog.

For the list to be presented to the user, you need to set the Display List of Values to Yes. This presents the list of values to the user in the channel-specific format, you want to use a template as per your requirement (Click here for more).

リモートリスト

リモートリストは、セキュリティ上の制約などで外部サービスによるエンティティ抽出が必要な場合に利用できます。また、大容量のデータを扱う場合にも利用できます。

ステップには以下のようなものがあります。

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

      ""データ入力"": {
       ""input"": [
        ""アカウントの取得""
       ],
       ""使用済み"": [
        ""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 レスポンスとして返します。

""場所"":
{
""書式化された住所"": ”Las Vegas, NV, USA""、
""lat"": 36.1699412,
""lng"": -115.1398296
}

数字

ユーザーの発言から数字をキャプチャします。たとえば、「16人分の部屋を予約する」では、16という数字が値として返されます。

ボットプラットフォームは、スペルアウトされた数字だけでなく、1M などの標準的な略語も認識します。連続した数字の単語は1つの数字に結合されます。たとえば、ワン、トゥー、スリーは123 になります。

""エンティティ"":
{
""数字エンティティ"": 16
}

人物名

ユーザーの発言から人物のフルネームをキャプチャします。

たとえば、「John Smithにメールを送る」では、John Smithが人名として識別されます。

Kore.aiボットプラットフォームは、ユーザーの発言の最初の単語が大文字の場合はファーストネームとし、次の２つの単語がキャメルケースの場合は名前の一部であるとみなします。

たとえば、ユーザーの発言が「John Smithと話したい」である場合、John Smithを名前として認識します。発言が「John smithとすぐに話したい」であれば、Johnだけを名前として認識します。

""エンティティ"":
{
""人物名"": ""John Smith""
}

パーセンテージ

ユーザーの発言からパーセンテージ値をキャプチャします。

たとえば、「今日の降水確率は 60% 以上」であれば、60 はパーセンテージで、 (0.0-1.0) の範囲で 0.6 のフロート値として返されます。パーセント、パーセンテージ、%記号をサポートしています。

""エンティティ"":
{
""パーセンテージエンティティ"": 0.6
}

電話番号

標準の10桁または12桁の電話番号をキャプチャします。

たとえば、「4075551212にお電話ください」では、電話番号の値は4075551212となり、番号として返されます。

""エンティティ"":
{
""電話番号"": ""+4075551212""
}

数量

以下のような詳細を内容とするユーザー発言から、数量をキャプチャします。

• 数量の種類 (長さ、面積、体積など) 。
• 測定単位 (キロメートル、平方キロメートル、立法メートルなど) 。
• 量 (100、500、1.5など) 。

数量エンティティタイプを選択すると、数量の単位タイプとデフォルトの測定単位も選択する必要があります。

たとえば、体積をキャプチャするには、ユニティタイプに体積、デフォルト単位にミリリットルを選択します。そのため、ユーザーの発言が「水を500ml追加する」の場合、次のような JSON が返されます。

""数量"":
{
""単位"": ""ミリリットル"",
""量"": 500,
""タイプ"": ""体積"",
""ソース"": ""500 ml""
}

ボットのプラットフォームは、これらのすべての量を識別し、標準的な略語、コード、および記号に結合します。

文字列

説明エンティティタイプと同じように動作しますが、一文に制限されています。

文字列エンティティについては、訓練されていない限り、ユーザーの発言に対して検証が行われることはありません。したがって、このエンティティタイプは、プラットフォームでサポートされているエンティティタイプで要件が満たされない場合の最後の手段として使用されるべきです。

時間

ユーザーの発言内の時間をキャプチャします。
たとえば、「午前6時にアラームを設定する」は、ISO 8601の時刻フォーマットの時間値を hh:mm:ss.sZD として返します。
以下のような表記を認識します。

• • am、a.m.、AM、pm、p.m.、PM、P.M.
  • 数字が綴られている場合。例) Six AM
  • 朝と夕方。例) 夕方の6時

""エンティティ"":
{
""時間エンティティ"": ""T06:00:00+05:30""
}

タイムゾーン

タイムゾーン。「東部標準時」はタイムゾーンを GMT に変換し、その結果を保存します。
たとえば、ESTと入力すると、-6:00として保存されます。
Bots Platformは標準のタイムゾーンを認識します。

""エンティティ"":
{
""タイムゾーンエンティティ"": ""-06:00""
}

URL

発言から Web URL をキャプチャします。ボットは URL のすべての標準フォーマットを認識します。
たとえば、「Visit our website: www.kore.ai」のようになります。URLの値は文字列として返されます。

""エンティティ"":
{
""URLエンティティ"": ""www.kore.ai""
}

郵便番号

ユーザーの発言から米国の郵便番号をキャプチャします。たとえば、””32746の天気は？””などです。”” 郵便番号の値は32746で、文字列として返されます。

""エンティティ"":
{
""郵便番号エンティティ"": ""32746""
}