Use a form, a button, and a single LLM call to generate contents in JSON format. Disable image generation.

app.py

@@ -1,4 +1,3 @@
-import base64
 import os
 import json5
 import logging
@@ -7,6 +6,7 @@ import time
 import streamlit as st
 import streamlit.runtime.scriptrunner as st_sr
 from typing import List, Tuple
+import metaphor_python as metaphor
 
 import llm_helper
 import pptx_helper
@@ -29,22 +29,22 @@ def get_contents_wrapper(text: str) -> str:
     Fetch and cache the slide deck contents on a topic by calling an external API.
 
     :param text: The presentation topic
-    :return: The slide deck contents or outline
+    :return: The slide deck contents or outline in JSON format
     """
 
+    logging.info('LLM call because of cache miss...')
     return llm_helper.generate_slides_content(text).strip()
 
 
-@st.cache_data
-def get_json_wrapper(text: str) -> str:
+@st.cache_resource
+def get_metaphor_client_wrapper() -> metaphor.Metaphor:
     """
-    Fetch and cache the JSON-formatted slide deck contents by calling an external API.
+    Create a Metaphor client for semantic Web search.
 
-    :param text: The slide deck contents or outline
-    :return: The JSON-formatted contents
+    :return: Metaphor instance
     """
 
-    return llm_helper.text_to_json(text)
+    return metaphor.Metaphor(api_key=GlobalConfig.METAPHOR_API_KEY)
 
 
 @st.cache_data
@@ -57,7 +57,11 @@ def get_web_search_results_wrapper(text: str) -> List[Tuple[str, str]]:
     """
 
     results = []
-    search_results = llm_helper.get_related_websites(text)
+    search_results = get_metaphor_client_wrapper().search(
+        text,
+        use_autoprompt=True,
+        num_results=5
+    )
 
     for a_result in search_results.results:
         results.append((a_result.title, a_result.url))
@@ -104,52 +108,60 @@ def build_ui():
     Display the input elements for content generation. Only covers the first step.
     """
 
-    get_disk_used_percentage()
+    # get_disk_used_percentage()
 
     st.title(APP_TEXT['app_name'])
     st.subheader(APP_TEXT['caption'])
-    # st.markdown(
-    #     '![Visitors](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fhuggingface.co%2Fspaces%2Fbarunsaha%2Fslide-deck-ai&countColor=%23263759)'
-    # )
-    st.divider()
 
-    st.header(APP_TEXT['section_headers'][0])
-    st.caption(APP_TEXT['section_captions'][0])
+    with st.form('my_form'):
+        # Topic input
+        try:
+            with open(GlobalConfig.PRELOAD_DATA_FILE, 'r') as in_file:
+                preload_data = json5.loads(in_file.read())
+        except (FileExistsError, FileNotFoundError):
+            preload_data = {'topic': '', 'audience': ''}
+
+        topic = st.text_area(
+            APP_TEXT['input_labels'][0],
+            value=preload_data['topic']
+        )
+
+        texts = list(GlobalConfig.PPTX_TEMPLATE_FILES.keys())
+        captions = [GlobalConfig.PPTX_TEMPLATE_FILES[x]['caption'] for x in texts]
 
-    try:
-        with open(GlobalConfig.PRELOAD_DATA_FILE, 'r') as in_file:
-            preload_data = json5.loads(in_file.read())
-    except (FileExistsError, FileNotFoundError):
-        preload_data = {'topic': '', 'audience': ''}
-
-    # with st.form('describe-topic-form'):
-    topic = st.text_area(
-        APP_TEXT['input_labels'][0],
-        value=preload_data['topic']
-    )
+        pptx_template = st.radio(
+            'Select a presentation template:',
+            texts,
+            captions=captions,
+            horizontal=True
+        )
+
+        st.divider()
+        submit = st.form_submit_button('Generate slide deck')
 
-    # Button with callback function
-    st.button(APP_TEXT['button_labels'][0], on_click=button_clicked, args=[0])
-    # desc_topic_btn_submitted = st.form_submit_button(
-    #     APP_TEXT['button_labels'][0],
-    #     on_click=button_clicked,
-    #     args=[0]
-    # )
-
-    if st.session_state.clicked[0]:
-        # if desc_topic_btn_submitted:
-        progress_text = 'Generating contents for your slides...give it a moment'
+    if submit:
+        # st.write(f'Clicked {time.time()}')
+        progress_text = 'Generating the slides...give it a moment'
         progress_bar = st.progress(0, text=progress_text)
 
         topic_txt = topic.strip()
-        process_topic_inputs(topic_txt, progress_bar)
+        generate_presentation(topic_txt, pptx_template, progress_bar)
+
+    st.divider()
+    st.text(APP_TEXT['tos'])
+    st.text(APP_TEXT['tos2'])
+
+    st.markdown(
+        '![Visitors](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fhuggingface.co%2Fspaces%2Fbarunsaha%2Fslide-deck-ai&countColor=%23263759)'
+    )
 
 
-def process_topic_inputs(topic: str, progress_bar):
+def generate_presentation(topic: str, pptx_template: str, progress_bar):
     """
