utils.py

from typing import TYPE_CHECKING, Any, Callable, Dict, List, Tuple, Type
import logging
import json
import os
from datetime import datetime
import hashlib
import csv
import requests
import re
import html
import markdown2
import torch 
import sys
import gc
from pygments.lexers import guess_lexer, ClassNotFound
import time
import json
import base64
from io import BytesIO 
import urllib.parse
import tempfile

from transformers import pipeline, AutoModelForSeq2SeqLM, AutoTokenizer, AutoModelForCausalLM, GPTNeoForCausalLM, GPT2Tokenizer
from sentence_transformers import SentenceTransformer, util
from typing import List, Dict

import gradio as gr
from pypinyin import lazy_pinyin
import tiktoken
import mdtex2html
from markdown import markdown
#from pygments import highlight
#from pygments.lexers import guess_lexer,get_lexer_by_name
#from pygments.formatters import HtmlFormatter

from langchain.chains import LLMChain, RetrievalQA
from langchain.prompts import PromptTemplate
from langchain_community.document_loaders import PyPDFLoader,  UnstructuredWordDocumentLoader, DirectoryLoader
#from langchain.document_loaders.blob_loaders.youtube_audio import YoutubeAudioLoader
#from langchain.document_loaders import GenericLoader
from langchain.schema import AIMessage, HumanMessage, Document
#from langchain_community.llms import HuggingFaceHub
#from langchain_community.llms import HuggingFaceTextGenInference
#from langchain_community.embeddings import HuggingFaceInstructEmbeddings, HuggingFaceEmbeddings, HuggingFaceBgeEmbeddings, HuggingFaceInferenceAPIEmbeddings
from langchain_huggingface import HuggingFaceEmbeddings
#from langchain_community.tools import DuckDuckGoSearchRun
from typing import Dict, TypedDict
from langchain_core.messages import BaseMessage
from langchain.prompts import PromptTemplate
 
from langchain_community.vectorstores import Chroma
from langchain_core.messages import BaseMessage, FunctionMessage
from langchain_core.output_parsers import StrOutputParser
from langchain_core.pydantic_v1 import BaseModel, Field
from langchain_core.runnables import RunnablePassthrough, RunnableSequence
from langchain.text_splitter import RecursiveCharacterTextSplitter
from chromadb.errors import InvalidDimensionException
import fitz  # PyMuPDF
import docx
#import io
#from PIL import Image, ImageDraw, ImageOps, ImageFont
#import base64
#from tempfile import NamedTemporaryFile

import nltk
from nltk.corpus import stopwords
from nltk.tokenize import word_tokenize
from nltk.stem import WordNetLemmatizer, PorterStemmer
from nltk.tokenize import RegexpTokenizer
from transformers import BertModel, BertTokenizer, pipeline
from nltk.stem.snowball import SnowballStemmer

from sklearn.feature_extraction.text import TfidfVectorizer
from sklearn.metrics.pairwise import cosine_similarity
import numpy as np

#für die Normalisierung
nltk.download('punkt')
nltk.download('stopwords')
german_stopwords = set(stopwords.words('german'))

#Konstanten
ANZAHL_DOCS = 5

###############################
#HF Authentifizierung
HUGGINGFACEHUB_API_TOKEN = os.getenv("HF_READ")
os.environ["HUGGINGFACEHUB_API_TOKEN"] = HUGGINGFACEHUB_API_TOKEN
HEADERS = {"Authorization": f"Bearer {HUGGINGFACEHUB_API_TOKEN}"}
# Hugging Face Token direkt im Code setzen
hf_token = os.getenv("HF_READ")

#################################################
#Gesetzte Werte für Pfade, Prompts und Keys..
#################################################
#################################################
#Prompt Zusätze
template = """\Antworte in deutsch, wenn es nicht explizit anders gefordert wird. Wenn du die Antwort nicht kennst, antworte direkt, dass du es nicht weißt.
             Antworte nur zu dem mitgelieferten Text. Fasse die einzelnen Text-Ausschnitte zusammen zu einem Text, gehe dabei auf jeden Textausschnitt ein."""

llm_template = "Beantworte die Frage am Ende. " + template + "Frage: {question} "
#nur für HF für Stichwotre bei chatverlauf
llm_template2 = "Fasse folgenden Text als Überschrift mit maximal 3 Worten zusammen. Text: {question}  "

