naeural-client 2.2.5__tar.gz → 2.2.6__tar.gz

{naeural_client-2.2.5 → naeural_client-2.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: naeural_client
-Version: 2.2.5
+Version: 2.2.6
 Summary: `naeural_client` is the Python SDK required for client app development for the Naeural Edge Protocol Edge Protocol framework
 Project-URL: Homepage, https://github.com/Naeural Edge ProtocolEdgeProtocol/naeural_client
 Project-URL: Bug Tracker, https://github.com/Naeural Edge ProtocolEdgeProtocol/naeural_client/issues

{naeural_client-2.2.5 → naeural_client-2.2.6}/naeural_client/_ver.py

@@ -1,4 +1,4 @@
-__VER__ = "2.2.5"
+__VER__ = "2.2.6"
 
 if __name__ == "__main__":
   with open("pyproject.toml", "rt") as fd:

{naeural_client-2.2.5 → naeural_client-2.2.6}/naeural_client/io_formatter/base/base_formatter.py

@@ -70,7 +70,8 @@ class BaseFormatter(object):
       output = self._decode_output(encoded_output)
     except Exception as e:
       output = {}
-      msg = "ERROR! Could not decode {}\n{}".format(encoded_output, e)
+      encoded_output_for_print = {k: v for k, v in encoded_output.items() if k != PAYLOAD_DATA.EE_ENCRYPTED_DATA}
+      msg = "ERROR! Could not decode {}\n{}".format(encoded_output_for_print, e)
       self.P(msg)
       self.P(traceback.format_exc(), color='r')
     # end try-except

{naeural_client-2.2.5 → naeural_client-2.2.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "naeural_client"
-version = "2.2.5"
+version = "2.2.6"
 authors = [
   { name="Stefan Saraev", email="saraevstefan@gmail.com" },
   { name="Andrei Ionut Damian", email="andrei.damian@me.com" },

{naeural_client-2.2.5 → naeural_client-2.2.6}/tutorials/ex12_telegram_smart_bot.py

@@ -1,25 +1,29 @@
 import os
-import time
-
-from naeural_client import Session, CustomPluginTemplate
+from naeural_client import Session
 
 if __name__ == "__main__":
-  my_node = os.getenv("TARGET_NODE") # we specify a node here
+  my_node = os.getenv("TARGET_NODE")  # we specify a node here
+  # The node can also be specified directly, without using the environment variable.
+  # my_node = "<target_edge_node_identifier>"
   
   if my_node is None:
+    # In case the node is not specified, we exit the script.
     print("Please specify the node to connect to.")
     exit(1)
-  
+
+  # We define the system prompt
   SYSTEM_PROMPT = """
   Hi! I am a simple echo bot. I will repeat everything you say to me.
   """
-    
-  session = Session() # assume .env is available and will be used for the connection and tokens
-  session.wait_for_node(my_node) # wait for the node to be active
 
-       
-  # now we create a telegram bot pipeline & plugin instance
-  # we can chose to use the token directly or use the environment key
+  session = Session()  # assume .env is available and will be used for the connection and tokens
+  session.wait_for_node(my_node)  # wait for the node to be active
+
+  # Now we create a telegram bot pipeline & plugin instance.
+  # For that we must have a telegram bot token and a telegram bot name.
+  # We can provide those directly or use the environment keys.
+  # In case you need a telegram bot token, you have a guide right here:
+  # https://core.telegram.org/bots/tutorial
   pipeline, _ = session.create_telegram_conversational_bot(
     node=my_node,
     name="telegram_chatbot",
@@ -28,15 +32,16 @@ if __name__ == "__main__":
     # telegram_bot_token_env_key=ENVIRONMENT.TELEGRAM_BOT_TOKEN_ENV_KEY, # not mandatory - we can use the default
     # telegram_bot_name=None,     # not mandatory - can be used to specify the bot name directly
     # telegram_bot_name_env_key=ENVIRONMENT.TELEGRAM_BOT_NAME_ENV_KEY, # not mandatory - we can use the default
-    
-    system_prompt=SYSTEM_PROMPT, # simple bot based on system prompt only
-    agent_type="API", # "API", "HOSTED"
+
+    system_prompt=SYSTEM_PROMPT,  # simple bot based on system prompt only
+    agent_type="HOSTED",  # "API", "HOSTED"
+    # In case of "API" agent type, we need to provide the API token.
     # api_token_env_key=ENVIRONMENT.TELEGRAM_API_AGENT_TOKEN_ENV_KEY, # not mandatory - we can use the default
     # api_token=None, # not mandatory - can be used to specify the token directly
-    rag_source_url=None, # no rag source for this example
+    rag_source_url=None,  # no rag source for this example
   )
   
-  pipeline.deploy() # we deploy the pipeline
+  pipeline.deploy()  # we deploy the pipeline
 
   # # Observation:
   # #   next code is not mandatory - it is used to keep the session open and cleanup the resources