-    Process the inputs to generate contents for the slides.
+    Process the inputs to generate the slides.
 
-    :param topic: The presentation topic
+    :param topic: The presentation topic based on which contents are to be generated
+    :param pptx_template: The PowerPoint template name to be used
     :param progress_bar: Progress bar from the page
     :return:
     """
@@ -161,51 +173,30 @@ def process_topic_inputs(topic: str, progress_bar):
         logging.debug(
             f'Topic: {topic}\n'
         )
-        logging.debug('=' * 20)
 
         target_length = min(topic_length, GlobalConfig.LLM_MODEL_MAX_INPUT_LENGTH)
 
         try:
-            logging.info('Calling LLM for content generation...')
-            slides_content = get_contents_wrapper(topic[:target_length])
-            content_length = len(slides_content)
-
-            logging.debug('=' * 20)
-            logging.debug(f'Slides content:\n{slides_content}')
-            logging.debug(f'Content length: {content_length}')
-            logging.debug('=' * 20)
-            st.write(f'''Slides content:\n{slides_content}''')
-            progress_bar.progress(100, text='Done!')
-
-            if content_length == 0:
-                st.error(APP_TEXT['content_generation_failure_error'])
+            # Step 1: Generate the contents in JSON format using an LLM
+            json_str = process_slides_contents(topic[:target_length], progress_bar)
+
+            # Step 2: Generate the slide deck based on the template specified
+            if len(json_str) > 0:
+                st.info(
+                    'Tip: The generated content doesn\'t look so great?'
+                    ' Need alternatives? Just change your description text and try again.',
+                    icon="💡️"
+                )
+            else:
+                st.error('Unfortunately, JSON generation failed, so the next steps would lead to nowhere.'
+                         ' Try again or come back later.')
                 return
 
-            st.info(
-                'The generated content doesn\'t look so great?'
-                ' Need alternatives? Just change your description text and try again.',
-                icon="💡️"
-            )
+            all_headers = generate_slide_deck(json_str, pptx_template, progress_bar)
 
-            # Move on to step 2
-            st.divider()
-            st.header(APP_TEXT['section_headers'][1])
-            st.caption(APP_TEXT['section_captions'][1])
+            # Step 3: Bonus stuff: Web references and AI art
+            show_bonus_stuff(all_headers)
 
-            # Streamlit multiple buttons work in a weird way!
-            # Click on any button, the page just reloads!
-            # Buttons are not "stateful"
-            # https://blog.streamlit.io/10-most-common-explanations-on-the-streamlit-forum/#1-buttons-aren%E2%80%99t-stateful
-            # Apparently, "nested button click" needs to be handled differently
-            # https://playground.streamlit.app/?q=triple-button
-
-            st.button(APP_TEXT['button_labels'][1], on_click=button_clicked, args=[1])
-
-            if st.session_state.clicked[1]:
-                progress_text = 'Converting...give it a moment'
-                progress_bar = st.progress(0, text=progress_text)
-
-                process_slides_contents(slides_content, progress_bar)
         except ValueError as ve:
             st.error(f'Unfortunately, an error occurred: {ve}! '
                      f'Please change the text, try again later, or report it, sharing your inputs.')
@@ -214,151 +205,79 @@ def process_topic_inputs(topic: str, progress_bar):
         st.error('Not enough information provided! Please be little more descriptive :)')
 
 
-def process_slides_contents(text: str, progress_bar: st.progress):
+def process_slides_contents(text: str, progress_bar: st.progress) -> str:
     """
     Convert given text into structured data and display. Update the UI.
 
