creating the first version

Messaging_system/DataCollector.py

@@ -25,8 +25,7 @@ class DataCollector:
         # selecting a sample of users
         self.select_sample()
 
-        if self.Core.personalization:
-            self.fetch_data()
+        self.fetch_data()
 
         # calculate the remaining days to their birthday
         self.remaining_days_to_birthday()

Messaging_system/Message_generator.py

@@ -184,70 +184,12 @@ class MessageGenerator:
 
         jargon_list = "\n".join(f"- {word}" for word in self.Core.config_file["AI_Jargon"])
 
-        # instructions = f"""
-        # You are a copywriter. Your task is to write a 'header' and a 'message' as a push notification for a {self.Core.get_instrument()} student that sounds like natural everyday speech: friendly, concise, no jargon, and following the instructions.
-        # Write a SUPER CASUAL and NATURAL push notification, as if you are chatting over coffee. Avoid odd phrasings.
-        #
-        # ABSOLUTE RULE – OVERRIDES EVERYTHING ELSE:
-        # the header and the message **MUST NOT** contain any banned word or phrases(case-insensitive; singular, plural, verb forms, or their derivatives)
-        #
-        # Banned word:
-        # {jargon_list}
-        #
-        # Banned phrases:
-        # Voice is NOT an instrument, so avoid phrases like below:
-        # - Your voice is waiting
-        # - Your voice awaits
-        # - Your voice needs you
-        # - Your voice is calling
-        # - Your voice deserves more
-        # - Hit the high notes / Hit those notes
-        # - ...
-        # """
-
         instructions = f"""
 
-You are a copywriter. Your task is to write a 'header' and a 'message' as a push notification for a {self.Core.get_instrument()} student. It is critical  that the message sounds like natural, everyday speech: friendly, concise, no jargon, and it must follow the instructions.
-Write a SUPER CASUAL and NATURAL push notification, as if you are chatting over coffee. Avoid odd phrasings. The message should sound like something that a {self.Core.get_instrument()} instructor would realistically say to a student in a daily conversation. Here are some examples of things that an instructor would realistically say to a student, to give you a general sense of tone and phrasing:
-
-Common instructor phrases:
-{self.Core.brand_voice}
-
-
-ABSOLUTE RULE – OVERRIDES EVERYTHING ELSE:  
-the header and the message **MUST NOT** contain any banned word or phrases(case-insensitive; singular, plural, verb forms, or their derivatives)
-
-Banned word:
-{jargon_list}
-
-Banned phrases:
-Voice is NOT an instrument, so avoid phrases like below:
-- Your voice is waiting
-- Your voice awaits
-- Your voice needs you
-- Your voice is calling
-- Your voice deserves more
-- Hit the high notes / Hit those notes
-- ...
-
-"""
+You are a copywriter. Your task is to select and/or modify available push notifications to output the best 'header' and a 'message' for a {self.Core.get_instrument()} student. 
+You should strictly follow the available options to select the proper header and message.
+In case of any personalization, you should modify the original header and message very minimal, without changing the style, content and characteristic of the original header and message.
 
-        banned = """
-ABSOLUTE RULE – OVERRIDES EVERYTHING ELSE:  
-the header and the message **MUST NOT** contain any banned word or phrases(case-insensitive; singular, plural, verb forms, or their derivatives)
-
-Banned word:
-{jargon_list}
-
-Banned phrases:
-Voice is NOT an instrument, so avoid phrases like below:
-- Your voice is waiting
-- Your voice awaits
-- Your voice needs you
-- Your voice is calling
-- Your voice deserves more
-- Hit the high notes / Hit those notes
-- ...
 """
 
         return instructions

Messaging_system/MultiMessage.py

@@ -128,13 +128,10 @@ class MultiMessage:
 
         if self.Core.subsequent_examples is not None:
 
