sapling-py 4.0.0__tar.gz → 4.0.2__tar.gz

{sapling-py-4.0.0/sapling_py.egg-info → sapling_py-4.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sapling-py
-Version: 4.0.0
+Version: 4.0.2
 Summary: Sapling Python Client
 Home-page: https://sapling.ai
 Author: Sapling Intelligence
@@ -10,6 +10,7 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests
 
 # Sapling Python Client
 

{sapling-py-4.0.0 → sapling_py-4.0.2}/sapling/client.py

@@ -38,6 +38,8 @@ class SaplingClient:
         medical=None,
         auto_apply=False,
         advanced_edits=None,
+        user_id=None,
+        is_anon_user=None,
     ):
         '''
         Fetches edits (including for grammar and spelling) for provided text.
@@ -46,8 +48,8 @@ class SaplingClient:
         :type text: str
         :param session_id: Unique name or UUID of document or portion of text that is being checked
         :type session_id: str
-        :param session_id: 2 letter ISO 639-1 language code
-        :type session_id: str
+        :param lang: 2 letter ISO 639-1 language code
+        :type lang: str
         :param variety: Specifies regional English variety preference. Defaults to the configuration in the user Sapling dashboard.
         :type variety: str
         :param medical: If true, the backend will apply Sapling's medical dictionary.
@@ -56,26 +58,10 @@ class SaplingClient:
         :type auto_apply: bool
         :param advanced_edits: Additional edit configurations
         :type advanced_edits: dict
-            Options:
-                - advanced_edits
-                - adverbs
-                - simplifications
-                - hard_to_read
-                - qualifiers
-                - voice
-                - dei
-                - gender
-                - gender_pronoun
-                - gender_noun
-                - gender_id
-                - sensitivity
-                - disability
-                - age
-                - race
-                - social_class
-                - violence
-\
-
+        :param user_id: Track IDs representing your end users
+        :type user_id: str
+        :param is_anon_user: If user_id represents a logged-in or anonymous user
+        :type is_anon_user: bool
         :rtype: dict
         :return:
             - edits: List of Edits:
@@ -111,6 +97,24 @@ class SaplingClient:
             - `ca-variety`: Canadian English
             - `null-variety`: Don't suggest changes based on English variety
 
+        Supported advanced_edit options:
+            - advanced_edits
+            - adverbs
+            - simplifications
+            - hard_to_read
+            - qualifiers
+            - voice
+            - dei
+            - gender
+            - gender_pronoun
+            - gender_noun
+            - gender_id
+            - sensitivity
+            - disability
+            - age
+            - race
+            - social_class
+            - violence
         '''
 
         url = self.url_endpoint + 'edits'
@@ -131,6 +135,11 @@ class SaplingClient:
         if advanced_edits is not None:
             data['advanced_edits'] = advanced_edits
 
+        if user_id is not None:
+            data['user_id'] = user_id
+        if is_anon_user is not None:
+            data['is_anon_user'] = is_anon_user
+
         resp = requests.post(
             url,
             json=data,
@@ -144,6 +153,7 @@ class SaplingClient:
         self,
         edit_uuid,
         session_id=None,
+        user_id=None,
     ):
         '''
         Use this API endpoint to have Sapling adapt its system over time.
@@ -156,6 +166,8 @@ class SaplingClient:
         :type edit_uuid: str, uuid
         :param session_id: Unique name or UUID of text that is being processed
         :type session_id: str
+        :param user_id: Track IDs representing your end users
+        :type user_id: str
         '''
         url = f'{self.url_endpoint}edits/{edit_uuid}/accept'
         session_id = session_id or self.default_session_id
@@ -163,6 +175,10 @@ class SaplingClient:
             'key': self.api_key,
             'session_id': session_id,
         }
+
+        if user_id is not None:
+            data['user_id'] = user_id
+
         resp = requests.post(
             url,
             json=data,
@@ -176,6 +192,7 @@ class SaplingClient:
         self,
         edit_uuid,
         session_id=None,
+        user_id=None,
     ):
         '''
         Use this API endpoint to have Sapling not recommend the same edit anymore.
@@ -188,6 +205,8 @@ class SaplingClient:
         :type edit_uuid: str, uuid
         :param session_id: Unique name or UUID of text that is being processed
         :type session_id: str
+        :param user_id: Track IDs representing your end users
+        :type user_id: str
         '''
         url = f'{self.url_endpoint}edits/{edit_uuid}/reject'
         session_id = session_id or self.default_session_id
@@ -195,6 +214,10 @@ class SaplingClient:
             'key': self.api_key,
             'session_id': session_id,
         }
+
+        if user_id is not None:
+            data['user_id'] = user_id
+
         resp = requests.post(
             url,
             json=data,
@@ -214,6 +237,8 @@ class SaplingClient:
         auto_apply=False,
         variety=None,
         user_data=None,
+        user_id=None,
+        is_anon_user=None
     ):
         '''
         Fetches spelling (no grammar or phrase level) edits for provided text.
@@ -234,6 +259,10 @@ class SaplingClient:
         :type advanced_edits: dict
         :param variety: Specifies regional English variety preference. Defaults to the configuration in the user Sapling dashboard.
         :type variety: str
+        :param user_id: Track IDs representing your end users
+        :type user_id: str
+        :param is_anon_user: If user_id represents a logged-in or anonymous user
+        :type is_anon_user: bool
 
         :rtype: list[dict]
 
@@ -309,14 +338,18 @@ class SaplingClient:
         if user_data is not None:
             data['user_data'] = user_data
 
+        if user_id is not None:
+            data['user_id'] = user_id
+        if is_anon_user is not None:
+            data['is_anon_user'] = is_anon_user
+
         resp = requests.post(
             url,
             json=data,
             timeout=self.timeout,
         )
         if 200 <= resp.status_code < 300:
-            resp_json = resp.json()
-            return resp_json.get('edits')
+            return resp.json()
         raise Exception(f'HTTP {resp.status_code}: {resp.text}')
 
 
@@ -347,8 +380,7 @@ class SaplingClient:
             timeout=self.timeout,
         )
         if 200 <= resp.status_code < 300:
-            resp_json = resp.json()
-            return resp_json
+            return resp.json()
         raise Exception(f'HTTP {resp.status_code}: {resp.text}')
 
     def accept_complete(

sapling_py-4.0.2/sapling/version.py

@@ -0,0 +1 @@
+__version__ = '4.0.2'

{sapling-py-4.0.0 → sapling_py-4.0.2/sapling_py.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sapling-py
-Version: 4.0.0
+Version: 4.0.2
 Summary: Sapling Python Client
 Home-page: https://sapling.ai
 Author: Sapling Intelligence
@@ -10,6 +10,7 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests
 
 # Sapling Python Client
 

sapling-py-4.0.0/sapling/version.py

@@ -1 +0,0 @@
-__version__ = '4.0.0'