-    :param text: The contents generated for the slides
+    :param text: The topic description for the presentation
     :param progress_bar: Progress bar for this step
+    :return: The contents as a JSON-formatted string
     """
 
-    logging.debug('JSON button clicked')
     json_str = ''
 
     try:
-        logging.info('Calling LLM for conversion...')
-        json_str = get_json_wrapper(text)
+        logging.info(f'Calling LLM for content generation on the topic: {text}')
+        json_str = get_contents_wrapper(text)
     except Exception as ex:
         st.error(f'An exception occurred while trying to convert to JSON.'
                  f' It could be because of heavy traffic or something else.'
                  f' Try doing it again or try again later.\n'
                  f' Error message: {ex}')
-        # st.stop()
-
-    # yaml_str = llm_helper.text_to_yaml(text)
-    logging.debug('=' * 20)
-    logging.debug(f'JSON:\n{json_str}')
-    logging.debug('=' * 20)
-    st.code(json_str, language='json')
-
-    if len(json_str) > 0:
-        progress_bar.progress(100, text='Done!')
-        st.info(
-            'Tip: In some scenarios, the JSON creates a deeper nesting of the bullet points'
-            ' than what is expected. You can try to regenerate the JSON'
-            ' by making a minor change in the topic description in the previous step, e.g.,'
-            ' by adding or removing a character. Alternatively, you can edit this in the slide'
-            ' deck that would be generated in the next step.',
-            icon="💡️"
-        )
-    else:
-        st.error('Unfortunately, JSON generation failed, so the next steps would lead to nowhere.'
-                 ' Try again or come back later.')
 
-    # Now, step 3
-    st.divider()
-    st.header(APP_TEXT['section_headers'][2])
-    st.caption(APP_TEXT['section_captions'][2])
-
-    texts = list(GlobalConfig.PPTX_TEMPLATE_FILES.keys())
-    captions = [GlobalConfig.PPTX_TEMPLATE_FILES[x]['caption'] for x in texts]
-
-    # with st.form('create-slides-form'):
-    pptx_template = st.radio(
-        'Select a presentation template:',
-        texts,
-        captions=captions,
-        horizontal=True
-    )
+    logging.debug(f'JSON: {json_str}')
 
-    st.button(APP_TEXT['button_labels'][2], on_click=button_clicked, args=[2])
-    # create_slides_btn_submitted = st.form_submit_button(APP_TEXT['button_labels'][2])
+    progress_bar.progress(50, text='Contents generated')
 
-    if st.session_state.clicked[2]:
-        # if create_slides_btn_submitted:
-        progress_text = 'Creating the slide deck...give it a moment'
-        progress_bar = st.progress(0, text=progress_text)
+    with st.expander('The generated contents (in JSON format)'):
+        st.code(json_str, language='json')
 
-        # Get a unique name for the file to save -- use the session ID
-        ctx = st_sr.get_script_run_ctx()
-        session_id = ctx.session_id
-        timestamp = time.time()
-        output_file_name = f'{session_id}_{timestamp}.pptx'
-
-        logging.info('Creating PPTX file...')
-        all_headers = pptx_helper.generate_powerpoint_presentation(
-            json_str,
-            as_yaml=False,
-            slides_template=pptx_template,
-            output_file_name=output_file_name
-        )
-        progress_bar.progress(100, text='Done!')
+    return json_str
 
-        # st.download_button('Download file', binary_contents)  # Defaults to 'application/octet-stream'
 
-        with open(output_file_name, 'rb') as f:
-            st.download_button('Download PPTX file', f, file_name=output_file_name)
+def generate_slide_deck(json_str: str, pptx_template: str, progress_bar) -> List:
+    """
+    Create a slide deck.
 
