naeural-client 2.1.2__tar.gz → 2.1.3__tar.gz

{naeural_client-2.1.2 → naeural_client-2.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: naeural_client
-Version: 2.1.2
+Version: 2.1.3
 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.1.2 → naeural_client-2.1.3}/naeural_client/_ver.py

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

{naeural_client-2.1.2 → naeural_client-2.1.3}/naeural_client/base/generic_session.py

@@ -1717,7 +1717,7 @@ class GenericSession(BaseDecentrAIObject):
       *,
       node,
       name,
-      signature=PLUGIN_SIGNATURES.BASIC_TELEGRAM_BOT_01,
+      signature=PLUGIN_SIGNATURES.TELEGRAM_BASIC_BOT_01,
       message_handler=None,
       telegram_bot_token=None,
       telegram_bot_token_env_key=ENVIRONMENT.TELEGRAM_BOT_TOKEN_ENV_KEY,
@@ -1725,7 +1725,41 @@ class GenericSession(BaseDecentrAIObject):
       telegram_bot_name_env_key=ENVIRONMENT.TELEGRAM_BOT_NAME_ENV_KEY,
       **kwargs
     ):
+      """
+      Create a new basic Telegram bot on a node.
+      
+      Parameters
+      ----------
       
+      node : str
+          Address or Name of the Naeural Edge Protocol edge node that will handle this Telegram bot.
+          
+      name : str
+          Name of the Telegram bot. 
+          
+      signature : str, optional 
+          The signature of the plugin that will be used. Defaults to PLUGIN_SIGNATURES.TELEGRAM_BASIC_BOT_01.
+          
+      message_handler : callable, optional  
+          The message handler function that will be called when a message is received. Defaults to None.
+          
+      telegram_bot_token : str, optional  
+          The Telegram bot token. Defaults to None.
+          
+      telegram_bot_token_env_key : str, optional
+          The environment variable key that holds the Telegram bot token. Defaults to ENVIRONMENT.TELEGRAM_BOT_TOKEN_ENV_KEY.
+          
+      telegram_bot_name : str, optional
+          The Telegram bot name. Defaults to None.
+          
+      telegram_bot_name_env_key : str, optional 
+          The environment variable key that holds the Telegram bot name. Defaults to ENVIRONMENT.TELEGRAM_BOT_NAME_ENV_KEY.
+          
+      Returns
+      -------
+      tuple 
+          `Pipeline` and a `Instance` objects tuple.
+      """
       assert callable(message_handler), "The `message_handler` method parameter must be provided."
       
       if telegram_bot_token is None:
@@ -1765,6 +1799,115 @@ class GenericSession(BaseDecentrAIObject):
       )      
       return pipeline, instance
     
