naeural-client 2.1.2__py3-none-any.whl → 2.1.4__py3-none-any.whl

naeural_client/_ver.py

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

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/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/const/base.py

@@ -2,6 +2,17 @@ EE_ID = 'EE_ID'
 SB_ID = 'SB_ID'  # change to SB_ID = EE_ID post mod from sb to ee
 
 
+class DCT_TYPES:
+  VOID_PIPELINE = 'Void'
+  NETWORK_LISTENER = 'NetworkListener'
+  METASTREAM_PIPELINE = 'MetaStream'
+  
+  
+class DCT_OPTIONS:
+  NETWORK_LISTENER_PATH_FILTER = "PATH_FILTER"
+  NETWORK_LISTENER_MESSAGE_FILTER = "MESSAGE_FILTER"
+  ADMIN_PIPELINE_VER = 'ADMIN_PIPELINE_VER'
+
 class CONFIG_STREAM:
   K_URL = 'URL'
   K_TYPE = 'TYPE'
@@ -22,7 +33,7 @@ class CONFIG_STREAM:
   K_PIPELINE_COMMAND = 'PIPELINE_COMMAND'
   K_USE_LOCAL_COMMS_ONLY = 'USE_LOCAL_COMMS_ONLY'
 
-  METASTREAM = 'MetaStream'
+  METASTREAM = DCT_TYPES.METASTREAM_PIPELINE
 
   INITIATOR_ID = K_INITIATOR_ID
   SESSION_ID = K_SESSION_ID
@@ -53,10 +64,14 @@ class CONFIG_STREAM:
 
   MANDATORY = [K_NAME, K_TYPE]
 
-  VOID_STREAM = 'VOID'
+  VOID_STREAM = DCT_TYPES.VOID_PIPELINE
+  
+  DEFAULT_ADMIN_PIPELINE_TYPE = DCT_TYPES.NETWORK_LISTENER
 
   NO_DATA_STREAMS = [VOID_STREAM]
-
+  
+  PIPELINE_OPTIONS = DCT_OPTIONS
+  PIPELINE_TYPES = DCT_TYPES
 
 class BIZ_PLUGIN_DATA:
   INSTANCE_ID = 'INSTANCE_ID'

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/const/payload.py

@@ -181,6 +181,8 @@ class PAYLOAD_DATA:
   EE_SENDER = BC_CT.SENDER
   EE_HASH = BC_CT.HASH
   EE_SIGN = BC_CT.SIGN
+  
+  EE_DESTINATION = "EE_DEST"
 
   NOTIFICATION = 'NOTIFICATION'
   INFO = 'INFO'
@@ -188,3 +190,5 @@ class PAYLOAD_DATA:
   TAGS = 'TAGS'
 
   ID_TAGS = 'ID_TAGS'
+  
+  

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/default/instance/{basic_telegram_bot_01_plugin.py → 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/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.dist-info → naeural_client-2.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: naeural_client
-Version: 2.1.2
+Version: 2.1.4
 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.dist-info → naeural_client-2.1.4.dist-info}/RECORD

@@ -1,10 +1,10 @@
 naeural_client/__init__.py,sha256=UKEDGS0wFYyxwmhEAKJGecO2vYbIfRYUP4SQgnK10IE,578
-naeural_client/_ver.py,sha256=aZEmCx4AtKydTHCcglvjwC1deqUrkwRDirx73Nslguk,330
+naeural_client/_ver.py,sha256=xBEfgRn61jifjfZ85domduA0fNz-XprciKiFP-TRh_M,330
 naeural_client/base_decentra_object.py,sha256=qDBpitcyhr1eEXPD8cGFtcNPNf71fqNRsmOEcCpx4sM,4180
 naeural_client/plugins_manager_mixin.py,sha256=X1JdGLDz0gN1rPnTN_5mJXR8JmqoBFQISJXmPR9yvCo,11106
 naeural_client/base/__init__.py,sha256=hACh83_cIv7-PwYMM3bQm2IBmNqiHw-3PAfDfAEKz9A,259
 naeural_client/base/distributed_custom_code_presets.py,sha256=cvz5R88P6Z5V61Ce1vHVVh8bOkgXd6gve_vdESDNAsg,2544
-naeural_client/base/generic_session.py,sha256=o5pWWvWPSqZQ15y6YdPdfeSDolos_xa0ufiwMHetGqk,70519
+naeural_client/base/generic_session.py,sha256=BtpuXJFZgFESHwvzJp1XYw687u2OiP72A-NBaLRFN7s,75929
 naeural_client/base/instance.py,sha256=kcZJmjLBtx8Bjj_ysIOx1JmLA-qSpG7E28j5rq6IYus,20444
 naeural_client/base/pipeline.py,sha256=KwcPWD2XMvHotWFMpcnIycFhqiNnZuyUTUWiLU0PM5Y,57519
 naeural_client/base/plugin_template.py,sha256=qGaXByd_JZFpjvH9GXNbT7KaitRxIJB6-1IhbKrZjq4,138123
@@ -26,20 +26,21 @@ naeural_client/comm/amqp_wrapper.py,sha256=hzj6ih07DnLQy2VSfA88giDIFHaCp9uSdGLTA
 naeural_client/comm/mqtt_wrapper.py,sha256=Ig3bFZkCbWd4y_Whn2PPa91Z3aLgNbNPau6Tn5yLPZ8,16167
 naeural_client/const/README.md,sha256=6OHesr-f5NBuuJGryEoi_TCu2XdlhfQYlDKx_IJoXeg,177
 naeural_client/const/__init__.py,sha256=G7Fa50SpEhAPOnL8_mxgVmJ0Xq1qEncWd75pg2BkiG4,416
