# Copyright 2018 Mycroft AI Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # import re import unittest from adapt.parser import Parser from adapt.entity_tagger import EntityTagger from adapt.intent import IntentBuilder, resolve_one_of, choose_1_from_each from adapt.tools.text.tokenizer import EnglishTokenizer from adapt.tools.text.trie import Trie __author__ = 'seanfitz' class IntentTest(unittest.TestCase): def setUp(self): self.trie = Trie() self.tokenizer = EnglishTokenizer() self.regex_entities = [] self.tagger = EntityTagger(self.trie, self.tokenizer, regex_entities=self.regex_entities) self.trie.insert("play", ("play", "PlayVerb")) self.trie.insert("stop", ("stop", "StopVerb")) self.trie.insert("the big bang theory", ("the big bang theory", "Television Show")) self.trie.insert("the big", ("the big", "Not a Thing")) self.trie.insert("barenaked ladies", ("barenaked ladies", "Radio Station")) self.trie.insert("show", ("show", "Command")) self.trie.insert("what", ("what", "Question")) self.parser = Parser(self.tokenizer, self.tagger) def tearDown(self): pass def test_basic_intent(self): intent = IntentBuilder("play television intent") \ .require("PlayVerb") \ .require("Television Show") \ .build() for result in self.parser.parse("play the big bang theory"): result_intent = intent.validate(result.get('tags'), result.get('confidence')) assert result_intent.get('confidence') > 0.0 assert result_intent.get('PlayVerb') == 'play' assert result_intent.get('Television Show') == "the big bang theory" def test_at_least_one(self): intent = IntentBuilder("play intent") \ .require("PlayVerb") \ .one_of("Television Show", "Radio Station") \ .build() for result in self.parser.parse("play the big bang theory"): result_intent = intent.validate(result.get('tags'), result.get('confidence')) assert result_intent.get('confidence') > 0.0 assert result_intent.get('PlayVerb') == 'play' assert result_intent.get('Television Show') == "the big bang theory" for result in self.parser.parse("play the barenaked ladies"): result_intent = intent.validate(result.get('tags'), result.get('confidence')) assert result_intent.get('confidence') > 0.0 assert result_intent.get('PlayVerb') == 'play' assert result_intent.get('Radio Station') == "barenaked ladies" def test_at_least_one_with_tag_in_multiple_slots(self): self.trie.insert("temperature", ("temperature", "temperature")) self.trie.insert("living room", ("living room", "living room")) self.trie.insert("what is", ("what is", "what is")) intent = IntentBuilder("test intent") \ .one_of("what is") \ .one_of("temperature", "living room") \ .one_of("temperature") \ .build() for result in self.parser.parse( "what is the temperature in the living room"): result_intent = intent.validate(result.get("tags"), result.get("confidence")) assert result_intent.get("confidence") > 0.0 assert result_intent.get("temperature") == "temperature" assert result_intent.get("living room") == "living room" assert result_intent.get("what is") == "what is" def test_at_least_on_no_required(self): intent = IntentBuilder("play intent") \ .one_of("Television Show", "Radio Station") \ .build() for result in self.parser.parse("play the big bang theory"): result_intent = intent.validate(result.get('tags'), result.get('confidence')) assert result_intent.get('confidence') > 0.0 assert result_intent.get('Television Show') == "the big bang theory" for result in self.parser.parse("play the barenaked ladies"): result_intent = intent.validate(result.get('tags'), result.get('confidence')) assert result_intent.get('confidence') > 0.0 assert result_intent.get('Radio Station') == "barenaked ladies" def test_at_least_one_alone(self): intent = IntentBuilder("OptionsForLunch") \ .one_of("Question", "Command") \ .build() for result in self.parser.parse("show"): result_intent = intent.validate(result.get('tags'), result.get('confidence')) assert result_intent.get('confidence') > 0.0 assert result_intent.get('Command') == "show" def test_basic_intent_with_alternate_names(self): intent = IntentBuilder("play television intent") \ .require("PlayVerb", "Play Verb") \ .require("Television Show", "series") \ .build() for result in self.parser.parse("play the big bang theory"): result_intent = intent.validate(result.get('tags'), result.get('confidence')) assert result_intent.get('confidence') > 0.0 assert result_intent.get('Play Verb') == 'play' assert result_intent.get('series') == "the big bang theory" def test_intent_with_regex_entity(self): self.trie = Trie() self.tagger = EntityTagger(self.trie, self.tokenizer, self.regex_entities) self.parser = Parser(self.tokenizer, self.tagger) self.trie.insert("theory", ("theory", "Concept")) regex = re.compile(r"the (?P.*)") self.regex_entities.append(regex) intent = IntentBuilder("mock intent") \ .require("Event") \ .require("Concept").build() for result in self.parser.parse("the big bang theory"): result_intent = intent.validate(result.get('tags'), result.get('confidence')) assert result_intent.get('confidence') > 0.0 assert result_intent.get('Event') == 'big bang' assert result_intent.get('Concept') == "theory" def test_intent_using_alias(self): self.trie.insert("big bang", ("the big bang theory", "Television Show")) intent = IntentBuilder("play television intent") \ .require("PlayVerb", "Play Verb") \ .require("Television Show", "series") \ .build() for result in self.parser.parse("play the big bang theory"): result_intent = intent.validate(result.get('tags'), result.get('confidence')) assert result_intent.get('confidence') > 0.0 assert result_intent.get('Play Verb') == 'play' assert result_intent.get('series') == "the big bang theory" def test_resolve_one_of(self): tags = [ { "confidence": 1.0, "end_token": 1, "entities": [ { "confidence": 1.0, "data": [ [ "what is", "skill_iot_controlINFORMATION_QUERY" ] ], "key": "what is", "match": "what is" } ], "from_context": False, "key": "what is", "match": "what is", "start_token": 0 }, { "end_token": 3, "entities": [ { "confidence": 1.0, "data": [ [ "temperature", "skill_weatherTemperature" ], [ "temperature", "skill_iot_controlTEMPERATURE" ] ], "key": "temperature", "match": "temperature" } ], "from_context": False, "key": "temperature", "match": "temperature", "start_token": 3 }, { "confidence": 1.0, "end_token": 7, "entities": [ { "confidence": 1.0, "data": [ [ "living room", "skill_iot_controlENTITY" ] ], "key": "living room", "match": "living room" } ], "from_context": False, "key": "living room", "match": "living room", "start_token": 6 } ] at_least_one = [ [ "skill_iot_controlINFORMATION_QUERY" ], [ "skill_iot_controlTEMPERATURE", "skill_iot_controlENTITY" ], [ "skill_iot_controlTEMPERATURE" ] ] result = { "skill_iot_controlENTITY": [ { "confidence": 1.0, "end_token": 7, "entities": [ { "confidence": 1.0, "data": [ [ "living room", "skill_iot_controlENTITY" ] ], "key": "living room", "match": "living room" } ], "from_context": False, "key": "living room", "match": "living room", "start_token": 6 } ], "skill_iot_controlINFORMATION_QUERY": [ { "confidence": 1.0, "end_token": 1, "entities": [ { "confidence": 1.0, "data": [ [ "what is", "skill_iot_controlINFORMATION_QUERY" ] ], "key": "what is", "match": "what is" } ], "from_context": False, "key": "what is", "match": "what is", "start_token": 0 } ], "skill_iot_controlTEMPERATURE": [ { "end_token": 3, "entities": [ { "confidence": 1.0, "data": [ [ "temperature", "skill_weatherTemperature" ], [ "temperature", "skill_iot_controlTEMPERATURE" ] ], "key": "temperature", "match": "temperature" } ], "from_context": False, "key": "temperature", "match": "temperature", "start_token": 3 } ] } assert resolve_one_of(tags, at_least_one) == result # noinspection PyPep8Naming def TestTag(tag_name, tag_value, tag_confidence=1.0, entity_confidence=1.0, match=None): """ Create a dict in the shape of a tag as yielded from parser. :param tag_name: tag name (equivalent to a label) :param tag_value: tag value (value being labeled) :param tag_confidence: confidence of parse of the tag, influenced by fuzzy matching or context :param entity_confidence: weight of the entity, influenced by context :param match: the text matched by the parser, which may not match tag_value in the case of an alias or fuzzy matching. Defaults to tag_value. Uses "from_context" attribute to force token positioning to be ignored. :return: a dict that matches the shape of a parser tag """ return { "confidence": tag_confidence, "entities": [ { "confidence": entity_confidence, "data": [ [ tag_value, tag_name ] ], "key": tag_value, "match": match or tag_value } ], "from_context": False, "key": tag_value, "match": match or tag_value, "start_token": -1, "end_token": -1, "from_context": True } class IntentUtilityFunctionsTest(unittest.TestCase): def test_choose_1_from_each_empty(self): expected = [] actual = list(choose_1_from_each([[]])) self.assertListEqual(expected, actual) def test_choose_1_from_each_basic(self): inputs = [ ['A', 'B'], ['C', 'D'] ] expected = [ ['A', 'C'], ['A', 'D'], ['B', 'C'], ['B', 'D'] ] actual = list(choose_1_from_each(inputs)) self.assertListEqual(expected, actual) def test_choose_1_from_each_varying_sizes(self): inputs = [ ['A'], ['B', 'C'], ['D', 'E', 'F'] ] expected = [ ['A', 'B', 'D'], ['A', 'B', 'E'], ['A', 'B', 'F'], ['A', 'C', 'D'], ['A', 'C', 'E'], ['A', 'C', 'F'], ] actual = list(choose_1_from_each(inputs)) self.assertListEqual(expected, actual) class IntentScoringTest(unittest.TestCase): def setUp(self): self.require_intent = IntentBuilder('require_intent'). \ require('required'). \ build() self.one_of_intent = IntentBuilder('one_of_intent'). \ one_of('one_of_1', 'one_of_2'). \ build() self.optional_intent = IntentBuilder('optional_intent'). \ optionally('optional'). \ build() self.all_features_intent = IntentBuilder('test_intent'). \ require('required'). \ one_of('one_of_1', 'one_of_2'). \ optionally('optional'). \ build() def test_basic_scoring_default_weights(self): required = TestTag('required', 'foo') one_of_1 = TestTag('one_of_1', 'bar') optional = TestTag('optional', 'bing') intent, tags = \ self.require_intent.validate_with_tags([required], confidence=1.0) self.assertEqual(1.0, intent.get('confidence')) self.assertListEqual([required], tags) intent, tags = \ self.one_of_intent.validate_with_tags([one_of_1], confidence=1.0) self.assertEqual(1.0, intent.get('confidence')) self.assertListEqual([one_of_1], tags) intent, tags = \ self.optional_intent.validate_with_tags([optional], confidence=1.0) self.assertEqual(1.0, intent.get('confidence')) self.assertListEqual([optional], tags) def test_weighted_scoring_from_regex_entities(self): required = TestTag('required', 'foo', entity_confidence=0.5) one_of_1 = TestTag('one_of_1', 'bar', entity_confidence=0.5) optional = TestTag('optional', 'bing', entity_confidence=0.5) intent, tags = \ self.require_intent.validate_with_tags([required], confidence=1.0) self.assertEqual(0.5, intent.get('confidence')) self.assertListEqual([required], tags) intent, tags = \ self.one_of_intent.validate_with_tags([one_of_1], confidence=1.0) self.assertEqual(0.5, intent.get('confidence')) self.assertListEqual([one_of_1], tags) intent, tags = \ self.optional_intent.validate_with_tags([optional], confidence=1.0) self.assertEqual(0.5, intent.get('confidence')) self.assertListEqual([optional], tags) def test_weighted_scoring_from_fuzzy_matching(self): required = TestTag('required', 'foo') one_of_1 = TestTag('one_of_1', 'bar') optional = TestTag('optional', 'bing') intent, tags = \ self.require_intent.validate_with_tags([required], confidence=0.5) self.assertEqual(0.5, intent.get('confidence')) self.assertListEqual([required], tags) intent, tags = \ self.one_of_intent.validate_with_tags([one_of_1], confidence=0.5) self.assertEqual(0.5, intent.get('confidence')) self.assertListEqual([one_of_1], tags) intent, tags = \ self.optional_intent.validate_with_tags([optional], confidence=0.5) self.assertEqual(0.5, intent.get('confidence')) self.assertListEqual([optional], tags)