llm-ie 1.2.0__py3-none-any.whl → 1.2.1__py3-none-any.whl

llm_ie/engines.py

@@ -185,10 +185,11 @@ class Qwen3LLMConfig(LLMConfig):
 
 
 class OpenAIReasoningLLMConfig(LLMConfig):
-    def __init__(self, reasoning_effort:str="low", **kwargs):
+    def __init__(self, reasoning_effort:str=None, **kwargs):
         """
         The OpenAI "o" series configuration.
-        1. The reasoning effort is set to "low" by default.
+        1. The reasoning effort as one of {"low", "medium", "high"}.
+            For models that do not support setting reasoning effort (e.g., o1-mini, o1-preview), set to None.
         2. The temperature parameter is not supported and will be ignored.
         3. The system prompt is not supported and will be concatenated to the next user prompt.
 
@@ -198,11 +199,12 @@ class OpenAIReasoningLLMConfig(LLMConfig):
             the reasoning effort. Must be one of {"low", "medium", "high"}. Default is "low".
         """
         super().__init__(**kwargs)
-        if reasoning_effort not in ["low", "medium", "high"]:
-            raise ValueError("reasoning_effort must be one of {'low', 'medium', 'high'}.")
+        if reasoning_effort is not None:
+            if reasoning_effort not in ["low", "medium", "high"]:
+                raise ValueError("reasoning_effort must be one of {'low', 'medium', 'high'}.")
 
-        self.reasoning_effort = reasoning_effort
-        self.params["reasoning_effort"] = self.reasoning_effort
+            self.reasoning_effort = reasoning_effort
+            self.params["reasoning_effort"] = self.reasoning_effort
 
         if "temperature" in self.params:
             warnings.warn("Reasoning models do not support temperature parameter. Will be ignored.", UserWarning)

llm_ie/prompt_editor.py

@@ -1,9 +1,11 @@
 import sys
+import warnings
 from typing import List, Dict, Generator
 import importlib.resources
 from llm_ie.engines import InferenceEngine
 from llm_ie.extractors import FrameExtractor
 import re
+import json
 from colorama import Fore, Style
 
     
@@ -40,7 +42,9 @@ class PromptEditor:
         file_path = importlib.resources.files('llm_ie.asset.PromptEditor_prompts').joinpath('system.txt')
         with open(file_path, 'r') as f:
             self.system_prompt =  f.read()
-        
+
+        # internal memory (history messages) for the `chat` method
+        self.messages = []
 
     def _apply_prompt_template(self, text_content:Dict[str,str], prompt_template:str) -> str:
         """
@@ -70,6 +74,7 @@ class PromptEditor:
     def rewrite(self, draft:str) -> str:
         """
         This method inputs a prompt draft and rewrites it following the extractor's guideline.
+        This method is stateless.
         """
         file_path = importlib.resources.files('llm_ie.asset.PromptEditor_prompts').joinpath('rewrite.txt')
         with open(file_path, 'r') as f:
@@ -85,6 +90,7 @@ class PromptEditor:
     def comment(self, draft:str) -> str:
         """
         This method inputs a prompt draft and comment following the extractor's guideline.
+        This method is stateless.
         """
         file_path = importlib.resources.files('llm_ie.asset.PromptEditor_prompts').joinpath('comment.txt')
         with open(file_path, 'r') as f:
@@ -97,22 +103,64 @@ class PromptEditor:
         res = self.inference_engine.chat(messages, verbose=True)
         return res
     
+    def clear_messages(self):
+        """
+        Clears the current chat history.
+        """
+        self.messages = []
 
-    def _terminal_chat(self):
+    def export_chat(self, file_path: str):
         """