rag_template = "Nutze ausschließlich die folgenden Kontexte (Beginnend mit dem Wort 'Kontext:') aus Teilen aus den angehängten Dokumenten, um die Frage (Beginnend mit dem Wort 'Frage: ') am Ende zu beantworten. Wenn du die Frage aus dem folgenden Kontext nicht beantworten kannst, sage, dass du keine passende Antwort gefunden hast. Wenn du dich auf den angegebenen Kontext beziehst, gib unbedingt den Namen des Dokumentes an, auf den du dich beziehst. Antworte nur zu dem mitgelieferten Text. Fasse die einzelnen Text-Ausschnitte zusammen zu einem Text, gehe dabei auf jeden Textausschnitt ein. Formuliere wichtige Punkte ausführlich aus." + template + "Kontext: {context} Frage: {question}"

#################################################
#Konstanten
LLM_CHAIN_PROMPT = PromptTemplate(input_variables = ["question"], 
                                  template = llm_template)
#nur für HF bei chatverlauf
LLM_CHAIN_PROMPT2 = PromptTemplate(input_variables = ["question"], 
                                  template = llm_template2)

RAG_CHAIN_PROMPT = PromptTemplate(input_variables = ["context", "question"], 
                                  template = rag_template)

################################################
#Pfad, wo Docs/Bilder/Filme abgelegt werden können - lokal, also hier im HF Space (sonst auf eigenem Rechner)
PATH_WORK = "."
CHROMA_DIR  = "/chroma/kkg"
CHROMA_PDF = './chroma/kkg/pdf'
CHROMA_WORD = './chroma/kkg/word'
CHROMA_EXCEL = './chroma/kkg/excel'
YOUTUBE_DIR = "/youtube"
HISTORY_PFAD = "/data/history"

###############################################
#URLs zu Dokumenten oder andere Inhalte, die einbezogen werden sollen
PDF_URL       = "https://arxiv.org/pdf/2303.08774.pdf"
WEB_URL       = "https://openai.com/research/gpt-4"
YOUTUBE_URL_1 = "https://www.youtube.com/watch?v=--khbXchTeE"
YOUTUBE_URL_2 = "https://www.youtube.com/watch?v=hdhZwyf24mE"
#YOUTUBE_URL_3 = "https://www.youtube.com/watch?v=vw-KWfKwvTQ"
#spezielle Webseiten als Datenbasis laden
urls = [
    "https://kkg.hamburg.de/unser-leitbild/"
    "https://kkg.hamburg.de/unsere-schulcharta/",
    "https://kkg.hamburg.de/koordination-unterrichtsentwicklung/",
    "https://kkg.hamburg.de/konzept-medien-und-it-am-kkg/",
]



##################################################
#Modell und Tokenizer für die Anfrage der RAG Chain 
##################################################
# Schritt 1: Embedding Modelle, um relvante Texte zu einem Prompt zu finden
#sowohl die texte als auch der Prompt werden embeddet!
embedder_modell = SentenceTransformer("sentence-transformers/all-mpnet-base-v2") #'all-MiniLM-L6-v2')
EMBEDDING_MODELL = "sentence-transformers/all-mpnet-base-v2"

#Modell und Tokenizer, um die Summary über die relevanten Texte zu machen
#mögliche Modelle: "HuggingFaceH4/zephyr-7b-alpha" #"t5-small" #"meta-llama/Meta-Llama-3-8B-Instruct" #"mistralai/Mistral-7B-Instruct-v0.3" #"microsoft/Phi-3-mini-4k-instruct" #"HuggingFaceH4/zephyr-7b-alpha" 
HF_MODELL ="EleutherAI/gpt-neo-2.7B"
modell_rag = GPTNeoForCausalLM.from_pretrained(HF_MODELL)
tokenizer_rag = GPT2Tokenizer.from_pretrained(HF_MODELL)

"""
HF_MODELL = "microsoft/Phi-3-mini-4k-instruct"
# Laden des Modells und Tokenizers
modell_rag = AutoModelForCausalLM.from_pretrained(HF_MODELL)
tokenizer_rag = AutoTokenizer.from_pretrained(HF_MODELL)

HF_MODELL = "t5-small"
modell_rag = AutoModelForSeq2SeqLM.from_pretrained(HF_MODELL)
tokenizer_rag = AutoTokenizer.from_pretrained(HF_MODELL)
"""


