Add bonus contents (search results on the topic) & mini ToS

.idea/slide-deck-ai.iml

@@ -7,8 +7,4 @@
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
   </component>
-  <component name="PyDocumentationSettings">
-    <option name="format" value="PLAIN" />
-    <option name="myDocStringFormat" value="Plain" />
-  </component>
 </module>

app.py

@@ -1,3 +1,5 @@
+from typing import List
+
 import json5
 import time
 import streamlit as st
@@ -149,7 +151,11 @@ def process_slides_contents(text: str, progress_bar: st.progress):
         timestamp = time.time()
         output_file_name = f'{session_id}_{timestamp}.pptx'
 
-        pptx_helper.generate_powerpoint_presentation(json_str, as_yaml=False, output_file_name=output_file_name)
+        all_headers = pptx_helper.generate_powerpoint_presentation(
+            json_str,
+            as_yaml=False,
+            output_file_name=output_file_name
+        )
         progress_bar.progress(100, text='Done!')
 
         # st.download_button('Download file', binary_contents)  # Defaults to 'application/octet-stream'
@@ -157,6 +163,33 @@ def process_slides_contents(text: str, progress_bar: st.progress):
         with open(output_file_name, 'rb') as f:
             st.download_button('Download PPTX file', f, file_name=output_file_name)
 
+        show_bonus_stuff(all_headers)
+
+        st.divider()
+        st.text(APP_TEXT['tos'])
+        st.text(APP_TEXT['tos2'])
+
+
+def show_bonus_stuff(ppt_headers: List):
+    """
+    Show relevant links and images for the presentation topic.
+
+    :param ppt_headers: A list of all slide headers
+    """
+
+    st.divider()
+    st.header(APP_TEXT['section_headers'][3])
+    st.caption(APP_TEXT['section_captions'][3])
+
+    st.write(APP_TEXT['urls_info'])
+
+    # Use the presentation title and the slides headers to find relevant info online
+    ppt_text = ' '.join(ppt_headers)
+    search_results = llm_helper.get_related_websites(ppt_text)
+
+    for a_result in search_results.results:
+        st.markdown(f'[{a_result.title}]({a_result.url})')
+
 
 def button_clicked(button):
     """

global_config.py

@@ -22,6 +22,8 @@ class GlobalConfig:
     LLM_MODEL_MAX_OUTPUT_LENGTH: int = 2000
     LLM_MODEL_MAX_INPUT_LENGTH: int = 1000
 
+    METAPHOR_API_KEY = os.environ.get('METAPHOR_API_KEY', '')
+
     APP_STRINGS_FILE = 'strings.json'
     PRELOAD_DATA_FILE = 'examples/example_02.json'
     SLIDES_TEMPLATE_FILE = 'langchain_templates/template_07.txt'

llm_helper.py

@@ -1,3 +1,4 @@
+import metaphor_python as metaphor
 from langchain import PromptTemplate
 from langchain.llms import Clarifai
 
@@ -7,6 +8,7 @@ from global_config import GlobalConfig
 prompt = None
 llm_contents = None
 llm_yaml = None
+metaphor_client = None
 
 
 def get_llm(use_gpt: bool) -> Clarifai:
@@ -192,6 +194,18 @@ Output:
     return output
 
 
+def get_related_websites(query: str) -> metaphor.api.SearchResponse:
+    global metaphor_client
+
+    if not metaphor_client:
+        metaphor_client = metaphor.Metaphor(api_key=GlobalConfig.METAPHOR_API_KEY)
+
+    return metaphor_client.search(query, use_autoprompt=True, num_results=5)
+
+
 if __name__ == '__main__':
-    pass
+    results = get_related_websites('5G AI WiFi 6')
+
+    for a_result in results.results:
+        print(a_result.title, a_result.url, a_result.extract)
 

pptx_helper.py

@@ -1,3 +1,4 @@
+from typing import List
 import json5
 import pptx
 import re
@@ -5,10 +6,17 @@ import yaml
 
 from pptx.dml.color import RGBColor
 
+
 PATTERN = re.compile(r"^slide[ ]+\d+:", re.IGNORECASE)
 
 
 def remove_slide_number_from_heading(header: str) -> str:
+    """
+    Remove the slide number from a given slide header.
+
+    :param header: The header of a slide
+    """
+
     if PATTERN.match(header):
         idx = header.find(':')
         header = header[idx + 1:]
@@ -16,13 +24,14 @@ def remove_slide_number_from_heading(header: str) -> str:
     return header
 
 
-def generate_powerpoint_presentation(structured_data: str, as_yaml: bool, output_file_name: str):
+def generate_powerpoint_presentation(structured_data: str, as_yaml: bool, output_file_name: str) -> List:
     """
     Create and save a PowerPoint presentation file containing the contents in JSON or YAML format.
 
     :param structured_data: The presentation contents as "JSON" (may contain trailing commas) or YAML
     :param as_yaml: True if the input data is in YAML format; False if it is in JSON format
     :param output_file_name: The name of the PPTX file to save as