-            instructions = f"""
-# ** Example **
-Below are some acceptable examples of the voice we want. Create a header and message that follow the same style, tone, vocabulary, and characteristics.
-Mimic the example style as much as possible and make it personalized using provided information.
-   
 
-### **Good Examples:**
+            instructions = f"""
+Below are the available options to choose for the push notification: 
+### **Available options:**
 
     {self.Core.subsequent_examples[step]} 
 """
@@ -142,6 +139,7 @@ Mimic the example style as much as possible and make it personalized using provi
         else:
             return ""
 
+
     # --------------------------------------------------------------
     def generate_prompt(self, previous_messages, step, user):
         """
@@ -164,9 +162,7 @@ Mimic the example style as much as possible and make it personalized using provi
 
         user_info = self.promptGen.get_user_profile(user=user)
         input_context = self.promptGen.input_context()
-        output_instructions = self.output_instruction()
-        general_specifications = self.general_specifications()
-
+        output_instructions = self.promptGen.output_instruction()
         examples = self.get_examples(step)
 
 
@@ -177,74 +173,19 @@ We have previously sent these push notifications to the user and The user has no
 ** Previous messages **
 {previous_text_str}
 
-
-**Objective**  
-Write the *next* follow up personalized push notification following the instructions and what we know about the user.
 {input_context}
+- The new selection should be different from previous messages and we should not have similar words and phrases that we sent before.
 
 {user_info}
 
-### ** General Specifications: **
-
-{general_specifications}
-
-# **specific instructions**:         
-- {self.Core.subsequence_messages[step]} 
-
 {examples}
 
 {output_instructions}
 """
 
         return prompt
-    # ===========================================================================
-    def general_specifications(self):
-        """
-        general_specifications
-        :return: instructions
-        """
-
-        instructions = """
-- Start directly with the message content without greetings or closing phrases.
-- Avoid using same or similar words so close together in "message" and "header", and make sure there is no grammar problem.
-- message and header **MUST** be different from previous messages in terms of similar words, vocabulary and phrases. 
-- The message, vocabulary and sentences **MUST** sound like a natural conversation: something that people normally say in daily conversations.
-        
-        """
-        return instructions
 
     # =============================================================================
-
-    def output_instruction(self):
-        """
-        :return: output instructions as a string
-        """
-
-        # Provide constraints for our next push notification
-        header_limit = self.Core.config_file.get("header_limit", 50)
-        message_limit = self.Core.config_file.get("message_limit", 200)
-
-        general_instructions = f"""
-- The "header" must be less than {header_limit} character. 
-- The "message" must be less than {message_limit} character.
-- Don't use emoji if we used emoji in our previous messages., 
-- if we didn't have emojis in previous message, you are **ONLY ALLOWED** to use {self.Core.get_emoji()} emoji if needed. (ONLY ONCE, and ONLY at the end of header or message).
-- Ensure that the output is a valid JSON and not include any text outside the JSON code block.
-"""
-
-        instructions = f"""
-Expected output structure:
-
-{{
-  "header": "Generated title",
-  "message": "Generated message",
-}}
-
-{general_instructions}
-"""
-        return instructions
-
-    # --------------------------------------------------------------
     def parsing_output_message(self, message, user):
         """
         Parses the output JSON from the LLM and enriches it with additional content
@@ -339,72 +280,11 @@ Expected output structure:
 
         jargon_list = "\n".join(f"- {word}" for word in self.Core.config_file["AI_Jargon"])
 