-        bonus_divider = st.empty()
-        bonus_header = st.empty()
-        bonus_caption = st.empty()
+    :param json_str: The contents in JSON format
+    :param pptx_template: The PPTX template name
+    :param progress_bar: Progress bar
+    :return: A list of all slide headers and the title
+    """
 
-        urls_text = st.empty()
-        urls_list = st.empty()
+    progress_text = 'Creating the slide deck...give it a moment'
+    progress_bar.progress(75, text=progress_text)
+
+    # Get a unique name for the file to save -- use the session ID
+    ctx = st_sr.get_script_run_ctx()
+    session_id = ctx.session_id
+    timestamp = time.time()
+    output_file_name = f'{session_id}_{timestamp}.pptx'
+
+    logging.info('Creating PPTX file...')
+    all_headers = pptx_helper.generate_powerpoint_presentation(
+        json_str,
+        as_yaml=False,
+        slides_template=pptx_template,
+        output_file_name=output_file_name
+    )
+    progress_bar.progress(100, text='Done!')
 
-        img_empty = st.empty()
-        img_text = st.empty()
-        img_contents = st.empty()
-        img_tip = st.empty()
+    with open(output_file_name, 'rb') as f:
+        st.download_button('Download PPTX file', f, file_name=output_file_name)
 
-        st.divider()
-        st.text(APP_TEXT['tos'])
-        st.text(APP_TEXT['tos2'])
-
-        show_bonus_stuff(
-            all_headers,
-            bonus_divider,
-            bonus_header,
-            bonus_caption,
-            urls_text,
-            urls_list,
-            img_empty,
-            img_text,
-            img_contents,
-            img_tip
-        )
+    return all_headers
 
 
-def show_bonus_stuff(
-        ppt_headers: List,
-        *st_placeholders
-):
+def show_bonus_stuff(ppt_headers: List[str]):
     """
-    Show relevant links and images for the presentation topic.
+    Show bonus stuff for the presentation.
 