##################################################
#Normalisierung eines Prompts
##################################################
#Zur zeit nicht im Gebrauch.............................
def normalise_prompt (prompt):
    #alles Kleinbuchstaben
    prompt_klein =prompt.lower()
    #Word Tokenisation
    tokens = word_tokenize(prompt_klein)
    #Punktuierung entfernen
    tokens = [word for word in tokens if word.isalnum()]
    
    # Stop Word Entfernung
    tokens = [word for word in tokens if not word in german_stopwords]
    # 5. Lemmatisierung: Worte in Grundform bringen, um Text besser vergleichen zu können
    nltk.download('wordnet')
    lemmatizer = WordNetLemmatizer()
    tokens = [lemmatizer.lemmatize(word) for word in tokens]
    # 6. Handling Special Characters (Remove non-alphanumeric characters)
    tokens = [re.sub(r'\W+', '', word) for word in tokens]    
    # 7. Spell Check (optional, using a library like pyspellchecker)
    from spellchecker import SpellChecker
    spell = SpellChecker()
    tokens = [spell.correction(word) for word in tokens]
    # Join tokens back to sentence
    normalized_prompt = ' '.join(tokens)
    print("normaiserd prompt..................................")
    print(normalized_prompt)
    return normalized_prompt


#um ähnliche Wörter anhand ihres Wortstammes zu erkennen
# Funktion zur Stemmatisierung des Textes
def preprocess_text(text):
    if not text:
        return ""

    text = text.lower()
    tokenizer = RegexpTokenizer(r'\w+')
    word_tokens = tokenizer.tokenize(text)
    filtered_words = [word for word in word_tokens if word not in german_stopwords]
    stemmer = SnowballStemmer("german")
    stemmed_words = [stemmer.stem(word) for word in filtered_words]
    return " ".join(stemmed_words)

# Funktion zur Bereinigung des Textes aus den Pdfs und Word Dokuemtne, um den Tokenizer nicht zu überfordern
def clean_text(text):
    # Entfernen nicht druckbarer Zeichen
    text = re.sub(r'[^\x00-\x7F]+', ' ', text)
    # Ersetzen ungewöhnlicher Leerzeichen durch normale Leerzeichen
    text = re.sub(r'\s+', ' ', text)
    return text.strip()


##################################################
#RAG Hilfsfunktionen - Dokumenten bearbeiten für Vektorstore
##################################################
##################################################
# Directory Loader Konfigurieren
##################################################
# Funktion, um für einen best. File-typ ein directory-loader zu definieren
def create_directory_loaderBack(file_type, directory_path):
    #verscheidene Dokument loaders:
    loaders = {
        '.pdf': PyPDFLoader,
        '.word': UnstructuredWordDocumentLoader,
    }
    return DirectoryLoader(
        path=directory_path,
        glob=f"**/*{file_type}",
        loader_cls=loaders[file_type],
    )

#besseren directory Loader als CustomLoader definieren, der den inhalt des dokuemnts, die seitenzahlen, die überschriften und die pfadezu den dokumenten extrahieren
def create_directory_loader(file_type, directory_path):
    loaders = {
        '.pdf': load_pdf_with_metadata,
        '.word': load_word_with_metadata,
    }

    class CustomLoader:
        def __init__(self, directory_path, file_type, loader_func):
            self.directory_path = directory_path
            self.file_type = file_type
            self.loader_func = loader_func

        def load(self):
            documents = []
            for root, _, files in os.walk(self.directory_path):
                for file in files:
                    if file.endswith(self.file_type):
                        file_path = os.path.join(root, file)
                        documents.extend(self.loader_func(file_path))
            return documents

    return CustomLoader(directory_path, file_type, loaders[file_type])
    

################################################
# Custom Loader-Funktionen zu dem DirektoryLoader
# für PDF Dokumente:
def load_pdf_with_metadata(file_path):
    document = fitz.open(file_path)
    documents = []
    for page_num in range(len(document)):
        page = document.load_page(page_num)
        content = page.get_text("text")
        title = document.metadata.get("title", "Unbekannt")
        page_number = page_num + 1
        documents.append(Document(content=content, title=title, page=page_number, path=file_path))
    return documents
    
#für WOrD Dokumente
def load_word_with_metadata(file_path):
    document = docx.Document(file_path)
    title = "Dokument"
    path = file_path
    documents = []
    for para in document.paragraphs:
        content = para.text
        page_number = 1  # Word-Dokumente haben keine Seitenzahlen in diesem Kontext
        documents.append(Document(content=content, title=title, page=page_number, path=path))
    return documents


    
    