-        # instructions = f"""
-        # You are a copywriter. Your task is to write a 'header' and a 'message' as a push notification for a {self.Core.get_instrument()} student that sounds like natural everyday speech: friendly, concise, no jargon, and following the instructions.
-        # Write a SUPER CASUAL and NATURAL push notification, as if you are chatting over coffee. Avoid odd phrasings.
-        #
-        # ABSOLUTE RULE – OVERRIDES EVERYTHING ELSE:
-        # the header and the message **MUST NOT** contain any banned word or phrases (case-insensitive; singular, plural, verb forms, or their derivatives)
-        #
-        # Banned word:
-        # {jargon_list}
-        #
-        # Banned phrases:
-        # Voice is NOT an instrument, so avoid phrases like below:
-        # - Your voice is waiting
-        # - Your voice awaits
-        # - Your voice needs you
-        # - Your voice is calling
-        # - Your voice deserves more
-        # - Hit the high notes / Hit those notes
-        # - ...
-        #
-        # """.strip()
-
-
         instructions = f"""
-        
-You are a copywriter. Your task is to write a 'header' and a 'message' as a push notification for a {self.Core.get_instrument()} student. It is critical  that the message sounds like natural, everyday speech: friendly, concise, no jargon, and it must follow the instructions.
-Write a SUPER CASUAL and NATURAL push notification, as if you are chatting over coffee. Avoid odd phrasings. The message should sound like something that a {self.Core.get_instrument()} instructor would realistically say to a student. Here are some examples of things that an instructor would realistically say to a student, to give you a general sense of tone and phrasing:
-
-Common instructor phrases:
-{self.Core.brand_voice}
-
-ABSOLUTE RULE – OVERRIDES EVERYTHING ELSE:  
-the header and the message **MUST NOT** contain any banned word or phrases(case-insensitive; singular, plural, verb forms, or their derivatives)
-
-Banned word:
-{jargon_list}
-
-Banned phrases:
-Voice is NOT an instrument, so avoid phrases like below:
-- Your voice is waiting
-- Your voice awaits
-- Your voice needs you
-- Your voice is calling
-- Your voice deserves more
-- Hit the high notes / Hit those notes
-- ...
-        
-        """
 
-        banned = """
-ABSOLUTE RULE – OVERRIDES EVERYTHING ELSE:  
-the header and the message **MUST NOT** contain any banned word or phrases(case-insensitive; singular, plural, verb forms, or their derivatives)
-
-Banned word:
-{jargon_list}
-
-Banned phrases:
-Voice is NOT an instrument, so avoid phrases like below:
-- Your voice is waiting
-- Your voice awaits
-- Your voice needs you
-- Your voice is calling
-- Your voice deserves more
-- Hit the high notes / Hit those notes
-- ...
-        
+        You are a copywriter. Your task is to select and/or modify available push notifications to output the best 'header' and a 'message' for a {self.Core.get_instrument()} student. 
+        You should strictly follow the available options to select the proper header and message.
+        In case of any personalization, you should modify the original header and message very minimal, without changing the style, content and characteristic of the original header and message.
         """
 
 

Messaging_system/PromptGenerator.py

@@ -84,24 +84,16 @@ Here is the information about the user:
         input_context = self.input_context()
         user_info = self.get_user_profile(user=user)
 
-        # personalize_message_instructions = self.personalize_message_instructions(user)
-        # {personalize_message_instructions}
-
-        general_instructions = self.message_type_instructions()
+        example_output = self.example_output()
 
         output_instructions = self.output_instruction()
 
-        # task_instructions = self.task_instructions()
-        # eliminate {task_instructions} and  {recommendations_instructions}
-
         prompt = f"""
 {input_context}
 
 {user_info}
 
-{cta}
-
-{general_instructions}
+{example_output}
 
 {output_instructions}
     """
@@ -116,48 +108,13 @@ Here is the information about the user:
         """
 
         context = f"""
