ovos-adapt-parser 0.1.0__tar.gz

ovos-adapt-parser-0.1.0/LICENSE.md

@@ -0,0 +1,211 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.
+   
+=======================================================================
+
+Component licenses for Adapt:
+
+The Adapt software references various Python Packages (via PIP),
+each of which has a separate license.  All are compatible with the
+Apache 2.0 license. See the referenced packages listed in the
+"requirements.txt" file for specific terms and conditions.

ovos-adapt-parser-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+README.md
+LICENSE.md
+requirements.txt

ovos-adapt-parser-0.1.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.1
+Name: ovos-adapt-parser
+Version: 0.1.0
+Summary: A text-to-intent parsing framework.
+Home-page: https://github.com/OpenVoiceOS/ovos-adapt-pipeline-plugin
+Author: Sean Fitzgerald
+License: Apache License 2.0
+Description: [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.md) 
+        
+        Adapt Intent Parser
+        ==================
+        The Adapt Intent Parser is a flexible and extensible intent definition and determination framework. It is intended to parse natural language text into a structured intent that can then be invoked programatically.
+        
+        This repository contains a OVOS pipeline plugin and bundles a fork of the original [adapt-parser](https://github.com/MycroftAI/adapt) from the defunct MycroftAI
+        
+        Examples
+        ========
+        Executable examples can be found in the [examples folder](https://github.com/MycroftAI/adapt/tree/master/examples).
+        
+        Intent Modelling
+        ================
+        In this context, an Intent is an action the system should perform. In the context of Pandora, we’ll define two actions: List Stations, and Select Station (aka start playback)
+        
+        With the Adapt intent builder:
+        ```Python
+        list_stations_intent = IntentBuilder('pandora:list_stations')\
+            .require('Browse Music Command')\
+            .build()
+        ```
+        
+        For the above, we are describing a “List Stations” intent, which has a single requirement of a “Browse Music Command” entity.
+        
+        ```Python
+        play_music_command = IntentBuilder('pandora:select_station')\
+            .require('Listen Command')\
+            .require('Pandora Station')\
+            .optionally('Music Keyword')\
+            .build()
+        ```
+        
+        
+        For the above, we are describing a “Select Station” (aka start playback) intent, which requires a “Listen Command” entity, a “Pandora Station”, and optionally a “Music Keyword” entity.
+        
+        Entities
+        ========
+        
+        Entities are a named value. Examples include:
+        `Blink 182` is an `Artist`
+        `The Big Bang Theory` is a `Television Show`
+        `Play` is a `Listen Command`
+        `Song(s)` is a `Music Keyword`
+        
+        For my Pandora implementation, there is a static set of vocabulary for the Browse Music Command, Listen Command, and Music Keyword (defined by me, a native english speaker and all-around good guy). Pandora Station entities are populated via a "List Stations" API call to Pandora. Here’s what the vocabulary registration looks like.
+        
+        ```Python
+        def register_vocab(entity_type, entity_value):
+            pass
+            # a tiny bit of code 
+        
+        def register_pandora_vocab(emitter):
+            for v in ["stations"]:
+                register_vocab('Browse Music Command', v)
+        
+            for v in ["play", "listen", "hear"]:
+                register_vocab('Listen Command', v)
+        
+            for v in ["music", "radio"]:
+                register_vocab('Music Keyword', v)
+        
+            for v in ["Pandora"]:
+                register_vocab('Plugin Name', v)
+        
+            station_name_regex = re.compile(r"(.*) Radio")
+            p = get_pandora()
+            for station in p.stations:
+                m = station_name_regex.match(station.get('stationName'))
+                if not m:
+                    continue
+                for match in m.groups():
+                    register_vocab('Pandora Station', match)
+        ```
+        
+        
+        Reporting Issues
+        ================
+        It's often difficult to debug issues with adapt without a complete context. To facilitate simpler debugging,
+        please include a serialized copy of the intent determination engine using the debug dump
+        utilities.
+        
+        ```python
+        from ovos_adapt.engine import IntentDeterminationEngine
+        
+        engine = IntentDeterminationEngine()
+        # Load engine with vocabulary and parsers
+        
+        import ovos_adapt.tools.debug as atd
+        
+        atd.dump(engine, 'debug.ovos_adapt')
+        ```
+        
+        
+Keywords: natural language processing
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Description-Content-Type: text/markdown

ovos-adapt-parser-0.1.0/README.md

@@ -0,0 +1,93 @@
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.md) 
+
+Adapt Intent Parser
+==================
+The Adapt Intent Parser is a flexible and extensible intent definition and determination framework. It is intended to parse natural language text into a structured intent that can then be invoked programatically.
+
+This repository contains a OVOS pipeline plugin and bundles a fork of the original [adapt-parser](https://github.com/MycroftAI/adapt) from the defunct MycroftAI
+
+Examples
+========
+Executable examples can be found in the [examples folder](https://github.com/MycroftAI/adapt/tree/master/examples).
+
+Intent Modelling
+================
+In this context, an Intent is an action the system should perform. In the context of Pandora, we’ll define two actions: List Stations, and Select Station (aka start playback)
+
+With the Adapt intent builder:
+```Python
+list_stations_intent = IntentBuilder('pandora:list_stations')\
+    .require('Browse Music Command')\
+    .build()
+```
+
+For the above, we are describing a “List Stations” intent, which has a single requirement of a “Browse Music Command” entity.
+
+```Python
+play_music_command = IntentBuilder('pandora:select_station')\
+    .require('Listen Command')\
+    .require('Pandora Station')\
+    .optionally('Music Keyword')\
+    .build()
+```
+
+
+For the above, we are describing a “Select Station” (aka start playback) intent, which requires a “Listen Command” entity, a “Pandora Station”, and optionally a “Music Keyword” entity.
+
+Entities
+========
+
+Entities are a named value. Examples include:
+`Blink 182` is an `Artist`
+`The Big Bang Theory` is a `Television Show`
+`Play` is a `Listen Command`
+`Song(s)` is a `Music Keyword`
+
+For my Pandora implementation, there is a static set of vocabulary for the Browse Music Command, Listen Command, and Music Keyword (defined by me, a native english speaker and all-around good guy). Pandora Station entities are populated via a "List Stations" API call to Pandora. Here’s what the vocabulary registration looks like.
+
+```Python
+def register_vocab(entity_type, entity_value):
+    pass
+    # a tiny bit of code 
+
+def register_pandora_vocab(emitter):
+    for v in ["stations"]:
+        register_vocab('Browse Music Command', v)
+
+    for v in ["play", "listen", "hear"]:
+        register_vocab('Listen Command', v)
+
+    for v in ["music", "radio"]:
+        register_vocab('Music Keyword', v)
+
+    for v in ["Pandora"]:
+        register_vocab('Plugin Name', v)
+
+    station_name_regex = re.compile(r"(.*) Radio")
+    p = get_pandora()
+    for station in p.stations:
+        m = station_name_regex.match(station.get('stationName'))
+        if not m:
+            continue
+        for match in m.groups():
+            register_vocab('Pandora Station', match)
+```
+
+
+Reporting Issues
+================
+It's often difficult to debug issues with adapt without a complete context. To facilitate simpler debugging,
+please include a serialized copy of the intent determination engine using the debug dump
+utilities.
+
+```python
+from ovos_adapt.engine import IntentDeterminationEngine
+
+engine = IntentDeterminationEngine()
+# Load engine with vocabulary and parsers
+
+import ovos_adapt.tools.debug as atd
+
+atd.dump(engine, 'debug.ovos_adapt')
+```
+

ovos-adapt-parser-0.1.0/ovos_adapt/__init__.py

@@ -0,0 +1,21 @@
+# 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.
+#
+
+__author__ = 'seanfitz'
+import os
+if os.path.exists('README.md'):
+  import codecs
+  __doc__ = codecs.open('README.md', encoding='utf-8', mode='r').read()
+

ovos-adapt-parser-0.1.0/ovos_adapt/context.py

@@ -0,0 +1,154 @@
+# 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.
+#
+
+"""
+Context Management code for Adapt (where context ~= persistent session state).
+"""
+from six.moves import xrange
+
+__author__ = "seanfitz, Art McGee"
+
+
+class ContextManagerFrame(object):
+    """
+    Manages entities and context for a single frame of conversation.
+    Provides simple equality querying.
+
+    Attributes:
+        entities(list): Entities that belong to ContextManagerFrame
+        metadata(object): metadata to describe context belonging to ContextManagerFrame
+    """
+    def __init__(self, entities=None, metadata=None):
+        """
+        Initialize ContextManagerFrame
+
+        Args:
+            entities(list): List of Entities...
+            metadata(object): metadata to describe context?
+        """
+        self.entities = entities or []
+        self.metadata = metadata or {}
+
+    def metadata_matches(self, query=None):
+        """
+        Returns key matches to metadata
+
+        Asserts that the contents of query exist within (logical subset of)
+        metadata in this frame.
+        Args:
+            query(object): metadata for matching
+
+        Returns:
+            bool:
+                True: when key count in query is > 0 and all keys in query in
+                    self.metadata
+                False: if key count in query is <= 0 or any key in query not
+                    found in self.metadata
+
+        """
+        query = query or {}
+        result = len(query.keys()) > 0
+        for key in query.keys():
+            result = result and query[key] == self.metadata.get(key)
+
+        return result
+
+    def merge_context(self, tag, metadata):
+        """
+        merge into contextManagerFrame new entity and metadata.
+
+        Appends tag as new entity and adds keys in metadata to keys in
+        self.metadata.
+
+        Args:
+            tag(str): entity to be added to self.entities
+            metadata(object): metadata containes keys to be added to self.metadata
+        """
+        self.entities.append(tag)
+        for k, v in metadata.items():
+            if k not in self.metadata:
+                self.metadata[k] = v
+
+
+class ContextManager(object):
+    """
+    ContextManager
+    Use to track context throughout the course of a conversational session.
+    How to manage a session's lifecycle is not captured here.
+    """
+    def __init__(self):
+        self.frame_stack = []
+
+    def inject_context(self, entity, metadata=None):
+        """
+        Add an entity to the current context.
+        If metadata matches the top of the context frame stack, merge.
+        Else, create a new frame and push it on top of the stack.
+        Args:
+            entity(object):
+                format {'data': 'Entity tag as <str>',
+                        'key': 'entity proper name as <str>',
+                         'confidence': <float>'
+                         }
+            metadata(object): dict, arbitrary metadata about the entity being added
+        """
+        metadata = metadata or {}
+        top_frame = self.frame_stack[0] if len(self.frame_stack) > 0 else None
+        if top_frame and top_frame.metadata_matches(metadata):
+            top_frame.merge_context(entity, metadata)
+        else:
+            frame = ContextManagerFrame(entities=[entity], metadata=metadata.copy())
+            self.frame_stack.insert(0, frame)
+
+    def get_context(self, max_frames=None, missing_entities=None):
+        """
+        Returns context, including decaying weights based on depth in stack.
+
+        Args:
+            max_frames(int): maximum number of frames to look back
+            missing_entities(list of str): a list or set of tag names, as strings
+
+        Returns:
+            list: a list of entities
+        """
+        missing_entities = missing_entities or []
+        if not max_frames or max_frames > len(self.frame_stack):
+            max_frames = len(self.frame_stack)
+
+        missing_entities = list(missing_entities)
+        context = []
+        for i in xrange(max_frames):
+            frame_entities = [entity.copy() for entity in self.frame_stack[i].entities]
+            for entity in frame_entities:
+                entity['confidence'] = entity.get('confidence', 1.0) / (2.0 + i)
+            context += frame_entities
+
+        result = []
+        if len(missing_entities) > 0:
+            for entity in context:
+                if entity.get('data') in missing_entities:
+                    result.append(entity)
+                    # NOTE: this implies that we will only ever get one
+                    # of an entity kind from context, unless specified
+                    # multiple times in missing_entities. Cannot get
+                    # an arbitrary number of an entity kind.
+                    missing_entities.remove(entity.get('data'))
+        else:
+            result = context
+
+        return result
+
+
+