################################################    
#die Inhalte splitten, um in Vektordatenbank entsprechend zu laden als Splits
def document_loading_splitting():
    ##############################
    # Document loading
    docs = []
    
    # kreiere einen DirectoryLoader für jeden file type
    pdf_loader = create_directory_loader('.pdf', CHROMA_PDF)
    word_loader = create_directory_loader('.word', CHROMA_WORD)
    print("PDF Loader done............................")
    
    # Load the files
    pdf_documents = pdf_loader.load()
    word_documents = word_loader.load()

    #alle zusammen in docs...
    docs.extend(pdf_documents)
    docs.extend(word_documents)

    #andere loader...
    # Load PDF
    #loader = PyPDFLoader(PDF_URL)
    #docs.extend(loader.load())
    # Load Web
    #loader = WebBaseLoader(WEB_URL)
    #docs.extend(loader.load())
    # Load YouTube
    #loader = GenericLoader(YoutubeAudioLoader([YOUTUBE_URL_1,YOUTUBE_URL_2], PATH_WORK + YOUTUBE_DIR), OpenAIWhisperParser())
    #docs.extend(loader.load())
    ################################
    # Document splitting
    text_splitter = RecursiveCharacterTextSplitter(chunk_overlap = 150, chunk_size = 1500)
    splits = text_splitter.split_documents(docs)
    
    return splits

###########################################
#Chroma DB die splits ablegen - vektorisiert...

def document_storage_chroma(splits):
    # Embedding-Funktion definieren
    embedding_fn = HuggingFaceEmbeddings(model_name=EMBEDDING_MODELL, model_kwargs={"device": "cpu"}, encode_kwargs={'normalize_embeddings': False})

    # Vectorstore initialisieren und Dokumente hinzufügen
    vectorstore = Chroma.from_documents(documents=splits, embedding=embedding_fn, persist_directory = PATH_WORK + CHROMA_DIR)
    retriever = vectorstore.as_retriever(search_kwargs = {"k": ANZAHL_DOCS})
    # Persist the vectorstore to disk
    vectorstore.persist()
    
    return vectorstore, retriever

############################################
#dokumente in chroma db vektorisiert ablegen können - die Db vorbereiten daüfur
"""
def document_retrieval_chroma(llm, prompt):  
    #HF embeddings -----------------------------------
    #Alternative Embedding - für Vektorstore, um Ähnlichkeitsvektoren zu erzeugen - die ...InstructEmbedding ist sehr rechenaufwendig
    #embeddings = HuggingFaceInstructEmbeddings(model_name="sentence-transformers/all-MiniLM-L6-v2", model_kwargs={"device": "cpu"})
    #etwas weniger rechenaufwendig:
    embeddings = HuggingFaceEmbeddings(model_name=EMBEDDING_MODELL, model_kwargs={"device": "cpu"}, encode_kwargs={'normalize_embeddings': False})

    #ChromaDb um die embedings zu speichern
    db = Chroma(embedding_function = embeddings, persist_directory = PATH_WORK + CHROMA_DIR)
    return db
"""



###############################################
#Langchain anlegen für RAG Chaining
###############################################
#langchain nutzen, um prompt an LLM zu leiten - llm und prompt sind austauschbar
def llm_chain(llm, prompt, context):
    # Generiere den vollständigen Prompt mit der Eingabe
    # Generiere den vollständigen Prompt mit den Eingabevariablen
    full_prompt = RAG_CHAIN_PROMPT.format(context=context, question=prompt)
    # Erstellen der RunnableSequence
    params={
        "input":  full_prompt,
        "llm": llm
    }
    sequence = RunnableSequence(params)
    result = sequence.invoke()
    return result

def query(api_llm, payload):
	response = requests.post(api_llm, headers=HEADERS, json=payload)
	return response.json()

def llm_chain2(prompt, context):
    full_prompt = RAG_CHAIN_PROMPT.format(context=context, question=prompt)
    inputs = tokenizer_rag(full_prompt, return_tensors="pt", max_length=1024, truncation=True)

    #Generiere die Antwort
    outputs = modell_rag.generate(inputs['input_ids'], max_new_tokens=1024, num_beams=2, early_stopping=True)
    answer = tokenizer_rag.decode(outputs[0], skip_special_tokens=True)
    
    return answer

    