+    :return A list of presentation title and slides headers
     """
 
     if as_yaml:
@@ -46,6 +55,7 @@ def generate_powerpoint_presentation(structured_data: str, as_yaml: bool, output
     title.text = parsed_data['title']
     print(f'Title is: {title.text}')
     subtitle.text = 'by Myself and SlideDeck AI :)'
+    all_headers = [title.text, ]
 
     background = slide.background
     background.fill.solid()
@@ -61,6 +71,7 @@ def generate_powerpoint_presentation(structured_data: str, as_yaml: bool, output
         title_shape = shapes.title
         body_shape = shapes.placeholders[1]
         title_shape.text = remove_slide_number_from_heading(a_slide['heading'])
+        all_headers.append(title_shape.text)
         text_frame = body_shape.text_frame
 
         for an_item in a_slide['bullet_points']:
@@ -90,6 +101,8 @@ def generate_powerpoint_presentation(structured_data: str, as_yaml: bool, output
 
     presentation.save(output_file_name)
 
+    return all_headers
+
 
 if __name__ == '__main__':
     generate_powerpoint_presentation(

requirements.txt

@@ -5,5 +5,6 @@ streamlit~=1.26.0
 clarifai==9.7.4
 
 python-pptx
+metaphor-python
 json5~=0.9.14
 PyYAML~=6.0.1

strings.json

@@ -5,19 +5,24 @@
         "Step 1: Generate your content",
         "Step 2: Make it structured",
         "Step 3: Create the slides",
+        "Bonus Materials"
     ],
     "section_captions": [
-        "Let\'s start by generating some contents for your slides",
-        "Let\'s now convert the above generated contents into JSON",
-        "Let\'s now create the slides for you",
+        "Let's start by generating some contents for your slides",
+        "Let's now convert the above generated contents into JSON",
+        "Let's now create the slides for you",
+        "Wait, there's some more good stuff for you!"
     ],
     "input_labels": [
-        "**Describe the topic of the presentation. Avoid mentioning the count of slides.**\n*Note: the output may be short or truncated due to API limitations.*",
+        "**Describe the topic of the presentation. Avoid mentioning the count of slides.**\n*Note: the output may be short or truncated due to API limitations.*"
     ],
     "button_labels": [
         "Generate slides content",
         "Generate JSON",
         "Make the slides"
     ],
-    "content_generation_failure_error": "Unfortunately, SlideDeck AI failed to generate any content for you! Please try again later."
+    "urls_info": "Here is a list of some online resources that you can consult for further information on this topic:",
+    "content_generation_failure_error": "Unfortunately, SlideDeck AI failed to generate any content for you! Please try again later.",
+    "tos": "SlideDeck AI is an experimental prototype, and it has its limitations.\nPlease carefully review any and all AI-generated content.",
+    "tos2": "By using SlideDeck AI, you agree to fair and responsible usage.\nNo liability assumed by any party."
 }