kbot-py-client 2.0.2__tar.gz → 2.0.4__tar.gz

{kbot_py_client-2.0.2/kbot_py_client.egg-info → kbot_py_client-2.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kbot-py-client
-Version: 2.0.2
+Version: 2.0.4
 Summary: Client for Konverso Kbot
 Home-page: https://www.konverso.ai
 Author: Konverso
@@ -146,6 +146,37 @@ In this example, we create a conversation between the logged in user and the bot
     	else:
     	    print("Could not create conversation due to: ", r.text)
 	
+## Uploading one file to kbot
+
+
+### Prerequisites
+* A local file that you wish to send
+* The UUID of the folder that will receive the files you want to upload
+
+### Code sample
+```
+        current_top_folder = "uuid-of-a-folder"
+        filepath = "/tmp/test.pdf"
+        filename = os.path.basename(filepath)
+        
+        # Upload to remote filemanager
+        with open(filepath, "rb") as fd:
+            files = {
+                        "upload_files": fd
+                    }
+            params= {
+                        "override": False
+                    }
+            data = {
+                        "folder": current_top_folder,
+                        "name": file_name,
+                    }
+            response = self.client.post_file("attachment",
+                                                     data=data,
+                                                     params=params,
+                                                     files=files)
+```
+
 ## Uploading a batch of files to the file manager
 
 ### Prerequisites
@@ -162,5 +193,5 @@ In this example, we simply upload the content of a directory to a folder in the
         client = Client("mybot.konverso.ai", api_key="17ebXXXXXXXXXXXXXXXXXXXXX")
 
         syncer = FolderSync(client)
-        syncer.sync("/tmp/my_source_folder/", "1831fXXXXXXXXXXXXXXXXXXXXXXX")
+        syncer.sync("/tmp/my_source_folder/", "1831f-XXXXXXXXXXXXXXXXXXXXXXX")
         print("Syncing is done :)")

{kbot_py_client-2.0.2 → kbot_py_client-2.0.4}/README.md

@@ -131,6 +131,37 @@ In this example, we create a conversation between the logged in user and the bot
     	else:
     	    print("Could not create conversation due to: ", r.text)
 	
+## Uploading one file to kbot
+
+
+### Prerequisites
+* A local file that you wish to send
+* The UUID of the folder that will receive the files you want to upload
+
+### Code sample
+```
+        current_top_folder = "uuid-of-a-folder"
+        filepath = "/tmp/test.pdf"
+        filename = os.path.basename(filepath)
+        
+        # Upload to remote filemanager
+        with open(filepath, "rb") as fd:
+            files = {
+                        "upload_files": fd
+                    }
+            params= {
+                        "override": False
+                    }
+            data = {
+                        "folder": current_top_folder,
+                        "name": file_name,
+                    }
+            response = self.client.post_file("attachment",
+                                                     data=data,
+                                                     params=params,
+                                                     files=files)
+```
+
 ## Uploading a batch of files to the file manager
 
 ### Prerequisites
@@ -147,5 +178,5 @@ In this example, we simply upload the content of a directory to a folder in the
         client = Client("mybot.konverso.ai", api_key="17ebXXXXXXXXXXXXXXXXXXXXX")
 
         syncer = FolderSync(client)
-        syncer.sync("/tmp/my_source_folder/", "1831fXXXXXXXXXXXXXXXXXXXXXXX")
+        syncer.sync("/tmp/my_source_folder/", "1831f-XXXXXXXXXXXXXXXXXXXXXXX")
         print("Syncing is done :)")

kbot_py_client-2.0.4/kbot_client/chat_client.py

@@ -0,0 +1,178 @@
+import time
+from abc import ABC, abstractmethod
+
+class ChatClient(ABC):
+    def __init__(self, client,
+                 render_types=("text", "html"),
+                 prompt="{sender}> {message}",
+                 user_prompt = "User> ",
+                 bye = "Bye, hope to see you again soon",
+                 exit_commands = ("stop", "exit")):
+
+        self._client = client
+        self._render_types = render_types
+        self._prompt = prompt
+        self._user_prompt = user_prompt
+        self._bye = bye
+        self._exit_commands = exit_commands
+
+        # Create a new conversation
+        #
+        response = self._client.post("conversation", data={"username": "bot"})
+        response.raise_for_status()
+
+        # Print the first welcome message
+        #
+        self._process_new_messages(response.json(), context="welcome")
+
+        # Loop waiting for user questions and then waiting for the bot response
+        #
+        self._start_question_answer_loop(response.json().get("id"))
+
+    def _process_new_messages(self, messages_json, context):
+        """Given a JSON response from the bot, extract two key information:
+           - sender: The name of the bot
+           - messages: A list of the JSON matching the type constraints such as:
+
+          Arguments:
+           - context: One of "welcome" or "response"
+
+           The input json of a Welcome (conversation creation) is expected to have format such as:
+           {
+               "sender": {...}
+               "messages": [{
+                    "type": "message",
+                    "message": [{
+                         "format": "text",
+                         "value": "Hello John",
+                          ...
+
+           The input json of a Response (conversation response) is expected to have format such as:
+           [{
+                "sender": {...}
+                 "type": "message",
+                 "message": [{
+                      "format": "text",
+                      "value": "Hello John",
+                       ...
+
+           Returns a tuple of two elements: sender, messages
+        """
+
+        stop = False
+        if context == "welcome":
+            self._sender = messages_json.get("sender").get("name")
+
+            for message in messages_json.get("messages"):
+                message_type = message.get("type")
+
+                if message.get("type") != "message":
+                    continue
+
+                for message_content in message.get("message"):
+                    if message_content.get("format") in self._render_types:
+                        self._display_response(message_content)
+
+        elif context == "response":
+            #print(messages_json)
+
+            for one_message in messages_json.get("messages"):
+                self._sender = one_message.get("sender").get("name")
+                message_type = one_message.get("type")
+
+                if message_type == "stop_topic":
+                    stop = True
+
+                if one_message.get("type") != "message":
+                    continue
+
+                for message_content in one_message.get("message"):
+                    if message_content.get("format") in self._render_types:
+                        self._display_response(message_content)
+
+        return stop
+
+    def _display_response(self, message):
+        """Display to the user the message. The message argument is a json in the format:
+            {
+                      "format": "text",
+                      "value": "Hello John",
+                       ...
+        """
+        print(self._prompt.format(sender=self._sender, message=message.get('value')))
+
+    def _start_question_answer_loop(self, conversation_id):
+
+        # Start the chatbot, in a loop
+        # We stop when user type "exit" or EOF (Ctrl D)
+        while True:
+
+            # Get the user sentence and check for the stop conditions
+            #
+            try:
+                question = input(self._user_prompt)
+            except EOFError:
+                print(self._bye)
+                break
+
+            if not question:
+                continue
+
+            if question.lower() in self._exit_commands:
+                print(self._bye)
+                break
+
+            self._send_question(question, conversation_id)
+            self._get_response(conversation_id)
+
+
+    def _send_question(self, question, conversation_id):
+        # Send the user question to Kbot.
+        #
+        data = {
+            "conversation_id": conversation_id,
+            "type":"message",
+            "message": question,
+            "fromUser": True,
+        }
+
+        response = self._client.post(f"conversation/{conversation_id}/message", data=data)
+        response.raise_for_status()
+
+    @abstractmethod
+    def _get_response(self, conversation_id):
+        """Collect the kbot response"""
+
+class AsyncChatClient(ChatClient):
+    """A Chatbot client that will pull for updates and display responses
+       as they come
+    """
+    def __init__(self, client, pull_interval=0.5, pull_timeout=10, **kwargs):
+        self._pull_interval = pull_interval
+        self._pull_timeout = pull_timeout
+        super().__init__(client,**kwargs)
+
+    def _get_response(self, conversation_id):
+        # Wait for the response(s)
+        #
+        while True:
+            time.sleep(self._pull_interval)
+            response = self._client.get(f"conversation/{conversation_id}/messages", params={"timeout": self._pull_timeout})
+            response.raise_for_status()
+
+            stop = self._process_new_messages(response.json(), context="response")
+            if stop:
+                # Time to ask for a new question
+                break
+
+class SyncChatClient(ChatClient):
+    """A Chatbot client that will wait for full response from the bot before displaying to the user
+    """
+
+    def _get_response(self, conversation_id):
+        # Wait for the response(s)
+        #
+        params = {"wait": "true"}
+        response = self._client.get(f"conversation/{conversation_id}/messages", params=params)
+        response.raise_for_status()
+        self._process_new_messages(response.json(), context="response")

{kbot_py_client-2.0.2 → kbot_py_client-2.0.4}/kbot_client/client.py

@@ -176,7 +176,11 @@ class Client:
         self.__reset_headers(r.json())
 
     def __request(self, method: str, uri : str = None, data: dict = None, params: dict = None, files: dict = None, attempt=0):
-        dump_data = json.dumps(data or {})
+        if files:
+            # For file upload, the data must be a dictionnary
+            dump_data = data
+        else:
+            dump_data = json.dumps(data or {})
 
         if files:
             headers = self._headers.copy()
@@ -185,7 +189,7 @@ class Client:
         else:
             headers = self._headers
 
-        r = requests.request(method.upper(), self.url + '/api/%s/' % (uri), params=params, data=dump_data, headers=headers, verify=self.verify)
+        r = requests.request(method.upper(), self.url + '/api/%s/' % (uri), params=params, data=dump_data, headers=headers, files=files, verify=self.verify)
 
         if r.status_code == 401:
             # Refresh the token
@@ -204,8 +208,8 @@ class Client:
 
         return r
 
-    def request(self, method: str, uri: str, data: dict = None, params: dict = None):
-        return self.__request(method, uri=uri, data=data, params=params)
+    def request(self, method: str, uri: str, data: dict = None, params: dict = None, files: dict = None):
+        return self.__request(method, uri=uri, data=data, params=params, files=files)
 
     def unit(self, name: str, params=None) -> dict:
         r = self.get(name, params)

{kbot_py_client-2.0.2 → kbot_py_client-2.0.4}/kbot_client/client.recording.py

@@ -28,9 +28,7 @@ class Client:
         else:
             proto = 'http'
 
-        if proto == "https" and port == 443:
-            self.url = "%s://%s" % (proto, server)
-        elif proto == "https" and port == 443:
+        if port in (80, 443):
             self.url = "%s://%s" % (proto, server)
         else:
             self.url = "%s://%s:%s" % (proto, server, port)

{kbot_py_client-2.0.2 → kbot_py_client-2.0.4/kbot_py_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kbot-py-client
-Version: 2.0.2
+Version: 2.0.4
 Summary: Client for Konverso Kbot
 Home-page: https://www.konverso.ai
 Author: Konverso
@@ -146,6 +146,37 @@ In this example, we create a conversation between the logged in user and the bot
     	else:
     	    print("Could not create conversation due to: ", r.text)
 	
+## Uploading one file to kbot
+
+
+### Prerequisites
+* A local file that you wish to send
+* The UUID of the folder that will receive the files you want to upload
+
+### Code sample
+```
+        current_top_folder = "uuid-of-a-folder"
+        filepath = "/tmp/test.pdf"
+        filename = os.path.basename(filepath)
+        
+        # Upload to remote filemanager
+        with open(filepath, "rb") as fd:
+            files = {
+                        "upload_files": fd
+                    }
+            params= {
+                        "override": False
+                    }
+            data = {
+                        "folder": current_top_folder,
+                        "name": file_name,
+                    }
+            response = self.client.post_file("attachment",
+                                                     data=data,
+                                                     params=params,
+                                                     files=files)
+```
+
 ## Uploading a batch of files to the file manager
 
 ### Prerequisites
@@ -162,5 +193,5 @@ In this example, we simply upload the content of a directory to a folder in the
         client = Client("mybot.konverso.ai", api_key="17ebXXXXXXXXXXXXXXXXXXXXX")
 
         syncer = FolderSync(client)
-        syncer.sync("/tmp/my_source_folder/", "1831fXXXXXXXXXXXXXXXXXXXXXXX")
+        syncer.sync("/tmp/my_source_folder/", "1831f-XXXXXXXXXXXXXXXXXXXXXXX")
         print("Syncing is done :)")

{kbot_py_client-2.0.2 → kbot_py_client-2.0.4}/kbot_py_client.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ LICENSE
 README.md
 setup.py
 kbot_client/__init__.py
+kbot_client/chat_client.py
 kbot_client/client.py
 kbot_client/client.recording.py
 kbot_client/client_group.py

{kbot_py_client-2.0.2 → kbot_py_client-2.0.4}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", mode="r", encoding="utf-8") as fh:
 
 setuptools.setup(
     name="kbot-py-client",
-    version="2.0.2",
+    version="2.0.4",
     author="Konverso",
     author_email="contact@konverso.ai",
     description="Client for Konverso Kbot",