#############################################
#langchain nutzen, um prompt an llm zu leiten, aber vorher in der VektorDB suchen, um passende splits zum Prompt hinzuzufügen
def rag_chain(llm, prompt,  retriever):
    #Langgraph nutzen für ein wenig mehr Intelligenz beim Dokumente suchen
    relevant_docs=[]
    most_relevant_docs=[]

    #passend zum Prompt relevante Dokuemnte raussuchen
    relevant_docs = retriever.invoke(prompt)
    #zu jedem relevanten Dokument die wichtigen Informationen zusammenstellen (im Dict)
    extracted_docs = extract_document_info(relevant_docs)
    
    if (len(extracted_docs)>0):
        # Inahlte Abrufen der relevanten Dokumente
        doc_contents = [doc["content"] for doc in extracted_docs]

        #Berechne die Ähnlichkeiten und finde das relevanteste Dokument
        question_embedding = embedder_modell.encode(prompt, convert_to_tensor=True)
        doc_embeddings = embedder_modell.encode(doc_contents, convert_to_tensor=True)
        similarity_scores = util.pytorch_cos_sim(question_embedding, doc_embeddings)
        most_relevant_doc_indices = similarity_scores.argsort(descending=True).squeeze().tolist()

        #Erstelle eine Liste der relevantesten Dokumente
        most_relevant_docs = [extracted_docs[i] for i in most_relevant_doc_indices]

        #Kombiniere die Inhalte aller relevanten Dokumente
        combined_content = " ".join([doc["content"] for doc in most_relevant_docs])
        

        #############################################
        #Verschiedene LLMs ausprobieren als Generierungsmodell
        #für die Zusammenfassung
        #############################################
        #1. Alternative, wenn llm direkt übergeben....................................
        answer = llm_chain2(prompt, combined_content)

        #Formuliere die Eingabe für das Generierungsmodell
        #input_text = f"frage: {prompt} kontext: {combined_content}"
        #2. Alternative, wenn mit API_URL ...........................................
        #answer =  query(llm, {"inputs": input_text,})
        
        #3. Alternative: mit pipeline
        #für summarizatiuon
        #answer = llm(input_text,max_length=1024, min_length=150, do_sample=False)

        # Erstelle das Ergebnis-Dictionary
        result = {
            "answer": answer,
            "relevant_docs": most_relevant_docs
        }
    else:
        # keine relevanten Dokumente gefunden
        result = {
            "answer": "Keine relevanten Dokumente gefunden",
            "relevant_docs": most_relevant_docs
        }
        
    return result



#############################################################
#in einem Dictionary die wichtigen Infos zu jedem Dok zusammenstellen
def extract_document_info(documents):
    extracted_info = []
    for doc in documents:
        # Extract the filename from the path to use as the title
        filename = os.path.basename(doc.metadata.get("path", ""))
        title = filename if filename else "Keine Überschrift"
        
        # Determine the document type and adjust the path accordingly
        doc_path = doc.metadata.get("path", "")
        if doc_path.endswith('.pdf'):
            download_link = f"https://huggingface.co/spaces/alexkueck/SucheRAG/resolve/main/chroma/kkg/pdf/{title}"
        elif doc_path.endswith('.docx'):
            download_link = f"https://huggingface.co/spaces/alexkueck/SucheRAG/resolve/main/chroma/kkg/word/{title}"
        else:
            download_link = doc_path
        
        info = {
            'content': doc.page_content,
            'metadata': doc.metadata,
            'titel': title,
            'seite': doc.metadata.get("page", "Unbekannte Seite"),
            'pfad': doc_path,
            'download_link': download_link
        }
        extracted_info.append(info)
    return extracted_info
 