-        This method runs an interactive chat session in the terminal to help users write prompt templates.
+        Exports the current chat history to a JSON file.
+
+        Parameters
+        ----------
+        file_path : str
+            path to the file where the chat history will be saved.
+            Should have a .json extension.
         """
-        file_path = importlib.resources.files('llm_ie.asset.PromptEditor_prompts').joinpath('chat.txt')
-        with open(file_path, 'r') as f:
-            chat_prompt_template = f.read()
+        if not self.messages:
+            raise ValueError("Chat history is empty. Nothing to export.")
 
-        prompt = self._apply_prompt_template(text_content={"prompt_guideline": self.prompt_guide}, 
-                                             prompt_template=chat_prompt_template)
+        with open(file_path, 'w', encoding='utf-8') as f:
+            json.dump(self.messages, f, indent=4)
 
-        messages = [{"role": "system", "content": self.system_prompt},
-                    {"role": "user", "content": prompt}]
+    def import_chat(self, file_path: str):
+        """
+        Imports a chat history from a JSON file, overwriting the current history.
+
+        Parameters
+        ----------
+        file_path : str
+            The path to the .json file containing the chat history.
+        """
+        with open(file_path, 'r', encoding='utf-8') as f:
+            loaded_messages = json.load(f)
+
+        # Validate the loaded messages format.
+        if not isinstance(loaded_messages, list):
+            raise TypeError("Invalid format: The file should contain a JSON list of messages.")
+        for message in loaded_messages:
+            if not (isinstance(message, dict) and 'role' in message and 'content' in message):
+                raise ValueError("Invalid format: Each message must be a dictionary with 'role' and 'content' keys.")
         
+        self.messages = loaded_messages
+
+
+    def _terminal_chat(self):
+        """
+        This method runs an interactive chat session in the terminal to help users write prompt templates.
+        """
         print(f'Welcome to the interactive chat! Type "{Fore.RED}exit{Style.RESET_ALL}" or {Fore.YELLOW}control + C{Style.RESET_ALL} to end the conversation.')
+        if len(self.messages) > 0:
+            print(f"\nPrevious conversation:")
+            for message in self.messages:
+                if message["role"] == "user":
+                    print(f"{Fore.GREEN}\nUser: {Style.RESET_ALL}")
+                    print(message["content"])
+                elif message["role"] == "assistant":
+                    print(f"{Fore.BLUE}Assistant: {Style.RESET_ALL}", end="")
+                    print(message["content"])
 
         while True:
             # Get user input
@@ -124,10 +172,10 @@ class PromptEditor:
                 break
             
             # Chat
-            messages.append({"role": "user", "content": user_input})
+            self.messages.append({"role": "user", "content": user_input})
             print(f"{Fore.BLUE}Assistant: {Style.RESET_ALL}", end="")
-            response = self.inference_engine.chat(messages, verbose=True)
-            messages.append({"role": "assistant", "content": response})
+            response = self.inference_engine.chat(self.messages, verbose=True)
+            self.messages.append({"role": "assistant", "content": response})
             
 
     def _IPython_chat(self):
@@ -144,19 +192,6 @@ class PromptEditor:
             raise ImportError("IPython not found. Please install IPython (```pip install ipython```).")
         from IPython.display import display, HTML
 
-        # Load the chat prompt template from the resources
-        file_path = importlib.resources.files('llm_ie.asset.PromptEditor_prompts').joinpath('chat.txt')
-        with open(file_path, 'r') as f:
-            chat_prompt_template = f.read()
-
-        # Prepare the initial system message with the prompt guideline
-        prompt = self._apply_prompt_template(text_content={"prompt_guideline": self.prompt_guide}, 
-                                            prompt_template=chat_prompt_template)
-
-        # Initialize conversation messages
-        messages = [{"role": "system", "content": self.system_prompt},
-                    {"role": "user", "content": prompt}]
-
         # Widgets for user input and chat output
         input_box = widgets.Text(placeholder="Type your message here...")
         output_area = widgets.Output()
@@ -164,6 +199,13 @@ class PromptEditor:
         # Display initial instructions
         with output_area:
             display(HTML('Welcome to the interactive chat! Type "<span style="color: red;">exit</span>" to end the conversation.'))
+            if len(self.messages) > 0:
+                display(HTML(f'<p style="color: red;">Previous messages:</p>'))
+                for message in self.messages:
+                    if message["role"] == "user":
+                        display(HTML(f'<p style="color: green;">User: {message["content"]}</p>'))
+                    elif message["role"] == "assistant":
+                        display(HTML(f'<p style="color: blue;">Assistant: {message["content"]}</p>'))
 
         def handle_input(sender):
             user_input = input_box.value
@@ -177,7 +219,7 @@ class PromptEditor:
                 return
 
             # Append user message to conversation
-            messages.append({"role": "user", "content": user_input})
+            self.messages.append({"role": "user", "content": user_input})
             print(f"User: {user_input}")
             
             # Display the user message
@@ -186,8 +228,8 @@ class PromptEditor:
 
             # Get assistant's response and append it to conversation
             print("Assistant: ", end="")
-            response = self.inference_engine.chat(messages, verbose=True)
-            messages.append({"role": "assistant", "content": response})
+            response = self.inference_engine.chat(self.messages, verbose=True)
+            self.messages.append({"role": "assistant", "content": response})
 
             # Display the assistant's response
             with output_area:
@@ -203,7 +245,20 @@ class PromptEditor:
     def chat(self):
         """
         External method that detects the environment and calls the appropriate chat method.