+### Task
 Your task is to pick a 'header' and a 'message' as a push notification from provided options for a {self.Core.get_instrument()} student.
 
         """
 
         return context
 
-    # --------------------------------------------------------------
-    # --------------------------------------------------------------
-    def CTA_instructions(self):
-        """
-        define CTA instructions
-        :return: CTA instructions (str)
-        """
-
-        instructions = f"""
-
-### **Main instructions**
-
-{self.Core.CTA} \n
-    """
-
-        return instructions
-
-    # --------------------------------------------------------------
-    # --------------------------------------------------------------
-    def user_additional_info(self, user):
-        """
-        providing additional information given in the input data
-        :param user:
-        :return:
-        """
-
-        if "additional_info" not in user.index:
-            return ""
-
-        if pd.notna(user["additional_info"]) and user["additional_info"] not in [None, [], {}] and (
-                not isinstance(user["additional_info"], str) or user["additional_info"].strip()):
-            additional_info = user["additional_info"]
-        else:
-            additional_info = ""
-
-        return additional_info
 
     # --------------------------------------------------------------
     # --------------------------------------------------------------
@@ -280,63 +237,6 @@ Your task is to pick a 'header' and a 'message' as a push notification from prov
 
         return final_instructions
 
-    # --------------------------------------------------------------
-    # --------------------------------------------------------------
-
-    def message_type_instructions(self):
-        """
-        create a proper instruction for the message type, regarding the input platform
-        :return: message instructions as a string
-        """
-
-        instructions = ""
-        message_style = self.message_style_instructions()
-
-        if self.Core.platform == "push":
-            instructions = f""" 
-### ** General Specifications: **
-
-- Start directly with the message content without greetings or closing phrases.
-- Avoid using same or similar words so close together in "message" and "header", and make sure there is no grammar problem.
-- The message, vocabulary and sentences **MUST** sound like a natural conversation: something that people normally say in daily conversations.
-- {message_style}
-
-    """
-
-
-        elif self.Core.platform == "app":
-            instructions = f""" 
-    Message Specifications:
-    - The message is an **in app notification**.
-    - ** Keep the First sentence as "header" that should be a short personalized eye catching sentence less than 40 character **. 
-    - ** For the "header", don't use exclamation mark at the end, instead, use a space following with a proper emoji at the end of the "header" (e.g. Great work John 😍) **
-    - **Keep the message concise and straightforward**.
-    - **Start directly with the message content**; do not include greetings (e.g., "Hello") or closing phrases.
-    - Make the message highly **personalized** and **eye-catching**.
-        - "Personalized" means the user should feel the message is specifically crafted for them and not generic.
-    - **Every word should contribute to maximizing impact and engagement**.
-    - {message_style}
-            """
-
-        return instructions
-
-    # --------------------------------------------------------------
-    # --------------------------------------------------------------
-    def message_style_instructions(self):
-        """
-        defines the style of the message: e.g. friendly, kind, tone, etc.
-        :return: style_instructions(str)
-        """
-
-        if self.Core.message_style is None:
-            message_style = ""
-
-        else:
-            message_style = f"""
-        - {self.Core.message_style}.  
-        """
-
-        return message_style
 
     # --------------------------------------------------------------
     # --------------------------------------------------------------
@@ -345,33 +245,25 @@ Your task is to pick a 'header' and a 'message' as a push notification from prov
         :return: output instructions as a string
         """
 
-        example_output = self.example_output()
         general_instructions = f"""
-- The "header" must be less than 30 character. 
-- The "message" must be less than 100 character.
-- Preserve special characters and emojis in the message, you are **ONLY ALLOWED**allowed to use {self.Core.get_emoji()} emoji if needed, ONLY ONCE, and ONLY at the end of header or message).
-- Ensure that the output is a valid JSON and not include any text outside the JSON code block.
+- The "header" < 30 and "message" < 100 characters. 
+- Ensure that the output is a valid JSON following above structure.
         """
 
         instructions = f"""
-Expected output structure:
+### **Output instructions**:
+
+**Expected output structure:**
 
 {{
-  "header": "Generated title",
-  "message": "Generated message",
+  "header": "selected header from options",
+  "message": "selected message from options",
 }}
 
 {general_instructions}
     """
 
-        output_instructions = f"""
-### **Output instructions**:
-
-{example_output}
-{instructions}
-        """
-
-        return output_instructions
+        return instructions
 
     # --------------------------------------------------------------
     # --------------------------------------------------------------
@@ -388,10 +280,10 @@ Expected output structure:
         else:
             # one shot prompting
             example = f"""
-    Below are some acceptable examples. Create a header and message that follows the same style, tone, vocabulary, and characteristics of followed examples.
+Below are the available options to choose for the push notification: 
 
-    ### **Good Examples:**
-    {self.Core.sample_example}
+### **Available options:**
+{self.Core.sample_example}
     """
 
             return example