###################################################
#Prompts mit History erzeugen für verschiednee Modelle
###################################################
#Funktion, die einen Prompt mit der history zusammen erzeugt - allgemein
def generate_prompt_with_history(text, history, max_length=4048):
    #prompt = "The following is a conversation between a human and an AI assistant named Baize (named after a mythical creature in Chinese folklore). Baize is an open-source AI assistant developed by UCSD and Sun Yat-Sen University. The human and the AI assistant take turns chatting. Human statements start with [|Human|] and AI assistant statements start with [|AI|]. The AI assistant always provides responses in as much detail as possible, and in Markdown format. The AI assistant always declines to engage with topics, questions and instructions related to unethical, controversial, or sensitive issues. Complete the transcript in exactly that format.\n[|Human|]Hello!\n[|AI|]Hi!"   
    #prompt = "Das folgende ist eine Unterhaltung in deutsch zwischen einem Menschen und einem KI-Assistenten, der Baize genannt wird. Baize ist ein open-source KI-Assistent, der von UCSD entwickelt wurde. Der Mensch und der KI-Assistent chatten abwechselnd miteinander in deutsch. Die Antworten des KI Assistenten sind immer so ausführlich wie möglich und in Markdown Schreibweise und in deutscher Sprache. Wenn nötig übersetzt er sie ins Deutsche. Die Antworten des KI-Assistenten vermeiden Themen und Antworten zu unethischen, kontroversen oder sensiblen Themen. Die Antworten sind immer sehr höflich formuliert..\n[|Human|]Hallo!\n[|AI|]Hi!"   
    prompt=""
    history = ["\n{}\n{}".format(x[0],x[1]) for x in history]
    history.append("\n{}\n".format(text))
    history_text = ""
    flag = False
    for x in history[::-1]:
            history_text = x + history_text
            flag = True
    if flag:
        return  prompt+history_text
    else:
        return None


#############################################
#Prompt und History für Hugging Face Schnittstelle
def generate_prompt_with_history_hf(prompt, history):
    history_transformer_format = history + [[prompt, ""]]
    #stop = StopOnTokens()

    messages = "".join(["".join(["\n<human>:"+item[0], "\n<bot>:"+item[1]])  #curr_system_message +
                for item in history_transformer_format])



##########################################
#Hashing.... Für die Validierung........
# Funktion zum Hashen des Eingabewerts
def hash_input(input_string):
    return hashlib.sha256(input_string.encode()).hexdigest()


    
########################################
#zur Zeit nicht im Gebrauch
def transfer_input(inputs):
    textbox = reset_textbox()
    return (
        inputs,
        gr.update(value=""),
        gr.Button.update(visible=True),
    )


########################################################
######## Hilfsfunktionen Datei-Upload ##################
# Hochladen von Dateien
def upload_pdf(file):
    if file is None:
        return None, "Keine Datei hochgeladen."
    
    # Extrahieren des Dateinamens aus dem vollen Pfad
    filename = os.path.basename(file.name)
    
    # Datei zum Hugging Face Space hochladen
    upload_path = f"kkg_dokumente/{filename}"
    api.upload_file(
        path_or_fileobj=file.name,
        path_in_repo=upload_path,
        repo_id=REPO_ID,
        repo_type=REPO_TYPE,
        token=HF_WRITE
    )
    return f"PDF '{filename}' erfolgreich hochgeladen."

def display_files():
    files = os.listdir(DOCS_DIR)
    files_table = "<table style='width:100%; border-collapse: collapse;'>"
    files_table += "<tr style='background-color: #930BBA; color: white; font-weight: bold; font-size: larger;'><th>Dateiname</th><th>Größe (KB)</th></tr>"
    for i, file in enumerate(files):
        file_path = os.path.join(DOCS_DIR, file)
        file_size = os.path.getsize(file_path) / 1024  # Größe in KB
        row_color = "#4f4f4f" if i % 2 == 0 else "#3a3a3a"  # Wechselnde Zeilenfarben
        files_table += f"<tr style='background-color: {row_color}; border-bottom: 1px solid #ddd;'>"
        files_table += f"<td><b>{download_link(file)}</b></td>"
        files_table += f"<td>{file_size:.2f}</td></tr>"
    files_table += "</table>"
    return files_table


# gefundene relevante Dokumente auflisten (links)
def list_pdfs():
    if not os.path.exists(DOCS_DIR):
        return []
    return [f for f in os.listdir(SAVE_DIR) if f.endswith('.pdf')]


#################################################
#Klasse mit zuständen - z.B. für interrupt wenn Stop gedrückt...
#################################################
class State:
    interrupted = False

    def interrupt(self):
        self.interrupted = True

    def recover(self):
        self.interrupted = False
shared_state = State()


#Für die relevanten Dokumente - damit sie passend zum Dictionary die Attribute haben
class Document:
    def __init__(self, content, title, page, path):
        self.page_content = content
        self.metadata = {
            "title": title,
            "page": page,
            "path": path
        }




def is_stop_word_or_prefix(s: str, stop_words: list) -> bool:
    for stop_word in stop_words:
        if s.endswith(stop_word):
            return True
        for i in range(1, len(stop_word)):
            if s.endswith(stop_word[:i]):
                return True
    return False