+        This method use and updates the `messages` list (internal memory).
+        This method is stateful.
         """
+        # Check if the conversation is empty, if so, load the initial chat prompt template.
+        if len(self.messages) == 0:
+            file_path = importlib.resources.files('llm_ie.asset.PromptEditor_prompts').joinpath('chat.txt')
+            with open(file_path, 'r') as f:
+                chat_prompt_template = f.read()
+
+            guideline = self._apply_prompt_template(text_content={"prompt_guideline": self.prompt_guide}, 
+                                                    prompt_template=chat_prompt_template)
+
+            self.messages = [{"role": "system", "content": self.system_prompt + guideline}]
+
         if 'ipykernel' in sys.modules:
             self._IPython_chat()
         else:
@@ -213,6 +268,7 @@ class PromptEditor:
         """
         This method processes messages and yields response chunks from the inference engine.
         This is for frontend App.
+        This method is stateless.
 
         Parameters:
         ----------
@@ -232,12 +288,10 @@ class PromptEditor:
         with open(file_path, 'r') as f:
             chat_prompt_template = f.read()
 
-        prompt = self._apply_prompt_template(text_content={"prompt_guideline": self.prompt_guide}, 
-                                            prompt_template=chat_prompt_template)
+        guideline = self._apply_prompt_template(text_content={"prompt_guideline": self.prompt_guide}, 
+                                                prompt_template=chat_prompt_template)
 
-        messages = [{"role": "system", "content": self.system_prompt},
-                    {"role": "user", "content": prompt}] + messages
-        
+        messages = [{"role": "system", "content": self.system_prompt + guideline}] + messages
 
         stream_generator = self.inference_engine.chat(messages, stream=True)
         yield from stream_generator

{llm_ie-1.2.0.dist-info → llm_ie-1.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: llm-ie
-Version: 1.2.0
+Version: 1.2.1
 Summary: A comprehensive toolkit that provides building blocks for LLM-based named entity recognition, attribute extraction, and relation extraction pipelines.
 License: MIT
 Author: Enshuo (David) Hsu

{llm_ie-1.2.0.dist-info → llm_ie-1.2.1.dist-info}/RECORD

@@ -20,9 +20,9 @@ llm_ie/asset/prompt_guide/SentenceFrameExtractor_prompt_guide.txt,sha256=97_-y_v
 llm_ie/asset/prompt_guide/SentenceReviewFrameExtractor_prompt_guide.txt,sha256=97_-y_vHMLG4Kb8fLsGgibLxB-3mest8k3LHfLo5h-I,10465
 llm_ie/chunkers.py,sha256=24h9l-Ldyx3EgfYicFqGhV_b-XofUS3yovC1nBWdDoo,5143
 llm_ie/data_types.py,sha256=72-3bzzYpo7KZpD9bjoroWT2eiM0zmWyDkBr2nHoBV0,18559
-llm_ie/engines.py,sha256=uE5sag1YeKBYBFF4gY7rYZK9e1ttatf9T7bV_xSg9Pk,36075
+llm_ie/engines.py,sha256=x8ZAzYkSfnFGyZP9fBjKp3eHSkuGneq94PDP4Zinvq0,36250
 llm_ie/extractors.py,sha256=aCRqKhjSoKTAWZ3WhX_O6V-S_rIvYhPsk78nZLDpQw8,95149
-llm_ie/prompt_editor.py,sha256=zh7Es5Ta2qSTgHtfF9Y9ZKXs4DMue6XlyRt9O6_Uk6c,10962
-llm_ie-1.2.0.dist-info/METADATA,sha256=X9zsMDwBAq1QzIkX8SSbmwLsEFiiAVeNeA0GTiNkAkQ,728
-llm_ie-1.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-llm_ie-1.2.0.dist-info/RECORD,,
+llm_ie/prompt_editor.py,sha256=x900oDyAozdKlXrF8SDz7wAQ-ilE7orcKLdk_aM25fM,13150
+llm_ie-1.2.1.dist-info/METADATA,sha256=F-dAtCt3xjBX3yh1qm9E07fWWG9q0VAp0cZx9pBfbZU,728
+llm_ie-1.2.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+llm_ie-1.2.1.dist-info/RECORD,,