엔티티 유형은 인식 및 시스템 성능을 향상하기 위해 사용자 발화에서 예상되는 데이터 유형을 NLP 인터프리터에 제공합니다. Kore.ai NLP 인터프리터는 사용자 발화에서 엔티티를 추출합니다. 사용자가 필수 엔티티를 입력하지 않은 경우 사용자에게 엔티티 입력을 요청하는 봇 응답 노드를 정의할 수 있습니다. 자세한 내용은 봇 응답 노드로 작업하기를 참조하세요. 사용자 입력의 유효성을 검사하는 엔티티 규칙을 정의할 수도 있습니다. 자세한 내용은 여기를 참조하세요. 엔티티 노드에 대해 다음 엔티티 유형이 지정됩니다.
| 주소 | 복합 | 사람 이름 |
| 공항 | 날짜 | 백분율 |
| 첨부 | 날짜 기간 | 전화번호 |
| 이메일 | 날짜 시간 | 수량 |
| 도시 | 설명 | 문자열 |
| 국가 | 항목 목록(열거됨) | 시간 |
| 회사 | 항목 목록(조회) | 시간대 |
| 색상 | 위치 | URL |
| 사용자 정의 | 숫자 | 우편번호 |
| 통화 |
표준 미국 및 독일 주소 형식으로 작성된 주소를 캡처합니다. 예: 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"
}
}
모든 필드를 모든 시나리오에서 사용할 수 있는 것은 아니며 국가를 기반으로 하는 주소 유형에 따라 다릅니다.
다음 입력으로 공항 세부 정보를 캡처합니다.
공항 세부 정보는 아래에 표시된 요소와 함께 JSON 엔티티로 반환됩니다.
"AirportEntity":
{"IATA": "LHR",
"AirportName": "London Heathrow Airport",
"City": "London",
"ICAO": "EGLL",
"Latitude": "51.4775", "Longitude": "-0.461389"
}
모든 공항 세부 정보는 https://github.com/opentraveldata/opentraveldata를 사용합니다.
| 입력 | 설명 | 예 |
|---|---|---|
| 도시 이름 | 사용자 발화에서 도시 이름으로부터 공항 이름을 식별합니다. 도시에 여러 개의 공항이 있는 경우 선택할 수 있는 공항 목록이 표시됩니다. | 발화: 로스엔젤레스로 비행 응답: 입력한 공항이 모호한 것 같습니다. 선택하려는 옵션을 알려주세요. <로스앤젤레스에 있는 5개 공항의 이름> |
| 공항 이름 | 눈에 띄는 키워드로 전체 공항 이름 또는 부분 이름에서 공항 이름을 식별합니다. | 발화: 히드로로 비행 캡처됨: 봇에 필요한 세부 정보가 있는 런던 히드로 공항입니다. |
| IATA | 국제 항공 운송 협회(IATA) 코드로 공항 이름을 식별합니다. | 발화: LHR으로 비행 캡처됨: 런던 히드로 공항의 세부 정보 |
| ICAO | 국제 민간 항공 기구(ICAO) 코드를 식별합니다. | 발화: EGLL으로 비행 캡처됨: 런던 히드로 공항의 세부 정보 |
| 도시의 약어 | www.geonames.org에 나열된 도시 약어를 식별합니다 | 발화: LA로 비행 응답: 입력한 공항이 모호한 것 같습니다. 선택하려는 옵션을 알려주세요. <LA에 있는 5개 공항의 이름> |
사용자는 최대 25MB의 파일, 이미지 또는 이메일을 첨부할 수 있습니다.
"entities":
{
"AttachmentEntity": "send"
}
참고: 현재 첨부 엔티티는 Facebook, Twitter, Web/Mobile 및 Slack 채널에서만 지원됩니다.
뉴옥의 온도는 몇 도입니까와 같은 발화에서 도시 이름입니다. 봇은 문자열 형태로 인구 5,000명이 넘는 모든 도시 이름을 캡처합니다. 모든 도시 세부 정보는 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.
| 요소 | 설명 | 예 |
|---|---|---|
| alpha3 | 국가의 세 자리 코드 | USA, GBR 또는 IND |
| alpha2 | 국가의 두 자리 코드 | US, GB 또는 IN |
| localName | 국가 이름 | 미국, 영국 또는 인도 |
| shortName | 짧은 이름 | 미국, 영국 또는 인도 |
| numericalCode | 국제 연합, 국가에 사용된 숫자 코드 M49 | 840, 826 또는 356 |
Amazon의 가장 가까운 지점과 같은 사용자 발화에서 회사 이름을 캡처합니다. 회사 이름 값이 문자열로 반환됩니다(Amazon). 지원되는 회사 목록을 참조하세요. 회사 이름 말뭉치에는 언어별 이름이 포함됩니다. 주식 이름, 등록 이름 등과 같은 회사 이름의 변형은 모두 공통 이름에 매핑됩니다. 예: Amazon, Amazon.com, Amazon Inc는 따라서 모두 단일 회사로 인식됩니다. 지원되는 회사와는 별개로 봇은 항상 대문자로 시작하며 그 다음에 회사 유형으로 접미사가 나옵니다. Inc, Incorporated, Corp, Corporation, Group, Ltd, Limited, Co, Company, LP, LLP, LLLP, LLC, PLLC.
"entities":
{
"OrganizationEntity": "amazon"
}
사용자 발화에서 색상 이름을 캡처합니다. 예: 상태를 녹색으로 설정합니다. 색상의 값을 문자열 Green으로 반환합니다. 지원되는 색상 목록을 참조하세요.
"entities":
{
"ColorEntity": "green"
}
사용자 발화에서 금액과 통화 유형을 캡처합니다. 예: 이 핸드백의 가격은 200달러입니다. 200은 금액이고 USD는 통화입니다. 이 엔티티 유형은 다음을 인식합니다.
"CurrencyEntity":[
{
"code": "SGD",
"amount": 20
}
정규식을 정의하여 표시된 정규식 필드에서 사용자 입력을 검증합니다. 예: 다음을 입력: [a-zA-Z]{3}[-]\d{4}반환된 샘플 응답: {"regex":"NLP-1234"} 자세한 내용은 장규식을 참조하세요.
복합 엔티티는 하나의 엔티티에서 여러 엔티티 값을 캡처하는 데 사용됩니다. 예: 자동차 판매에 대한 판매 문의를 고려해 보세요. 문의는 일반적으로 다음과 같은 형식일 수 있습니다. 테슬라 모델 S 2018 모델에 관심이 있습니다 또는 빨간색 테슬라 2010 모델 가격은 얼마입니까 또는 테슬라 모델 S에 대해 알려주세요. 보시다시피 봇은 이러한 문의에 응답하려면 제조사, 모델, 연도, 색상과 같은 세부 정보의 조합을 처리해야 합니다. 이러한 시나리오는 복합 엔티티 유형으로 처리됩니다. 복합 엔티티 유형을 자세히 알아보려면 여기를 참조하세요.
사용자 발화에서 날짜 언급을 캡처합니다. 예: 10월 10일 항공편 예약하기 날짜를 ISO8601 날짜 형식인 YYYY-MM-DD로 반환합니다. 봇은 다음과 같이 날짜를 표현하는 모든 가능한 방법과 형식을 인식합니다.
"entities":
{
"DateEntity": "1982-04-13"
}
사용자 발화에서 시간과 함께 날짜 그룹을 캡처합니다. 예: 10월 10일 오후 6시에 항공편 예약하기 날짜 시간 값을 ISO8601 날짜 형식인 YYYYY-MM-DDThh: mm: ss.sTZD로 반환합니다. 봇은 날짜와 시간을 표현하는 모든 방법과 형식을 인식합니다.
"entities":
{
"DateEntity": "2017-10-10T18:00:00+05:30"
}
사용자 입력에서 시작일과 종료일을 캡처합니다. 예: 5월 5일부터 5일 동안 호텔을 예약합니다. 사용자 입력에 날짜 중 하나 또는 둘 다 포함되지 않은 경우 봇은 사용자에게 필요한 입력을 요청하는 메시지를 표시합니다.
참고: 다른 엔티티와 달리 날짜 기간 엔티티를 사용하면 사용자 및 오류 프롬프트의 두 세트를 입력할 수 있습니다.
다음 표에는 여러 시나리오에서 엔티티가 작동하는 방법을 나열합니다.
| 입력 유형 | 봇 반응 |
|---|---|
| 시작 날짜와 종료 날짜를 모두 포함하지 않았습니다[예: 호텔 예약]. | 시작 날짜에 대한 사용자 프롬프트를 사용자에게 표시합니다 |
| 시작 날짜 또는 종료 날짜 중 하나를 포함합니다[예: 8월 15일 호텔 예약] | 입력에 누락된 종류에 따라 사용 날짜에 대한 사용자 프롬프트 또는 종료 날짜에게 대한 사용자 프롬프트를 표시합니다 |
| 시작 날짜 및 기간에 대한 암시적 참조를 포함합니다[예: 화요일부터 5일간 호텔 예약] | 두 날짜를 결정합니다 |
| 시작 날짜와 기간을 포함합니다[예: 11월 15일부터 5일간 호텔 예약] | 두 날짜를 결정합니다 |
| 시작 날짜 및 종료 날짜를 포함합니다[예: 5일부터 10일까지 호텔 예약] | 두 날짜를 결정합니다 |
사용자 발화에서 문장 또는 텍스트 단락을 캡처합니다. 설명의 값은 문자열로 반환되며 와일드 문자를 포함할 수 있습니다.
"entities":
{
"Description": "text here"
}
발화에서 이메일 주소를 캡처합니다. 예: “help@koremessenger.com로 이메일 보내기” 이메일의 값을 문자열로 반환합니다.
"entities":
{
"Email": "help@koremessenger.com"
}
최종 사용자에게 값 목록을 표시합니다. 목록 유형을 정의하려면,
이 기능은 일부 언어에서는 완전히 지원되지 않습니다. 자세한 내용은 여기를 클릭하세요.
context.를 입력하고 컨텍스트 개체 유형을 선택합니다.v7.1 이후로는 다음과 같은 키가 아래 사용법에 따른 용도로 컨텍스트 개체에 추가됩니다.
목록을 사용자에게 표시하려면 값 표시 목록을 예로 설정합니다. 그러면 채널별 형식으로 값 목록을 사용자에게 표시합니다. 요구 사항에 따라 템플릿을 사용할 수 있습니다(자세히 확인하려면 여기를 클릭하세요).
최종 사용자에게 값 목록을 표시합니다. 조회 목록을 정의하려면,
이 기능은 일부 언어에서는 완전히 지원되지 않습니다. 자세한 내용을 확인하려면 여기를 클릭하세요. 정적 목록: 정적 목록을 사용하여 엔티티 값을 다음 목록 유형 중 하나로 정의합니다.
[{
"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"]
}
]
v7.1 이후로는 다음과 같은 키가 아래 사용법에 따른 용도로 컨텍스트 개체에 추가됩니다.
목록을 사용자에게 표시하려면 값 표시 목록을 예로 설정합니다. 그러면 채널별 형식으로 값 목록을 사용자에게 표시합니다. 요구 사항에 따라 템플릿을 사용할 수 있습니다(자세히 확인하려면 여기를 클릭하세요).
원격 목록은 보안 제한이나 다른 이유로 외부 서비스로 엔티티 추출을 수행해야 할 때 사용됩니다. 또한 대용량 데이터를 처리하는 데도 사용할 수 있습니다. 관련된 단계는 다음과 같습니다.
context.inputData 개체는 이 용도로 사용됩니다.
"inputData": {
"input": [
"get account"
],
"usedUp": [
"0-x-x"
],
"isMultiItem": false
}
{{context.entities.<entity-name>.title}}를 사용하여 액세스할 수 있습니다.{{context.entities.<entity-name>.value}}를 사용하여 액세스할 수 있습니다.{{context.entities.<entity-name>.synonym}}를 사용하여 액세스할 수 있습니다.
흐름: 플랫폼은 다음을 수행합니다.
context.inputData를 위에 언급된 값으로 채웁니다.사용자 발화에서 시/도의 세부 정보를 캡처합니다. 예: 라스베이거스의 벨라지오에서 엔티티는 라스베이거스의 위치 세부 정보를 캡처합니다. 엔티티는 주소 및 좌표와 함께 개체의 위치를 JSON 응답으로 반환합니다.
"Location":
{
"formatted_address": "Las Vegas, NV, USA",
"lat": 36.1699412,
"lng": -115.1398296
}
사용자 발화에서 숫자를 캡처합니다. 예: 16명을 위한 방을 예약합니다. 이 예에서는 값 16이 숫자로 반환됩니다. 봇 플랫폼은 철자로 표기된 숫자와 1M과 같은 표준 약어를 인식합니다. 연속된 수의 단어는 하나의 숫자로 결합됩니다. 예: 1 2 3은 123이 됩니다. 참고: 허용되는 최대 자릿수는 18입니다.
"entities":
{
"NumberEntity": 16
}
사용자 발화에서 사람의 전체 이름을 캡처합니다. 예: John Smith에게 이메일 전송. John Smith는 사람 이름으로 식별됩니다. Kore.ai 봇 플랫폼은 사용자 발화에서 대문자로 된 첫 번째 단어를 이름으로 가정하고 낙타 대문자에서 다음 두 단어를 이름의 일부로 가정합니다. 예: 사용자 발화가 John Smith와 통화하고 싶습니다. John Smith는 이름으로 인식합니다. 사용자 발화가 John smith와 바로 통화하고 싶습니다.인 경우 John만 이름으로 인식합니다.
"entities":
{
"PersonName": "John Smith"
}
사용자 발화에서 백분율 값을 캡처합니다. 예: 오늘의 비 올 확률은 60% 이상입니다. 백분율은 60이며, 0.0~1.0 범위에서 부동 소수점 값 0.6을 반환합니다. 퍼센트, 백분율 및 % 기호를 지원합니다.
"entities":
{
"PercentageEntity": 0.6
}
표준 10자리 또는 12자리 전화번호를 캡처합니다. 예: 4075551212로 전화하십시오. 전화번호 값은 4075551212이며 숫자로 반환됩니다.
"entities":
{
"PhoneNumber": "+4075551212"
}
사용자 발화에서 다음 세부 정보를 사용하여 발화에서 수량을 캡처합니다.
수량 엔티티 유형을 선택할 때 수량 및 기본 측정의 단위 유형도 선택해야 합니다. 예: 부피를 캡처하려면 부피를 단위 유형으로 선택하고 밀리미터를 기본 단위로 선택합니다. 따라서 사용자 발화가 물 500ml 추가이면 다음 JSON이 반환됩니다.
"Quantity":
{
"unit": "millilitre",
"amount": 500,
"type": "volume",
"source": "500 ml"
}
봇 플랫폼은 이러한 모든 수량을 식별하고 표준 약어, 코드, 기호와 함께 결합합니다.
| 유형 | 단위 |
|---|---|
| 길이 |
|
| 면적 |
|
| 부피 |
|
| 시간 |
|
| 속도 |
|
| 압력 |
|
| 에너지 |
|
| 메모리 |
|
| 무게 |
|
| 각도 |
|
| 나이 |
|
| 온도 |
|
설명 엔티티 유형과 동일하게 작동하지만 한 문장으로 제한됩니다. 문자열 엔티티의 사용자 발화가 학습되지 않은 경우 유효성 검사는 수행되지 않습니다. 따라서 이 엔티티 유형은 요구 사항이 플랫폼 지원 엔티티 유형 중 어느 것과도 충족되지 않을 때 마지막 수단으로 사용됩니다.
사용자 발화에서 시간을 캡처합니다. 예: 알람을 오전 6시로 설정하고, 시간 값을 ISO 8601 시간 형식인 hh:mm:ss.sZD로 반환합니다. 다음 표시를 인식합니다.
"entities":
{
"TimeEntity": "T06:00:00+05:30"
}
시간대입니다. 동부 표준시는 시간대를 GMT로 변환하고 결과 값을 저장합니다. 예: EST를 입력하면 -6:00으로 저장됩니다. 봇 플랫폼은 표준 시간대를 인식합니다.
"entities":
{
"TimeZoneEntity": "-06:00"
}
발화에서 웹 URL을 캡처합니다. 봇은 모든 표준 형식의 URL을 인식합니다. 예: 당사 웹 사이트(www.kore.ai)를 방문하세요. URL 값이 문자열로 반환됩니다.
"entities":
{
"URLEntity": "www.kore.ai"
}
사용자 발화에서 미국 우편번호를 캡처합니다. 예: 32746의 날씨는 어떤가요? 우편번호의 값은 32746이며 문자열로 반환됩니다.
"entities":
{
"ZipcodeEntity": "32746"
}
エンティティタイプは、ユーザーの発話から想定されるデータのタイプをNLPインタプリターに提供し、認識およびシステムパフォーマンスを向上させます。Kore.aiのNLPインタプリターは、ユーザーの発話からエンティティを抽出します。ユーザーが必須のエンティティを入力しなかった場合、ボットレスポンスノードを定義して、ユーザーにエンティティの入力を指示することができます。詳細情報は、ボットレスポンスノードの操作をご参照ください。また、ユーザーの入力を検証するためのエンティティルールを定義することもできます。詳細はこちらをご参照ください。エンティティノードには、以下のエンドユーザータイプが指定されます。
| アドレス | コンポジット | 個人名 |
| 空港 | 日付 | パーセンテージ |
| 添付ファイル | 日付期間 | 電話番号 |
| メール | 日時 | 数量 |
| 都市名 | 説明 | 文字列 |
| 国名 | アイテムのリスト（列挙型） | 時間 |
| 会社名 | アイテムのリスト（ルックアップ） | タイム ゾーン |
| 色 | 場所 | URL |
| カスタム | 数字 | 郵便番号 |
| 通貨 |
アメリカとドイツの標準的な住所形式で書かれた住所をキャプチャします。例：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"
}
}
なお、すべてのシナリオですべてのフィールドが利用できるというわけではなく、国によって住所のタイプが異なります。
以下の入力で空港の詳細をキャプチャします。
空港の詳細は、以下の要素を持つJSONエンティティとして返されます。
"AirportEntity":
{"IATA": "LHR",
"AirportName": "London Heathrow Airport",
"City": "London",
"ICAO": "EGLL",
"Latitude": "51.4775", "Longitude": "-0.461389"
}
すべての空港の詳細については、 https://github.com/opentraveldata/opentraveldata を使用しています。
| 入力 | 説明 | サンプル |
|---|---|---|
| 都市名 | ユーザーの発話に含まれる都市名から、空港名を特定します。都市に複数の空港がある場合は、選択できる空港のリストを表示します。 | 発話：ロスアンゼルスへのフライト応答入力した空港が明確でないようです。選択したいオプションを教えてください。<ロサンゼルスにある5つの空港の名前＞。 |
| 空港名 | 完全な空港名、または著名なキーワードを含む部分的な空港名から、空港名を特定します。 | 発話：キャプチャされたヒースローへのフライト：ロンドン・ヒースロー空港では、必要な情報をボットに記載しています。 |
| IATA | 国際航空運送協会（IATA）のコードで空港名を特定します。 | 発話：キャプチャされたLHRへのフライト：ロンドン・ヒースロー空港の詳細 |
| ICAO | 国際民間航空機関（ICAO）のコードを識別します。 | 発話：キャプチャされたEGLLへのフライト：ロンドン・ヒースロー空港の詳細 |
| 都市の略語 | www.geonames.org に掲載されている都市の略語を特定します。 | 発話：LAへのフライト応答：入力した空港が不明瞭なようです。選択したいオプションを教えてください。<LAにある5つの空港の名前> |
ユーザーは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
| 要素 | 説明 | サンプル |
|---|---|---|
| alpha3 | 3文字の国名コード | USA、GBR、あるいはIND |
| alpha2 | 2文字の国名コード | US、GB、あるいはIN |
| localName | 国名 | アメリカ合衆国、英国、あるいはインド |
| shortName | 省略語 | 合衆国、英国、あるいはインド |
| numericalCode | 国連では、国名に数値コードM49を使用 | 840、826、あるいは356 |
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は金額で、米ドルは通貨です。このエンティティタイプは、以下を認識します。
"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です。ボットは、以下のように、日付の可能性のあるあらゆる方法と形式を認識します。
"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日間ホテルを予約する。ユーザー入力に日付の一方または両方が含まれていない場合、ボットはユーザーに必要な入力提示を指示します。
メモ：他のエンティティと異なり、日付期間のエンティティでは、ユーザープロンプトとエラープロンプトの2セットを入力できます。
次のテーブルは、さまざまなシナリオでエンティティがどのように機能するかをリストアップしています。
| 入力タイプ | ボットの動作 |
|---|---|
| 開始日と終了日の両方は含まれません［例：ホテルの予約］。 | 開始日のユーザープロンプト をユーザーに表示します |
| 開始日または終了日のいずれかを含めます（例：8月15日からホテルを予約）。 | 入力されていない日付に基づいて、 開始日のユーザープロンプト または 終了日のユーザープロンプト を表示します。 |
| 開始日と期間の黙示的な参照を含めます（例：火曜日から5日間のホテル予約］ | 両方の日付を決定 |
| 開始日と期間を含めます（例：11月15日から5日間、ホテルを予約する］ | 両方の日付を決定 |
| 開始日と終了日を含めます [例：5日から10日までホテルを予約]。 | 両方の日付を決定 |
ユーザーの発話からテキストの文やパラグラフをキャプチャします。説明の値は文字列として返され、ワイルド文字を含めることができます。
"entities":
{
"Description": "text here"
}
発話からメールアドレスをキャプチャします。例として、「メールを help@koremessenger.comに送信する」 は、メールの値を文字列として返します。
"entities":
{
"Email": "help@koremessenger.com"
}
値のリストをエンドユーザーに表示します。リストタイプを定義するには、
この機能はすべての言語で完全にサポートされているわけではありません。詳細はこちらをクリックしてください。
context.を入力して、コンテキストオブジェクトのタイプを選択します。v7.1以降では、以下のキーがコンテキストオブジェクトに追加され、以下のような使用方法になります。
ユーザーにリストを表示するには、値リストの表示を「はい」に設定する必要があります。これは、チャネル固有の形式でユーザーに値リストを提示しますが、要件に応じてテンプレートを使用したくなります（詳細はこちらをご覧ください）。
値リストをエンドユーザーに表示します。ルックアップリストを定義するには、
この機能は、すべての言語で完全にサポートされているわけではありません。詳細はこちらをクリックしてください。静的リスト：静的リストを使用して、エンティティの値を以下のリストタイプのいずれかとして定義します。
[{
"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"]
}
]
v7.1以降では、以下のキーがコンテキストオブジェクトに追加され、以下のような使用方法になります。
ユーザーにリストを表示するには、値リストの表示を「はい」に設定する必要があります。これは、チャネル固有の形式でユーザーに値リストを提示しますが、要件に応じてテンプレートを使用したくなります（詳細はこちらをご覧ください）。
リモートリストは、セキュリティ上の制限やその他の理由で、エンティティの抽出を外部のサービスで行う必要がある場合に使用します。また、大規模なデータを扱う場合にも使用できます。その手順は以下のとおりです。
context.inputDataオブジェクトは、その目的のために使用されます。
"inputData": {
"input": [
"get account"
],
"usedUp": [
"0-x-x"
],
"isMultiItem": false
}
{{context.entities.<entity-name>.title}}を使用してアクセスできます。{{context.entities.<entity-name>.value}}を使用してアクセスできます。{{context.entities.<entity-name>.synonym}}を使用してアクセスできます。 フロー：このプラットフォームは、
context.inputData に上記の値を入力します。ユーザーの発話から、都市や州の位置情報をキャプチャします。例として、ベラージオ、ラスベガスでは、エンティティはラスベガスの位置の詳細をキャプチャします。エンティティは、オブジェクトの位置情報を、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"
}
ユーザーの発話から、以下の詳細を含む発話の量をキャプチャします。
数量のエンティティタイプを選択する際には、数量の単位タイプとデフォルトの測定値も選択する必要があります。例として、体積をキャプチャする場合、 単位元のタイプに体積 、 デフォルトの単位にキロリットルを選択します。つまり、ユーザーの発話が「500mlの水を加える」の場合、次のようなJSONが返されます。
"Quantity":
{
"unit": "millilitre",
"amount": 500,
"type": "volume",
"source": "500 ml"
}
ボットプラットフォームは、これらの数量や単位を、標準的な略語やコード、記号で識別します。
| タイプ | 単位 |
|---|---|
| 長さ |
|
| 面積 |
|
| 体積 |
|
| 時間 |
|
| 速度 |
|
| 圧力 |
|
| エネルギー |
|
| メモリ |
|
| 重量 |
|
| 角度 |
|
| 期間 |
|
| 温度 |
|
説明エンティティタイプ と同じ作品ですが、一文に限定されています。トレーニングされていない限り、ユーザーの発話に対して文字列エンティティの検証を行うことはありません。したがって、このエンティティタイプは、プラットフォームでサポートされているどのエンティティタイプでも要件が満たされない場合の最終手段として使用されます。
ユーザーの発話で時間をキャプチャします。例として、「アラームを午前6時にセットする」の場合、時間の値はISO 8601時間形式でhh:mm:ss.sZDとして返されます。以下のような明示的意味が認識されています。
"entities":
{
"TimeZoneEntity": "-06:00"
}
あるタイムゾーン。東部標準時は、タイムゾーンをGMTに変換し、その結果の値を保存します。例として、ESTと入力すると、-6:00と保存されます。ボットプラットフォームは標準タイムゾーンを認識しています。
"entities":
{
"URLEntity": "www.kore.ai"
}
発話からWebのURLをキャプチャします。ボットは、あらゆる標準形式のURLを認識します。例として、「私たちのWebサイト： www.kore.ai 訪問してください。」URLの値を文字列で返します。
"entities": { "URLEntity": "www.kore.ai" }
ユーザーの発話から米国の郵便番号をキャプチャします。例：「32746の天気はどうですか？」郵便番号の値は32746で、文字列として返されます。
"entities": { "ZipcodeEntity": "32746" }
The Entity Type provides the NLP Interpreter with the expected type of data from a user utterance to enhance recognition and system performance. The Kore.ai NLP interpreter extracts the entity from the user utterance. If the user does not enter a required entity, you can define a Bot Response node to prompt the user to provide the entity. For more information, refer to Working with the Bot Response Node.
You can also define entity rules to validate user input, refer here for details.
The following Entity Types are specified for an entity node.
Captures addresses written in the standard US and Germany address formats. For example, 200 E Main ST Pheonix AZ 85123 USA. The complete address is captured as a string: “200 E Main ST Pheonix AZ 85123 USA.”
"entities":
{
"AddressEntity": "200 E Main ST Pheonix AZ 85123 USA"
}
For other country addresses, the platform captures strings that end with a recognizable city or country name. For more details, refer to the City entity.
Post v8.1, the full formatted address for the Address entity can be accessed from the context object. The context object would have the following format and the individual field values can be obtained:
"autoFormattedEntities": {
"Address": {
"streetNumber": "200"
"streetName": "E Main ST"
"streetType":
"POBox":
"roadPrefix":
"roadNumber":
"city": "Pheonix"
"county": "USA"
"zip": "AZ 85123"
}
}
Note that all the fields need not be available for all scenarios, it depends upon the address type based on the country.
Captures airport details with the following inputs:
Airport details are returned as a JSON entity with the elements shown below:
"AirportEntity":
{"IATA": "LHR",
"AirportName": "London Heathrow Airport",
"City": "London",
"ICAO": "EGLL",
"Latitude": "51.4775", "Longitude": "-0.461389"
}
We use https://github.com/opentraveldata/opentraveldata for all the airport details.
| Input | Description | Examples |
|---|---|---|
| City name |
Identifies the airport name from the city name in the user utterance. If the city has multiple airports, shows the list of airports to choose from. | Utterance: Flying to Los Angeles Response: The airport you entered seems to be ambiguous. Tell me the option you would like to choose. <Names of five airports in Los Angeles> |
| Airport name | Identifies the airport name from full airport name or partial name with the prominent keyword. | Utterance: Flying to Heathrow Captured: London Heathrow Airport with the necessary details in the bot. |
| IATA | Identifies airport names by the International Air Transport Association (IATA) codes. | Utterance: Flying to LHR Captured: Details of the London Heathrow Airport |
| ICAO | Identifies International Civil Aviation Organization (ICAO) codes. | Utterance: Flying to EGLL Captured: Details of the London Heathrow Airport |
| Abbreviations of cities | Identifies city abbreviations that are listed in www.geonames.org | Utterance: Flying to LA Response: The airport you entered seems to be ambiguous. Tell me the option you would like to choose. <Names of five airports in LA> |
The user can attach a file, image, or email up to 25 MB.
"entities":
{
"AttachmentEntity": "send"
}
Note: Currently, the attachment entity is supported only for the following channels – Facebook, Twitter, Web/Mobile, and Slack.
The name of a city in an utterance such as What is the temperature in New York. The bot captures any city name with over 5000 population in the form of a string. We use www.geonames.org for all the city details.
"entities":
{
"CityEntity": "New York"
}
Captures the name of a Country from user utterance such as What is the capital of the United States of America.
Country details are returned as a JSON entity with the elements shown below:
"CountryEntity": {
"alpha3": "USA",
"alpha2": "US",
"localName": "United States of America",
"shortName": "United States",
"numericalCode": 840
}
See here for a complete list of countries https://www.nationsonline.org/oneworld/country_code_list.htm.
| Element | Description | Examples |
|---|---|---|
| alpha3 | The three-letter code of the country | USA, GBR, or IND |
| alpha2 | The two-letter code for the country | US, GB, or IN |
| localName | Name of the country | United States of America, United Kingdom, or India |
| shortName | Short name | United States, United Kingdom, or India |
| numericalCode | United Nations, used numerical code M49 for countries | 840, 826, or 356 |
Captures the name of a company from user utterances such as the Nearest branch for Amazon. The value for Company Name is returned (Amazon) as a string. See Supported Companies list.
The company name corpus includes language-specific names. Variations of a company’s name like stock name, registered name, etc. are all mapped to a common name, thus ensuring that, for example, Amazon, Amazon.com, Amazon Inc are all recognized as a single company.
Apart from the supported companies, the bot recognizes the words starting with a capital letter and followed by these suffixes as a company type: Inc, Incorporated, Corp, Corporation, Group, Ltd, Limited, Co, Company, LP, LLP, LLLP, LLC, PLLC.
"entities":
{
"OrganizationEntity": "amazon"
}
Captures the name of the color from a user utterance. For example, Set the status to Green. Returns a value for the Color as Green as a string. See Supported Colors list.
"entities":
{
"ColorEntity": "green"
}
Captures the amount and type of currency from the user utterance. For example, This handbag is priced at 200 dollars where 200 is the amount and USD is the currency.
This entity type recognizes:
"CurrencyEntity":[
{
"code": "SGD",
"amount": 20
}
Define a regular expression to validate the user input in the Regex field displayed.
For example, enter: [a-zA-Z]{3}[-]\d{4}
to return a sample response as: {"regex":"NLP-1234"}
For more information, refer to Regex Expressions.
Composite entities are used to capture multiple entity values in one entity.
For example, consider the sales inquiries to car sales. Typical queries can be of the form: I am interested in the Tesla Model S 2018 model or What would a red Tesla 2010 model cost or Tell me about Tesla Model S.
As you can see, the bot typically needs to process a combination of details like Make, Model, Year, and Color to respond to those queries.
These scenarios are taken care of by the Composite Entity Type. Refer here to know more about Composite Entity Types.
Captures a date mention from a user utterance. For example, Book a flight on the 10th of October returns the value for Date in ISO8601 date format is YYYY-MM-DD.
The bot recognizes all possible ways and formats of dates, like:
"entities":
{
"DateEntity": "1982-04-13"
}
Captures a date grouping along with time in a user utterance.
For example, Book a flight on the 10 th of October at 6 pm, returns the value for Date Time in ISO8601 date format as YYYYY-MM-DDThh: mm: ss.sTZD.
The bot recognizes all possible ways and formats to express date and time.
"entities":
{
"DateEntity": "2017-10-10T18:00:00+05:30"
}
Captures start date and end date from the user input. For example, Book the hotel for five days starting May 5. If the user input does not include one or both of the dates, the bot prompts the user to provide the necessary input.
Note: Unlike other entities, Date Period entities allow you to enter two sets of user and errors prompts:
The following table lists how the entity works in different scenarios:
| Input Type | Bot Behaviour |
|---|---|
| Does not include both From and To dates [For example, Book hotel]. | Shows User Prompts for From Date to the user |
| Includes either From or To date [For example, Book a hotel from 15th Aug] | Shows User Prompts for From Date or User Prompts for To Date based on which is missing from the input |
| Includes implicit reference to From Date and duration [For example, Book a hotel for five days starting from Tuesday] | Determines both dates |
| Includes From Date and duration [For example, Book a hotel for five days from 15th Nov] | Determines both dates |
| Includes From Date and To Date [For example, Book a hotel from 5th to 10th] | Determines both dates |
Captures statements or paragraphs of text from the user utterance. The value for Description is returned as a string and can include wild characters.
"entities":
{
"Description": "text here"
}
Captures email address from the utterance. For example, “Send an email to help@koremessenger.com” returns the value of Email as a string.
"entities":
{
"Email": "help@koremessenger.com"
}
Display a list of values to the end-user. To define the list type,
This feature is not fully supported in all languages Click here for details.
context.; select a context object type.Post v7.1, the following keys are added to the context object for the below-mentioned usage:
.
Display a list of values to the end-user. To define the lookup 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:
[{
"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"]
}
]
Post v7.1, the following keys are added to the context object for the below-mentioned usage:
Remote List is used when the entity extraction needs to be done by an external service due to security restrictions or any other reasons. This can also be used to handle large data.
The steps involved are as follows:
context.inputData object with the following fields is used for that purpose:
"inputData": {
"input": [
"get account"
],
"usedUp": [
"0-x-x"
],
"isMultiItem": false
}
{{context.entities.<entity-name>.title}}.{{context.entities.<entity-name>.value}}.{{context.entities.<entity-name>.synonym}}.
Flow: The platform will:
context.inputData with the values mentioned above.Captures the location details of a city or state from a user utterance.
For example, in Bellagio, Las Vegas the entity captures the location details of Las Vegas. The entity returns the location of the object with address and coordinates as a JSON response.
"Location":
{
"formatted_address": "Las Vegas, NV, USA",
"lat": 36.1699412,
"lng": -115.1398296
}
Captures a number from a user utterance. For example, Book a room for 16 people. In this example, the value 16 is returned as the number.
The Bots platform recognizes the spelled-out numbers and also standard abbreviations such as 1M. A consecutive number of words are combined into one number. For example, one two three becomes 123.
Note: The maximum number of digits allowed is 18.
"entities":
{
"NumberEntity": 16
}
Captures the full name of a person from a user utterance.
For example, Send an email to John Smith, where John Smith is identified as Person Name.
Kore.ai Bot platform assumes that the first word in the user utterance with capital letters as the first name along and the next two words in camel case as a part of the name.
For example, if the user utterance is I want to talk to John Smith, it recognizes John Smith as the name. If the utterance is I want to talk to John smith immediately it recognizes only John as the name.
"entities":
{
"PersonName": "John Smith"
}
Captures the percentage value from a user utterance.
For example, The chance of rain today is more than 60 percent, where 60 is the percentage and is returned as a float value of 0.6 in a range of (0.0-1.0). It supports the percent, percentage, and the % sign.
"entities":
{
"PercentageEntity": 0.6
}
Captures standard 10-digit or 12-digit telephone numbers.
For example, Please call 4075551212, the value for the Phone Number is 4075551212 and is returned as a number.
"entities":
{
"PhoneNumber": "+4075551212"
}
Captures the quantity in an utterance with the following details from the user utterance:
When you select the Quantity entity type, you also need to select a unit type for the quantity and the default measure.
For example, for capturing volumes, select Volume as the Unity Type and Milliliters as the Default Unit. So, if a user utterance is Add 500 ml of water, the following JSON is returned:
"Quantity":
{
"unit": "millilitre",
"amount": 500,
"type": "volume",
"source": "500 ml"
}
Bots platform identifies all these quantities and unites along with the standard abbreviations, codes, and symbols.
| Type | Units |
|---|---|
| Length |
|
| Area |
|
| Volume |
|
| Time |
|
| Speed |
|
| Pressure |
|
| Energy |
|
| Memory |
|
| Weight |
|
| Angle |
|
| Age |
|
| Temperature |
|
Works identical to the Description entity type but limited to one sentence.
There won’t be any validations done on the user utterance for string entities unless trained. Hence this entity type is used as a last resort when your requirement is not met with any of the platform supported entity types.
Capture time in a user utterance. For example, Set my alarm for 6 am, return the value of Time in ISO 8601 time format as hh:mm:ss.sZD.
It recognizes the following denotations:
"entities":
{
"TimeEntity": "T06:00:00+05:30"
}
A time zone. Eastern Standard Time converts the timezone into GMT and stores the resulting value. For example, if you type EST, it is stored as -6:00. Bots platform recognizes the standard time zones.
"entities":
{
"TimeZoneEntity": "-06:00"
}
Captures a web URL from the utterance. The bot recognizes all standard formats of URLs. For example, Visit our website: www.kore.ai. The value for the URL is returned as a string.
"entities":
{
"URLEntity": "www.kore.ai"
}
Captures a US zip code from the user utterance. For example, What is the weather for 32746? The value for Zip Code is 32746 and is returned as a string.
"entities":
{
"ZipcodeEntity": "32746"
}