File size: 23,327 Bytes
8d12b8e |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 |
import os
os.environ["TOKENIZERS_PARALLELISM"] = "false"
import datetime
import functools
import traceback
from typing import List, Optional, Any, Dict
import torch
import transformers
from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
from langchain_community.llms import HuggingFacePipeline
# Other LangChain and community imports
from langchain_community.document_loaders import OnlinePDFLoader
from langchain.text_splitter import RecursiveCharacterTextSplitter
from langchain_community.vectorstores import FAISS
from langchain.embeddings import HuggingFaceEmbeddings
from langchain_community.retrievers import BM25Retriever
from langchain.retrievers import EnsembleRetriever
from langchain.prompts import ChatPromptTemplate
from langchain.schema import StrOutputParser, Document
from langchain_core.runnables import RunnableParallel, RunnablePassthrough, RunnableLambda
from transformers.quantizers.auto import AutoQuantizationConfig
import gradio as gr
import requests
# Add Mistral imports with fallback handling
try:
# Try importing from the latest package structure
from mistralai import Mistral
MISTRAL_AVAILABLE = True
debug_print = lambda msg: print(f"[{datetime.datetime.now().isoformat()}] {msg}")
debug_print("Loaded latest Mistral client library")
except ImportError:
MISTRAL_AVAILABLE = False
debug_print = lambda msg: print(f"[{datetime.datetime.now().isoformat()}] {msg}")
debug_print("Mistral client library not found. Install with: pip install mistralai")
# Debug print function (already defined above in the try block)
def debug_print(message: str):
print(f"[{datetime.datetime.now().isoformat()}] {message}")
def word_count(text: str) -> int:
return len(text.split())
# Initialize tokenizer for counting
def initialize_tokenizer():
try:
return AutoTokenizer.from_pretrained("gpt2")
except Exception as e:
debug_print("Failed to initialize tokenizer: " + str(e))
return None
global_tokenizer = initialize_tokenizer()
def count_tokens(text: str) -> int:
if global_tokenizer:
try:
return len(global_tokenizer.encode(text))
except Exception as e:
return len(text.split())
return len(text.split())
# Updated prompt template to include conversation history
default_prompt = """\
{conversation_history}
Use the following context to provide a detailed technical answer to the user's question.
Do not include an introduction like "Based on the provided documents, ...". Just answer the question.
If you don't know the answer, please respond with "I don't know".
Context:
{context}
User's question:
{question}
"""
# Helper function to load TXT files from URL with error checking
def load_txt_from_url(url: str) -> Document:
response = requests.get(url)
if response.status_code == 200:
text = response.text.strip()
if not text:
raise ValueError(f"TXT file at {url} is empty.")
return Document(page_content=text, metadata={"source": url})
else:
raise Exception(f"Failed to load {url} with status {response.status_code}")
class ElevatedRagChain:
def __init__(self, llm_choice: str = "Meta-Llama-3", prompt_template: str = default_prompt,
bm25_weight: float = 0.6, temperature: float = 0.5, top_p: float = 0.95) -> None:
debug_print(f"Initializing ElevatedRagChain with model: {llm_choice}")
# Check for required API keys based on model choice
if "mistral-api" in llm_choice.lower() and not os.environ.get("MISTRAL_API_KEY"):
debug_print("WARNING: Mistral API selected but MISTRAL_API_KEY environment variable not set")
if not MISTRAL_AVAILABLE:
debug_print("WARNING: Mistral API package not installed. Install with: pip install mistralai")
self.embed_func = HuggingFaceEmbeddings(
model_name="sentence-transformers/all-MiniLM-L6-v2",
model_kwargs={"device": "cpu"}
)
self.bm25_weight = bm25_weight
self.faiss_weight = 1.0 - bm25_weight
self.top_k = 5
self.llm_choice = llm_choice
self.temperature = temperature
self.top_p = top_p
self.prompt_template = prompt_template
self.context = ""
self.conversation_history: List[Dict[str, str]] = [] # List of dicts with keys "query" and "response"
def create_llm_pipeline(self):
if "remote" in self.llm_choice.lower():
debug_print("Creating remote Meta-Llama-3 pipeline via Hugging Face Inference API...")
from huggingface_hub import InferenceClient
repo_id = "meta-llama/Meta-Llama-3-8B-Instruct"
hf_api_token = os.environ.get("HF_API_TOKEN")
if not hf_api_token:
raise ValueError("Please set the HF_API_TOKEN environment variable to use remote inference.")
client = InferenceClient(token=hf_api_token)
def remote_generate(prompt: str) -> str:
response = client.text_generation(
prompt,
model=repo_id,
# max_new_tokens=512,
temperature=self.temperature,
top_p=self.top_p,
repetition_penalty=1.1
)
return response
from langchain.llms.base import LLM
class RemoteLLM(LLM):
@property
def _llm_type(self) -> str:
return "remote_llm"
def _call(self, prompt: str, stop: Optional[List[str]] = None) -> str:
return remote_generate(prompt)
@property
def _identifying_params(self) -> dict:
return {"model": repo_id}
debug_print("Remote Meta-Llama-3 pipeline created successfully.")
return RemoteLLM()
elif "mistral-api" in self.llm_choice.lower():
debug_print("Creating Mistral API pipeline...")
mistral_api_key = os.environ.get("MISTRAL_API_KEY")
if not mistral_api_key:
raise ValueError("Please set the MISTRAL_API_KEY environment variable to use Mistral API.")
if not MISTRAL_AVAILABLE:
raise ImportError("Mistral client library not installed. Install with: pip install mistralai")
# Initialize the Mistral client with latest API
mistral_client = Mistral(api_key=mistral_api_key)
# Define the model to use - updated to match current model names
mistral_model = "mistral-small-latest"
from langchain.llms.base import LLM
class MistralLLM(LLM):
temperature: float = 0.7
top_p: float = 0.95
def __init__(self, api_key: str, temperature: float = 0.7, top_p: float = 0.95):
super().__init__() # Important to call the parent constructor
self.client = Mistral(api_key=api_key)
self.temperature = temperature
self.top_p = top_p
@property
def _llm_type(self) -> str:
return "mistral_llm"
def _call(self, prompt: str, stop: Optional[List[str]] = None) -> str:
response = self.client.chat.complete(
model="mistral-small-latest", # Replace with the actual model name if different
messages=[{"role": "user", "content": prompt}],
temperature=self.temperature,
top_p=self.top_p,
max_tokens=512
)
return response.choices[0].message.content
@property
def _identifying_params(self) -> dict:
return {"model": "mistral-small-latest"}
# Initialize and return the MistralLLM instance
mistral_llm = MistralLLM(api_key=mistral_api_key, temperature=self.temperature, top_p=self.top_p)
debug_print("Mistral API pipeline created successfully.")
return mistral_llm
else:
model_id = "meta-llama/Meta-Llama-3-8B-Instruct"
if "deepseek" in self.llm_choice.lower():
model_id = "deepseek-ai/DeepSeek-R1"
elif "gemini" in self.llm_choice.lower():
model_id = "gemini/flash-1.5"
elif "mistralai" in self.llm_choice.lower():
model_id = "mistralai/Mistral-Small-24B-Instruct-2501"
pipe = pipeline(
"text-generation",
model=model_id,
model_kwargs={"torch_dtype": torch.bfloat16},
max_length=4096,
do_sample=True,
temperature=self.temperature,
top_p=self.top_p,
device=-1
)
return HuggingFacePipeline(pipeline=pipe)
def add_pdfs_to_vectore_store(self, file_links: List[str]) -> None:
debug_print(f"Processing files using {self.llm_choice}")
self.raw_data = []
for link in file_links:
if link.lower().endswith(".pdf"):
debug_print(f"Loading PDF: {link}")
# Ensure that the PDF loader returns a non-empty list.
loaded_docs = OnlinePDFLoader(link).load()
if loaded_docs:
self.raw_data.append(loaded_docs[0])
else:
debug_print(f"No content found in PDF: {link}")
elif link.lower().endswith(".txt") or link.lower().endswith(".utf-8"):
debug_print(f"Loading TXT: {link}")
try:
self.raw_data.append(load_txt_from_url(link))
except Exception as e:
debug_print(f"Error loading TXT file {link}: {e}")
else:
debug_print(f"File type not supported for URL: {link}")
if not self.raw_data:
raise ValueError("No files were successfully loaded. Please check the URLs and file formats.")
debug_print("Files loaded successfully.")
debug_print("Starting text splitting...")
self.text_splitter = RecursiveCharacterTextSplitter(chunk_size=1500, chunk_overlap=100)
self.split_data = self.text_splitter.split_documents(self.raw_data)
if not self.split_data:
raise ValueError("Text splitting resulted in no chunks. Check the file contents.")
debug_print(f"Text splitting completed. Number of chunks: {len(self.split_data)}")
debug_print("Creating BM25 retriever...")
self.bm25_retriever = BM25Retriever.from_documents(self.split_data)
self.bm25_retriever.k = self.top_k
debug_print("BM25 retriever created.")
debug_print("Embedding chunks and creating FAISS vector store...")
self.vector_store = FAISS.from_documents(self.split_data, self.embed_func)
self.faiss_retriever = self.vector_store.as_retriever(search_kwargs={"k": self.top_k})
debug_print("FAISS vector store created successfully.")
ensemble = EnsembleRetriever(
retrievers=[self.bm25_retriever, self.faiss_retriever],
weights=[self.bm25_weight, self.faiss_weight]
)
def capture_context(result):
# Convert each Document to a string and update the context.
self.context = "\n".join([str(doc) for doc in result["context"]])
result["context"] = self.context
# Add conversation_history from self.conversation_history (if any) as a string.
history_text = (
"\n".join([f"Q: {conv['query']}\nA: {conv['response']}" for conv in self.conversation_history])
if self.conversation_history else ""
)
result["conversation_history"] = history_text
return result
def extract_question(input_data):
# Expecting input_data to be a dict with a key "question"
return input_data["question"]
# Build the chain so that the ensemble (BM25 + FAISS) gets only the question string.
base_runnable = RunnableParallel({
"context": RunnableLambda(extract_question) | ensemble,
"question": RunnableLambda(extract_question)
}) | capture_context
self.rag_prompt = ChatPromptTemplate.from_template(self.prompt_template)
self.str_output_parser = StrOutputParser()
debug_print("Selecting LLM pipeline based on choice: " + self.llm_choice)
self.llm = self.create_llm_pipeline()
def format_response(response: str) -> str:
input_tokens = count_tokens(self.context + self.prompt_template)
output_tokens = count_tokens(response)
# Format the response as Markdown for better visual rendering
formatted = f"### Response\n\n{response}\n\n---\n"
formatted += f"- **Input tokens:** {input_tokens}\n"
formatted += f"- **Output tokens:** {output_tokens}\n"
formatted += f"- **Generated using:** {self.llm_choice}\n"
# Append conversation history summary
formatted += f"\n**Conversation History:** {len(self.conversation_history)} conversation(s) considered.\n"
return formatted
self.elevated_rag_chain = base_runnable | self.rag_prompt | self.llm | format_response
debug_print("Elevated RAG chain successfully built and ready to use.")
def get_current_context(self) -> str:
# Show a sample of the document context along with a summary of conversation history.
base_context = "\n".join([str(doc) for doc in self.split_data[:3]]) if hasattr(self, "split_data") and self.split_data else "No context available."
history_summary = "\n\n---\n**Recent Conversations (last 3):**\n"
recent = self.conversation_history[-3:]
if recent:
for i, conv in enumerate(recent, 1):
history_summary += f"**Conversation {i}:**\n- Query: {conv['query']}\n- Response: {conv['response']}\n"
else:
history_summary += "No conversation history."
return base_context + history_summary
# ----------------------------
# Gradio Interface Functions
# ----------------------------
global rag_chain
rag_chain = ElevatedRagChain()
def load_pdfs_updated(file_links, model_choice, prompt_template, bm25_weight, temperature, top_p):
debug_print("Inside load_pdfs function.")
if not file_links:
debug_print("Please enter non-empty URLs")
return "Please enter non-empty URLs", "Word count: N/A", "Model used: N/A", "Context: N/A"
try:
links = [link.strip() for link in file_links.split("\n") if link.strip()]
global rag_chain
rag_chain = ElevatedRagChain(
llm_choice=model_choice,
prompt_template=prompt_template,
bm25_weight=bm25_weight,
temperature=temperature,
top_p=top_p
)
rag_chain.add_pdfs_to_vectore_store(links)
context_display = rag_chain.get_current_context()
response_msg = f"Files loaded successfully. Using model: {model_choice}"
debug_print(response_msg)
return (
response_msg,
f"Word count: {word_count(rag_chain.context)}",
f"Model used: {rag_chain.llm_choice}",
f"Context:\n{context_display}"
)
except Exception as e:
error_msg = traceback.format_exc()
debug_print("Could not load files. Error: " + error_msg)
return (
"Error loading files: " + str(e),
f"Word count: {word_count('')}",
f"Model used: {rag_chain.llm_choice}",
"Context: N/A"
)
def submit_query_updated(query):
debug_print("Inside submit_query function.")
if not query:
debug_print("Please enter a non-empty query")
return "Please enter a non-empty query", "Word count: 0", f"Model used: {rag_chain.llm_choice}", ""
if hasattr(rag_chain, 'elevated_rag_chain'):
try:
# Incorporate conversation history by joining previous Q&A pairs.
history_text = ""
if rag_chain.conversation_history:
history_text = "\n".join([f"Q: {conv['query']}\nA: {conv['response']}" for conv in rag_chain.conversation_history])
# Build the prompt variables dictionary for the chain.
prompt_variables = {
"conversation_history": history_text,
"context": rag_chain.context,
"question": query
}
response = rag_chain.elevated_rag_chain.invoke(prompt_variables)
# Save the current conversation to history
rag_chain.conversation_history.append({"query": query, "response": response})
input_token_count = count_tokens(query)
output_token_count = count_tokens(response)
return (
response,
rag_chain.get_current_context(),
f"Input tokens: {input_token_count}",
f"Output tokens: {output_token_count}"
)
except Exception as e:
error_msg = traceback.format_exc()
debug_print("LLM error. Error: " + error_msg)
return (
"Query error: " + str(e),
"",
"Input tokens: 0",
"Output tokens: 0"
)
return (
"Please load files first.",
"",
"Input tokens: 0",
"Output tokens: 0"
)
def reset_app_updated():
global rag_chain
rag_chain = ElevatedRagChain()
debug_print("App reset successfully.")
return (
"App reset successfully. You can now load new files",
"",
"Model used: Not selected"
)
# ----------------------------
# Gradio Interface Setup
# ----------------------------
custom_css = """
button {
background-color: grey !important;
font-family: Arial !important;
font-weight: bold !important;
color: blue !important;
}
"""
with gr.Blocks(css=custom_css) as app:
gr.Markdown('''# PhiRAG
**PhiRAG** Query Your Data with Advanced RAG Techniques
**Model Selection & Parameters:** Choose from the following options:
- ๐บ๐ธ Remote Meta-Llama-3
- ๐ช๐บ Mistral-API
**๐ฅ Randomness (Temperature):** Temperature adjusts how predictable or varied the output is. A low temperature makes the model choose very predictable words (which can be repetitive), while a high temperature introduces more randomness for diverse, creative text.
**๐ฏ Word Variety (Topโp):** Topโp limits the modelโs word choices to those that make up a set percentage (p) of the total probability. Lower values yield focused outputs; higher values increase variety and creativity.
**โ๏ธ Prompt Template:** Edit the prompt template if desired.
**๐ File URLs:** Enter one or more file URLs (PDF or TXT, one per line).
**โ๏ธ Weight Controls:** Adjust Lexical vs Semantics (BM25 Weight).
**๐ Query:** Enter your query below.
The response displays the model used, word count, and the current context (including conversation history).
"""
''')
with gr.Row():
with gr.Column():
model_dropdown = gr.Dropdown(
choices=[
"๐บ๐ธ Remote Meta-Llama-3",
"๐ช๐บ Mistral-API"
# "DeepSeek-R1", # Option commented out
# "Gemini Flash 1.5", # Option commented out
# "Mistralai/Mistral-Small-24B-Instruct-2501" # Option commented out
],
value="๐บ๐ธ Remote Meta-Llama-3",
label="Select Model"
)
temperature_slider = gr.Slider(
minimum=0.1, maximum=1.0, value=0.5, step=0.1,
label="Randomness (Temperature)"
)
top_p_slider = gr.Slider(
minimum=0.1, maximum=0.99, value=0.95, step=0.05,
label="Word Variety (Top-p)"
)
with gr.Column():
pdf_input = gr.Textbox(
label="Enter your file URLs (one per line)",
placeholder="Enter one URL per line (.pdf or .txt)",
lines=4
)
prompt_input = gr.Textbox(
label="Custom Prompt Template",
placeholder="Enter your custom prompt template here",
lines=8,
value=default_prompt
)
with gr.Column():
bm25_weight_slider = gr.Slider(
minimum=0.0, maximum=1.0, value=0.6, step=0.1,
label="Lexical vs Semantics (BM25 Weight)"
)
load_button = gr.Button("Load Files")
with gr.Row():
with gr.Column():
query_input = gr.Textbox(
label="Enter your query here",
placeholder="Type your query",
lines=4
)
submit_button = gr.Button("Submit")
with gr.Column():
reset_button = gr.Button("Reset App")
with gr.Row():
response_output = gr.Textbox(
label="Response",
placeholder="Response will appear here (formatted as Markdown)",
lines=6
)
context_output = gr.Textbox(
label="Current Context",
placeholder="Retrieved context and conversation history will appear here",
lines=6
)
with gr.Row():
input_tokens = gr.Markdown("Input tokens: 0")
output_tokens = gr.Markdown("Output tokens: 0")
model_output = gr.Markdown("**Current Model**: Not selected")
load_button.click(
load_pdfs_updated,
inputs=[pdf_input, model_dropdown, prompt_input, bm25_weight_slider, temperature_slider, top_p_slider],
outputs=[response_output, context_output, model_output]
)
submit_button.click(
submit_query_updated,
inputs=[query_input],
outputs=[response_output, context_output, input_tokens, output_tokens]
)
reset_button.click(
reset_app_updated,
inputs=[],
outputs=[response_output, context_output, model_output]
)
if __name__ == "__main__":
debug_print("Launching Gradio interface.")
app.launch(share=True)
|