-    :param ppt_headers: A list of all slide headers
+    :param ppt_headers: A list of the slide headings.
     """
 
-    (
-        bonus_divider,
-        bonus_header,
-        bonus_caption,
-        urls_text,
-        urls_list,
-        img_empty,
-        img_text,
-        img_contents,
-        img_tip
-    ) = st_placeholders
-
-    bonus_divider.divider()
-    bonus_header.header(APP_TEXT['section_headers'][3])
-    bonus_caption.caption(APP_TEXT['section_captions'][3])
-
-    urls_text.write(APP_TEXT['urls_info'])
-
     # Use the presentation title and the slides headers to find relevant info online
-    logging.info('Using Metaphor search...')
+    logging.info('Calling Metaphor search...')
     ppt_text = ' '.join(ppt_headers)
     search_results = get_web_search_results_wrapper(ppt_text)
     md_text_items = []
@@ -366,32 +285,13 @@ def show_bonus_stuff(
     for (title, link) in search_results:
         md_text_items.append(f'[{title}]({link})')
 
-    urls_list.markdown('\n\n'.join(md_text_items))
-
-    logging.info('Calling SDXL for image generation...')
-    img_empty.write('')
-    img_text.write(APP_TEXT['image_info'])
-    image = get_ai_image_wrapper(ppt_text)
+    with st.expander('Related Web references'):
+        st.markdown('\n\n'.join(md_text_items))
 
-    if len(image) > 0:
-        image = base64.b64decode(image)
-        img_contents.image(image, caption=ppt_text)
-        img_tip.info('Tip: Right-click on the image to save it.', icon="💡️")
-
-
-def button_clicked(button):
-    """
-    Update the button clicked value in session state.
-    """
-
-    st.session_state.clicked[button] = True
+    # Avoid image generation. It costs time and an API call, so just limit to the text generation.
 
 
 def main():
-    # Initialize the key in session state to manage the nested buttons states
-    if 'clicked' not in st.session_state:
-        st.session_state.clicked = {0: False, 1: False, 2: False}
-
     build_ui()
 
 

global_config.py

@@ -25,14 +25,14 @@ class GlobalConfig:
     # LLM_MODEL_TEMPERATURE: float = 0.5
     LLM_MODEL_MIN_OUTPUT_LENGTH: int = 50
     LLM_MODEL_MAX_OUTPUT_LENGTH: int = 2000
-    LLM_MODEL_MAX_INPUT_LENGTH: int = 1000
+    LLM_MODEL_MAX_INPUT_LENGTH: int = 250
 
     METAPHOR_API_KEY = os.environ.get('METAPHOR_API_KEY', '')
 
     LOG_LEVEL = 'INFO'
     APP_STRINGS_FILE = 'strings.json'
     PRELOAD_DATA_FILE = 'examples/example_02.json'
-    SLIDES_TEMPLATE_FILE = 'langchain_templates/template_07.txt'
+    SLIDES_TEMPLATE_FILE = 'langchain_templates/template_combined.txt'
     JSON_TEMPLATE_FILE = 'langchain_templates/text_to_json_template_02.txt'
 
     PPTX_TEMPLATE_FILES = {

langchain_templates/template_combined.txt

@@ -0,0 +1,37 @@
+You are a helpful, intelligent chatbot. Create the slides for a presentation on the given topic. Include main headings for each slide, detailed bullet points for each slide. Add relevant content to each slide.
+
+
+Topic:
+<REPLACE_PLACEHOLDER>
+
+
+Desired JSON output format:
+
+{
+    "title": "Presentation Title",
+    "slides": [
+        {
+            "heading": "Heading for the First Slide",
+            "bullet_points": [
+                "First bullet point",
+                [
+                    "Sub-bullet point 1",
+                    "Sub-bullet point 1"
+                ],
+                "Second bullet point"
+            ]
+        },
+        {
+            "heading": "Heading for the Second Slide",
+            "bullet_points": [
+                "First bullet point",             
+                "Second bullet item",
+                "Third bullet point"
+            ]
+        }
+    ]
+}
+
+
+Output:
+```json

llm_helper.py

@@ -1,9 +1,7 @@
 import json
 import logging
 import time
-import metaphor_python as metaphor
 import requests
-from langchain import PromptTemplate
 from langchain.llms import Clarifai
 
 from global_config import GlobalConfig
@@ -14,10 +12,7 @@ logging.basicConfig(
     format='%(asctime)s - %(message)s',
 )
 
-prompt = None
-llm_contents = None
-llm_json = None
-metaphor_client = None
+llm = None
 
 
 def get_llm(use_gpt: bool) -> Clarifai:
@@ -28,7 +23,7 @@ def get_llm(use_gpt: bool) -> Clarifai:
     """
 
     if use_gpt:
-        llm = Clarifai(
+        _ = Clarifai(
             pat=GlobalConfig.CLARIFAI_PAT,
             user_id=GlobalConfig.CLARIFAI_USER_ID_GPT,
             app_id=GlobalConfig.CLARIFAI_APP_ID_GPT,
@@ -37,7 +32,7 @@ def get_llm(use_gpt: bool) -> Clarifai:
             # temperature=0.1,
         )
     else:
-        llm = Clarifai(
+        _ = Clarifai(
             pat=GlobalConfig.CLARIFAI_PAT,
             user_id=GlobalConfig.CLARIFAI_USER_ID,
             app_id=GlobalConfig.CLARIFAI_APP_ID,
@@ -47,7 +42,7 @@ def get_llm(use_gpt: bool) -> Clarifai:
         )
     # print(llm)
 
-    return llm
+    return _
 
 
 def generate_slides_content(topic: str) -> str:
@@ -55,140 +50,24 @@ def generate_slides_content(topic: str) -> str:
     Generate the outline/contents of slides for a presentation on a given topic.
 
     :param topic: Topic/subject matter/idea on which slides are to be generated
-    :return: The content
+    :return: The content in JSON format
     """
 
-    global prompt
-    global llm_contents
+    # global prompt
+    global llm
 
-    if prompt is None:
-        with open(GlobalConfig.SLIDES_TEMPLATE_FILE, 'r') as in_file:
-            template_txt = in_file.read().strip()
+    with open(GlobalConfig.SLIDES_TEMPLATE_FILE, 'r') as in_file:
+        template_txt = in_file.read().strip()
+        template_txt = template_txt.replace('<REPLACE_PLACEHOLDER>', topic)
 
-        prompt = PromptTemplate.from_template(template_txt)
+    if llm is None:
+        llm = get_llm(use_gpt=True)
 
-    formatted_prompt = prompt.format(topic=topic)
-    # print(f'formatted_prompt:\n{formatted_prompt}')
-
-    if llm_contents is None:
-        llm_contents = get_llm(use_gpt=False)
-
-    slides_content = llm_contents(formatted_prompt, verbose=True)
+    slides_content = llm(template_txt, verbose=True)
 
     return slides_content
 
 
-def text_to_json(content: str) -> str:
-    """
-    Convert input text into structured JSON representation.
-
-    :param content: Input text
-    :return: JSON string
-    """
-
-    global llm_json
-
-    content = content.replace('```', '')
-
-    # f-string is not used in order to prevent interpreting the brackets
-    with open(GlobalConfig.JSON_TEMPLATE_FILE, 'r') as in_file:
-        text = in_file.read()
-        # Insert the actual text contents
-        text = text.replace('<REPLACE_PLACEHOLDER>', content)
-
-    text = text.strip()
-    # print(text)
-
-    if llm_json is None:
-        llm_json = get_llm(use_gpt=True)
-
-    output = llm_json(text, verbose=True)
-    output = output.strip()
-
-    first_index = max(0, output.find('{'))
-    last_index = min(output.rfind('}'), len(output))
-    output = output[first_index: last_index + 1]
-
-    return output
-
-
-def text_to_yaml(content: str) -> str:
-    """
-    Convert input text into structured YAML representation.
-
-    :param content: Input text
-    :return: JSON string
-    """
-
-    global llm_json
-
-    content = content.replace('```', '')
-
-    # f-string is not used in order to prevent interpreting the brackets
-    text = '''
-You are a helpful AI assistant.
-Convert the given slide deck text into structured YAML output.
-Also, generate and add an engaging presentation title. 
-The output should be only correct and valid YAML having the following structure:
-
-title: "..."
-slides:
-  - heading: "..."
-    bullet_points:
-      - "..."
-      - "..."
-  - heading: "..."
-    bullet_points:
-      - "..."
-      - "...":  # This line ends with a colon because it has a sub-block
-        - "..."
-      - "..."
-
-
-Text:
-'''
-    text += content
-    text += '''
-
-
-
-
-Output:
-```yaml
-'''
-
-    text = text.strip()
-    # print(text)
-
-    if llm_json is None:
-        llm_json = get_llm(use_gpt=True)
-
-    output = llm_json(text, verbose=True)
-    output = output.strip()
-
-    # first_index = max(0, output.find('{'))
-    # last_index = min(output.rfind('}'), len(output))
-    # output = output[first_index: last_index + 1]
-
-    return output
-
-
-def get_related_websites(query: str) -> metaphor.api.SearchResponse:
-    """
-    Fetch Web search results for a given query.
-
-    :param query: The query text
-    :return: The search results object
-    """
-
-    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)
-
-
 def get_ai_image(text: str) -> str:
     """
     Get a Stable Diffusion-generated image based on a given text.

pptx_helper.py

@@ -9,6 +9,22 @@ from global_config import GlobalConfig
 
 
 PATTERN = re.compile(r"^slide[ ]+\d+:", re.IGNORECASE)
+SAMPLE_JSON_FOR_PPTX = '''
+{
+    "title": "Understanding AI",
+    "slides": [
+        {
+            "heading": "Introduction",
+            "bullet_points": [
+                "Brief overview of AI",
+                [
+                    "Importance of understanding AI"
+                ]
+            ]
+        }
+    ]
+}
+'''
 
 logging.basicConfig(
     level=GlobalConfig.LOG_LEVEL,

strings.json

@@ -14,7 +14,7 @@
         "Since you have come this far, we have unlocked 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 truncated due to API limitations.*"
+        "**Describe the topic of the presentation using 10 to 250 characters. Avoid mentioning the count of slides.**"
     ],
     "button_labels": [
         "Generate contents",