+    
+    def create_telegram_conversational_bot(
+      self,
+      *,
+      node,
+      name,
+      signature=PLUGIN_SIGNATURES.TELEGRAM_CONVERSATIONAL_BOT_01,
+      telegram_bot_token=None,
+      telegram_bot_token_env_key=ENVIRONMENT.TELEGRAM_BOT_TOKEN_ENV_KEY,
+      telegram_bot_name=None,
+      telegram_bot_name_env_key=ENVIRONMENT.TELEGRAM_BOT_NAME_ENV_KEY,
+      
+      system_prompt=None,
+      agent_type="API",
+      api_token_env_key=ENVIRONMENT.TELEGRAM_API_AGENT_TOKEN_ENV_KEY,
+      api_token=None,
+      rag_source_url=None,
+      **kwargs
+    ):
+      
+      """
+      Create a new conversational Telegram bot on a node.
+      
+      Parameters
+      ----------
+      
+      node : str
+          Address or Name of the Naeural Edge Protocol edge node that will handle this Telegram bot.
+          
+      name : str
+          Name of the Telegram bot. 
+          
+      signature : str, optional 
+          The signature of the plugin that will be used. Defaults to PLUGIN_SIGNATURES.TELEGRAM_BASIC_BOT_01.
+          
+      telegram_bot_token : str, optional  
+          The Telegram bot token. Defaults to None.
+          
+      telegram_bot_token_env_key : str, optional
+          The environment variable key that holds the Telegram bot token. Defaults to ENVIRONMENT.TELEGRAM_BOT_TOKEN_ENV_KEY.
+          
+      telegram_bot_name : str, optional
+          The Telegram bot name. Defaults to None.
+          
+      telegram_bot_name_env_key : str, optional 
+          The environment variable key that holds the Telegram bot name. Defaults to ENVIRONMENT.TELEGRAM_BOT_NAME_ENV_KEY.
+          
+      system_prompt : str, optional
+          The system prompt. Defaults to None.
+          
+      agent_type : str, optional
+          The agent type. Defaults to "API".
+          
+      api_token_env_key : str, optional
+          The environment variable key that holds the API token. Defaults to ENVIRONMENT.TELEGRAM_API_AGENT_TOKEN_ENV_KEY.
+          
+      api_token : str, optional 
+          The API token. Defaults to None.
+          
+      rag_source_url : str, optional
+          The RAG database source URL upon which the bot will be able to generate responses. Defaults to None.
+          
+      Returns
+      -------
+      tuple 
+          `Pipeline` and a `Instance` objects tuple.
+      """      
+      if agent_type == "API":
+        if api_token is None:
+          api_token = os.getenv(api_token_env_key)
+          if api_token is None:
+            message = f"Warning! No API token provided as via env {ENVIRONMENT.TELEGRAM_API_AGENT_TOKEN_ENV_KEY} or explicitly as `api_token` param."
+            raise ValueError(message)
+      
+      if telegram_bot_token is None:
+        telegram_bot_token = os.getenv(telegram_bot_token_env_key)
+        if telegram_bot_token is None:
+          message = f"Warning! No Telegram bot token provided as via env {ENVIRONMENT.TELEGRAM_BOT_TOKEN_ENV_KEY} or explicitly as `telegram_bot_token` param."
+          raise ValueError(message)
+        
+      if telegram_bot_name is None:
+        telegram_bot_name = os.getenv(telegram_bot_name_env_key)
+        if telegram_bot_name is None:
+          message = f"Warning! No Telegram bot name provided as via env {ENVIRONMENT.TELEGRAM_BOT_NAME_ENV_KEY} or explicitly as `telegram_bot_name` param."
+          raise ValueError(message)
+      
+
+      pipeline: Pipeline = self.create_pipeline(
+        node=node,
+        name=name,
+        # default TYPE is "Void"
+      )
+      
+      
+      obfuscated_token = telegram_bot_token[:4] + "*" * (len(telegram_bot_token) - 4)      
+      self.P(f"Creating telegram bot {telegram_bot_name} with token {obfuscated_token}...", color='b')      
+      instance = pipeline.create_plugin_instance(
+        signature=signature,
+        instance_id=self.log.get_unique_id(),
+        telegram_bot_token=telegram_bot_token,
+        telegram_bot_name=telegram_bot_name,
+        system_prompt=system_prompt,
+        agent_type=agent_type,
+        api_token=api_token,
+        rag_source_url=rag_source_url,
+        **kwargs
+      )      
+      return pipeline, instance    
+    
 
     def broadcast_instance_command_and_wait_for_response_payload(
       self,

{naeural_client-2.1.2 → naeural_client-2.1.3}/naeural_client/const/apps.py

@@ -7,5 +7,6 @@ class PLUGIN_SIGNATURES:
   VIEW_SCENE_01 = 'VIEW_SCENE_01'
   CUSTOM_WEB_APP_01 = 'CUSTOM_CODE_FASTAPI_01'
   CHAIN_DIST_CUSTOM_JOB_01 = 'PROCESS_REAL_TIME_COLLECTED_DATA_CUSTOM_EXEC_CHAIN_DIST'
-  BASIC_TELEGRAM_BOT_01 = 'BASIC_TELEGRAM_BOT_01'  
+  TELEGRAM_BASIC_BOT_01 = 'TELEGRAM_BASIC_BOT_01'  
+  TELEGRAM_CONVERSATIONAL_BOT_01 = 'TELEGRAM_CONVERSATIONAL_BOT_01'
   # INSERT_NEW_PLUGIN_HERE

{naeural_client-2.1.2 → naeural_client-2.1.3}/naeural_client/const/environment.py

@@ -31,3 +31,5 @@ class ENVIRONMENT:
   
   TELEGRAM_BOT_TOKEN_ENV_KEY = 'TELEGRAM_BOT_TOKEN'
   TELEGRAM_BOT_NAME_ENV_KEY = 'TELEGRAM_BOT_NAME'
+  
+  TELEGRAM_API_AGENT_TOKEN_ENV_KEY = 'TELEGRAM_API_AGENT_TOKEN'

{naeural_client-2.1.2 → naeural_client-2.1.3}/naeural_client/default/instance/__init__.py

@@ -2,7 +2,7 @@ from .net_mon_01_plugin import NetMon01
 from .view_scene_01_plugin import ViewScene01
 from .custom_web_app_01_plugin import CustomWebApp01
 from .chain_dist_custom_job_01_plugin import ChainDistCustomJob01
-from .basic_telegram_bot_01_plugin import BasicTelegramBot01
+from .telegram_basic_bot_01_plugin import BasicTelegramBot01
 
 
 class PLUGIN_TYPES:
@@ -13,4 +13,4 @@ class PLUGIN_TYPES:
   VIEW_SCENE_01 = ViewScene01
   CUSTOM_WEB_APP_01 = CustomWebApp01
   CHAIN_DIST_CUSTOM_JOB_01 = ChainDistCustomJob01
-  BASIC_TELEGRAM_BOT_01 = BasicTelegramBot01
+  TELEGRAM_BASIC_BOT_01 = BasicTelegramBot01

naeural_client-2.1.2/naeural_client/default/instance/basic_telegram_bot_01_plugin.py → naeural_client-2.1.3/naeural_client/default/instance/telegram_basic_bot_01_plugin.py

@@ -2,6 +2,6 @@ from ...base import Instance
 from ...const import PLUGIN_SIGNATURES
 
 class BasicTelegramBot01(Instance):
-  signature = PLUGIN_SIGNATURES.BASIC_TELEGRAM_BOT_01
+  signature = PLUGIN_SIGNATURES.TELEGRAM_BASIC_BOT_01
 
 

naeural_client-2.1.3/naeural_client/default/instance/telegram_conversational_bot_01_plugin.py

@@ -0,0 +1,7 @@
+from ...base import Instance
+from ...const import PLUGIN_SIGNATURES
+
+class TelegramConversationalBot01(Instance):
+  signature = PLUGIN_SIGNATURES.TELEGRAM_CONVERSATIONAL_BOT_01
+
+

{naeural_client-2.1.2 → naeural_client-2.1.3}/pyproject.toml

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

{naeural_client-2.1.2 → naeural_client-2.1.3}/tutorials/ex10_telegram_echo_bot.py

@@ -19,21 +19,14 @@ if __name__ == "__main__":
   my_node = os.getenv("TARGET_NODE") # we can specify a node here, if we want to connect to a specific
     
   session = Session() # assume .env is available and will be used for the connection and tokens
-  time.sleep(10) # wait 10 sec to collect network status
-  
-  if my_node:
-    node = my_node
-    session.P(f"Using the specified node: {node}", color='b')
-  else:
-    session.wait_for_any_node() # we wait for any node to present itself as active
-    node = session.get_active_nodes()[0] # we get the first active node
-  
+  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
-  # instance: PLUGIN_TYPES.BASIC_TELEGRAM_BOT_01  
+  # instance: PLUGIN_TYPES.TELEGRAM_BASIC_BOT_01  
   pipeline, _ = session.create_telegram_simple_bot(
-    node=node,
+    node=my_node,
     name="telegram_bot_echo",
     # telegram_bot_token=os.getenv("TELEGRAM_BOT_TOKEN"),  # we use the token directly
     # telegram_bot_token_env_key=TELEGRAM_BOT_TOKEN_ENV_KEY, # not mandatory - we can use the default

naeural_client-2.1.3/tutorials/ex11_telegram_smart_bot.py

@@ -0,0 +1,48 @@
+import os
+import time
+
+from naeural_client import Session, CustomPluginTemplate
+
+if __name__ == "__main__":
+  my_node = os.getenv("TARGET_NODE") # we specify a node here
+  
+  if my_node is None:
+    print("Please specify the node to connect to.")
+    exit(1)
+  
+  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
+  pipeline, _ = session.create_telegram_conversational_bot(
+    node=my_node,
+    name="telegram_chatbot",
+
+    # telegram_bot_token=None,    # not mantatory - can be used to specify the token directly
+    # 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"
+    # 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
+  )
+  
+  pipeline.deploy() # we deploy the pipeline
+
+  # # Observation:
+  # #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  # #   in production, you would not need this code as the script can close after the pipeline will be sent  
+  # session.run(
+  #   wait=60,  # we run the session for 60 seconds
+  #   close_pipelines=True,  # we close the pipelines after the session
+  #   close_session=True,  # we close the session after the session
+  # )

naeural_client-2.1.2/tutorials/ex11_telegram_smart_bot.py

@@ -1,44 +0,0 @@
-import os
-
-from naeural_client import Session, CustomPluginTemplate, PLUGIN_TYPES
-
-if __name__ == "__main__":
-  # TELEGRAM_BOT_TOKEN_ENV_KEY = "TELEGRAM_BOT_TOKEN" # we can specify the token here
-  MY_NODE = None # we can specify a node here, if we want to connect to a specific
-  
-  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
-
-  if MY_NODE:
-    node = MY_NODE
-  else:
-    session.wait_for_any_node() # we wait for any node to present itself as active
-    node = session.get_active_nodes()[0] # we get the first active node
-  
-      
-  # now we create a telegram bot pipeline & plugin instance
-  # we can chose to use the token directly or use the environment key
-  # instance: PLUGIN_TYPES.BASIC_TELEGRAM_BOT_01
-  pipeline, _ = session.create_telegram_conversational_bot(
-    node=node,
-    name="telegram_bot_echo",
-    # telegram_bot_token_env_key=TELEGRAM_BOT_TOKEN_ENV_KEY, # this is not mandatory
-    system_prompt=SYSTEM_PROMPT, # simple bot based on system prompt only
-    # rag_source=rag_db_url,    # advanced 
-    # bot_type="API" # "API", "HOSTED"
-    # api_token_env_key="BOT_API_TOKEN", # if bot_type is "API" - this is a default
-  )
-  
-  pipeline.deploy() # we deploy the pipeline
-
-  # # Observation:
-  # #   next code is not mandatory - it is used to keep the session open and cleanup the resources
-  # #   in production, you would not need this code as the script can close after the pipeline will be sent  
-  # session.run(
-  #   wait=60,  # we run the session for 60 seconds
-  #   close_pipelines=True,  # we close the pipelines after the session
-  #   close_session=True,  # we close the session after the session
-  # )