-naeural_client/const/apps.py,sha256=i0MNCM1Wf7QUCB4OKO1vGNUonPs6EsnZV6-XZjknppw,439
-naeural_client/const/base.py,sha256=V94oaT7xYrrTGxmLJlynxmbFujVX0G9wIfC8TilH5MU,2548
+naeural_client/const/apps.py,sha256=TJpbD7-1tIKxMdpVgZMHOka1k7a6vtW45rQL87K-jvE,507
+naeural_client/const/base.py,sha256=HrvXVYS1HMEh0zKZ3VUue-hTdcXEFZ1ukhlbP9kbVWE,2996
 naeural_client/const/comms.py,sha256=La6JXWHexH8CfcBCKyT4fCIoeaoZlcm7KtZ57ab4ZgU,2201
-naeural_client/const/environment.py,sha256=1yM4HDX36Evi0fjLou9eHWlO8ywyOhFCqx-pXYfiYPs,803
+naeural_client/const/environment.py,sha256=iytmTDgbOjvORPwHQmc0K0r-xJx7dnnzNnqAJJiFCDA,870
 naeural_client/const/formatter.py,sha256=AW3bWlqf39uaqV4BBUuW95qKYfF2OkkU4f9hy3kSVhM,200
 naeural_client/const/heartbeat.py,sha256=jGHmKfeHTFOXJaKUT3o_ocnQyF-EpcLeunW-ifkYKfU,2534
 naeural_client/const/misc.py,sha256=1ypROmZsOyp_8zG2LARwPeo-YfXuyYqZnml0elTP4kw,211
-naeural_client/const/payload.py,sha256=k24vH9iJIBBPnCXx7HAEuli2fNAETK7h8ZuVKyKLgbk,5725
+naeural_client/const/payload.py,sha256=jBzXQZ-jQ1Ft6eRsb8WvT-OPpQd1j4Y-uu_V26-EY0Y,5763
 naeural_client/default/__init__.py,sha256=ozU6CMMuWl0LhG8Ae3LrZ65a6tLrptfscVYGf83zjxM,46
-naeural_client/default/instance/__init__.py,sha256=pHR9_5t3xv9ug3nu-8202yW-rqq-KR3C_L5N2xaADTA,548
-naeural_client/default/instance/basic_telegram_bot_01_plugin.py,sha256=4674YFg5DfGO8_bYA1Uo77duZgKYGFX1J0Xp8YzjyPM,161
+naeural_client/default/instance/__init__.py,sha256=Itb4l6_DR6CCw8KAxyQKlCmALyzDasNHIfM9VB-Umak,548
 naeural_client/default/instance/chain_dist_custom_job_01_plugin.py,sha256=QtHi3uXKsVs9eyMgbnvBVbMylErhV1Du4X2-7zDL7Y0,1915
 naeural_client/default/instance/custom_web_app_01_plugin.py,sha256=ZDe-QXmr6KLyUx5wzA3xVrMPg8yHnWLUbGjZtB0PFgg,4785
 naeural_client/default/instance/net_mon_01_plugin.py,sha256=u85i2AiYHkLJnam0wOx-m71hlp0EYyNtk3JwbkOrvHg,1208
+naeural_client/default/instance/telegram_basic_bot_01_plugin.py,sha256=P_W2K_ng7svbhoIoYGvkGxa4v9UUoxuOAAgtoM36wDo,161
+naeural_client/default/instance/telegram_conversational_bot_01_plugin.py,sha256=XkyE-uNbtFnTSGA1nOf-XNmUipAUjhg0xXV1glRb7gc,179
 naeural_client/default/instance/view_scene_01_plugin.py,sha256=5kMhd23kL5AYCdOJzrdCqi2ohoQNvmpv8oE6hWQtUWk,720
 naeural_client/default/session/mqtt_session.py,sha256=dpQcBhhVZDo458v0IqJMZb1CsTn-TxXhYjNlyJp9Rp8,2414
 naeural_client/io_formatter/__init__.py,sha256=_wy7c-Z9kgb26jN7uNTDq88G7xZ3wI_ObuQd3QWNPkQ,85
@@ -74,7 +75,7 @@ naeural_client/logging/tzlocal/windows_tz.py,sha256=Sv9okktjZJfRGGUOOppsvQuX_eXy
 naeural_client/utils/__init__.py,sha256=mAnke3-MeRzz3nhQvhuHqLnpaaCSmDxicd7Ck9uwpmI,77
 naeural_client/utils/comm_utils.py,sha256=4cS9llRr_pK_3rNgDcRMCQwYPO0kcNU7AdWy_LtMyCY,1072
 naeural_client/utils/dotenv.py,sha256=_AgSo35n7EnQv5yDyu7C7i0kHragLJoCGydHjvOkrYY,2008
-naeural_client-2.1.2.dist-info/METADATA,sha256=jz3-SkppEKJeRwqNP9KoSQ0E9NETayW7VLl6Nm3gxLU,14457
-naeural_client-2.1.2.dist-info/WHEEL,sha256=3U_NnUcV_1B1kPkYaPzN-irRckL5VW_lytn0ytO_kRY,87
-naeural_client-2.1.2.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
-naeural_client-2.1.2.dist-info/RECORD,,
+naeural_client-2.1.4.dist-info/METADATA,sha256=dG-mroHJtnAAOf0uWeUbCHLqcojvpZUA_dIBoaBKQ-w,14457
+naeural_client-2.1.4.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+naeural_client-2.1.4.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
+naeural_client-2.1.4.dist-info/RECORD,,

{naeural_client-2.1.2.dist-info → naeural_client-2.1.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.1
+Generator: hatchling 1.26.3
 Root-Is-Purelib: true
 Tag: py3-none-any