feat: resend example (#1416)

examples/resend_example/README.md

@@ -0,0 +1,91 @@
+# Sending emails with MemGPT using [Resend](https://resend.com/emails)
+
+## Defining the custom tool
+
+Create an account on [Resend](https://resend.com/emails) to get an API key.
+
+Once you have an API key, you can set up a custom tool using the `requests` API in Python to call the Resend API:
+```python
+import requests
+import json
+
+
+RESEND_API_KEY = "YOUR_RESEND_API_KEY"
+RESEND_TARGET_EMAIL_ADDRESS = "YOUR_EMAIL_ADDRESS"
+
+def send_email(self, description: str):
+    """
+    Sends an email to a predefined user. The email contains a message, which is defined by the description parameter.
+
+    Args:
+        description (str): Email contents. All unicode (including emojis) are supported.
+
+    Returns:
+        None
+
+    Example:
+        >>> send_email("hello")
+        # Output: None. This will send an email to the you are talking to with the message "hello".
+    """
+    url = "https://api.resend.com/emails"
+    headers = {"Authorization": f"Bearer {RESEND_API_KEY}", "Content-Type": "application/json"}
+    data = {
+        "from": "onboarding@resend.dev",
+        "to": RESEND_TARGET_EMAIL_ADDRESS,
+        "subject": "MemGPT message:",
+        "html": f"<strong>{description}</strong>",
+    }
+
+    try:
+        response = requests.post(url, headers=headers, data=json.dumps(data))
+        print(response.text)
+    except requests.HTTPError as e:
+        raise Exception(f"send_email failed with an HTTP error: {str(e)}")
+    except Exception as e:
+        raise Exception(f"send_email failed with an error: {str(e)}")
+```
+
+## Option 1 (dev portal)
+
+To create the tool in the dev portal, simply navigate to the tool creator tab, create a new tool called `send_email`, and copy-paste the above code into the code block area and press "Create Tool".
+
+<img width="500" alt="image" src="https://github.com/cpacker/MemGPT/assets/5475622/a21fce95-02a8-4aa8-89f5-3c520b6ff75e">
+
+Once you've created the tool, create a new agent and make sure to select `send_email` as an enabled tool.
+
+<img width="500" alt="image" src="https://github.com/cpacker/MemGPT/assets/5475622/124e2260-d435-465d-8971-e8ca5265d1bd">
+
+Now your agent should be able to call the `send_email` function when needed:
+
+<img width="500" alt="image" src="https://github.com/cpacker/MemGPT/assets/5475622/fdd2de45-13f7-4b8f-84a3-de92e5d2bd17">
+
+## Option 2 (CLI)
+
+Copy the custom function into the functions directory:
+```sh
+# If you use the *_env_vars version of the function, you will need to define `RESEND_API_KEY` and `RESEND_TARGET_EMAIL_ADDRESS` in your environment variables
+cp examples/resend_example/resend_send_email_env_vars.py ~/.memgpt/functions/
+```
+
+Create a preset that has access to that function:
+```sh
+memgpt add preset -f examples/resend_example/resend_preset.yaml --name resend_preset
+```
+
+Make sure we set the env vars:
+```sh
+export RESEND_API_KEY=re_YOUR_RESEND_KEY
+export RESEND_TARGET_EMAIL_ADDRESS="YOUR_EMAIL@gmail.com"
+```
+
+Create an agent with that preset (disable `--stream` if you're not using a streaming-compatible backend):
+```sh
+memgpt run --preset resend_preset --persona sam_pov --human cs_phd --stream
+```
+
+<img width="500" alt="image" src="https://github.com/cpacker/MemGPT/assets/5475622/61958527-20e7-461d-a6d2-a53f06493683">
+
+Waiting in our inbox:
+
+<img width="500" alt="image" src="https://github.com/cpacker/MemGPT/assets/5475622/95f9b24a-98c3-493a-a787-72a2a956641a">
+

examples/resend_example/resend_preset.yaml

@@ -0,0 +1,11 @@
+system_prompt: "memgpt_chat"
+functions:
+  - "send_message"
+  - "pause_heartbeats"
+  - "core_memory_append"
+  - "core_memory_replace"
+  - "conversation_search"
+  - "conversation_search_date"
+  - "archival_memory_insert"
+  - "archival_memory_search"
+  - "send_email"

examples/resend_example/resend_send_email_env_vars.py

@@ -0,0 +1,43 @@
+import json
+import os
+
+import requests
+
+
+def send_email(self, description: str):
+    """
+    Sends an email to a predefined user. The email contains a message, which is defined by the description parameter.
+
+    Args:
+        description (str): Email contents. All unicode (including emojis) are supported.
+
+    Returns:
+        None
+
+    Example:
+        >>> send_email("hello")
+        # Output: None. This will send an email to the you are talking to with the message "hello".
+    """
+    RESEND_API_KEY = os.getenv("RESEND_API_KEY")
+    RESEND_TARGET_EMAIL_ADDRESS = os.getenv("RESEND_TARGET_EMAIL_ADDRESS")
+    if RESEND_API_KEY is None:
+        raise Exception("User did not set the environment variable RESEND_API_KEY")
+    if RESEND_TARGET_EMAIL_ADDRESS is None:
+        raise Exception("User did not set the environment variable RESEND_TARGET_EMAIL_ADDRESS")
+
+    url = "https://api.resend.com/emails"
+    headers = {"Authorization": f"Bearer {RESEND_API_KEY}", "Content-Type": "application/json"}
+    data = {
+        "from": "onboarding@resend.dev",
+        "to": RESEND_TARGET_EMAIL_ADDRESS,
+        "subject": "MemGPT message:",
+        "html": f"<strong>{description}</strong>",
+    }
+
+    try:
+        response = requests.post(url, headers=headers, data=json.dumps(data))
+        print(response.text)
+    except requests.HTTPError as e:
+        raise Exception(f"send_email failed with an HTTP error: {str(e)}")
+    except Exception as e:
+        raise Exception(f"send_email failed with an error: {str(e)}")