Spaces:
Running
Running
File size: 19,760 Bytes
0e9afe0 | 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 | """Document query helper with thread-safe parsers and configurable timeouts.
Extracted from the monolithic helpers/document_query.py into a plugin
with parser strategy pattern where every document parser is offloaded to
a thread pool and bounded by configurable timeouts.
"""
import asyncio
import json
import threading
from datetime import datetime
from typing import Any, Callable, List, Optional, Sequence, Tuple
from urllib.parse import urlparse
from langchain.schema import SystemMessage, HumanMessage
from langchain.text_splitter import RecursiveCharacterTextSplitter
from langchain_core.documents import Document
from helpers import files, errors
from helpers.print_style import PrintStyle
from helpers.vector_db import VectorDB
from agent import Agent
from plugins._document_query.helpers.fetch import FetchedDocument, fetch_public_resource
from plugins._document_query.helpers.parsers import BaseParser, get_parsers_for_mimetype
DEFAULT_SEARCH_THRESHOLD = 0.5
DEFAULT_PARSER_CONCURRENCY = 1
SMALL_DOCUMENT_FALLBACK_MAX_CHARS = 12000
_PARSER_SEMAPHORES: dict[tuple[int, int], asyncio.Semaphore] = {}
_PARSER_SEMAPHORES_LOCK = threading.Lock()
def _positive_int(value: Any, default: int) -> int:
try:
parsed = int(value)
except (TypeError, ValueError):
return default
return parsed if parsed > 0 else default
def _nonnegative_int(value: Any, default: int) -> int:
try:
parsed = int(value)
except (TypeError, ValueError):
return default
return parsed if parsed >= 0 else default
def _parser_semaphore(config: dict) -> asyncio.Semaphore:
concurrency = _positive_int(
config.get("parser_concurrency"),
DEFAULT_PARSER_CONCURRENCY,
)
loop = asyncio.get_running_loop()
key = (id(loop), concurrency)
with _PARSER_SEMAPHORES_LOCK:
semaphore = _PARSER_SEMAPHORES.get(key)
if semaphore is None:
semaphore = asyncio.Semaphore(concurrency)
_PARSER_SEMAPHORES[key] = semaphore
return semaphore
def _load_config(agent: Agent) -> dict:
"""Load plugin config with fallback to defaults."""
from helpers.plugins import get_plugin_config
return get_plugin_config("_document_query", agent=agent) or {}
class DocumentQueryStore:
"""FAISS Store for document query results."""
CONTEXT_DATA_KEY = "_document_query_store"
DEFAULT_CHUNK_SIZE = 1000
DEFAULT_CHUNK_OVERLAP = 100
DEFAULT_MAX_INDEX_CHUNKS = 1200
_GET_LOCK = threading.RLock()
@classmethod
def get(cls, agent: Agent):
if not agent or not agent.config:
raise ValueError("Agent and agent config must be provided")
context = getattr(agent, "context", None)
if context is None:
return cls(agent)
with cls._GET_LOCK:
store = context.get_data(cls.CONTEXT_DATA_KEY, recursive=False)
if not isinstance(store, cls):
store = cls(agent)
context.set_data(cls.CONTEXT_DATA_KEY, store, recursive=False)
else:
store.agent = agent
store.config = _load_config(agent)
return store
def __init__(self, agent: Agent):
self.agent = agent
self.vector_db: VectorDB | None = None
self.config = _load_config(agent)
@staticmethod
def normalize_uri(uri: str) -> str:
normalized = uri.strip()
parsed = urlparse(normalized)
scheme = parsed.scheme or "file"
if scheme == "file":
path = files.fix_dev_path(
normalized.removeprefix("file://").removeprefix("file:")
)
normalized = f"file://{path}"
elif scheme in ["http", "https"]:
normalized = normalized.replace("http://", "https://")
return normalized
def init_vector_db(self):
return VectorDB(self.agent, cache=True)
async def add_document(
self, text: str, document_uri: str, metadata: dict | None = None
) -> tuple[bool, list[str]]:
document_uri = self.normalize_uri(document_uri)
await self.delete_document(document_uri)
doc_metadata = metadata or {}
doc_metadata["document_uri"] = document_uri
doc_metadata["timestamp"] = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
chunks = self._split_text_for_index(text)
docs = []
for i, chunk in enumerate(chunks):
chunk_metadata = doc_metadata.copy()
chunk_metadata["chunk_index"] = i
chunk_metadata["total_chunks"] = len(chunks)
docs.append(Document(page_content=chunk, metadata=chunk_metadata))
if not docs:
PrintStyle.error(f"No chunks created for document: {document_uri}")
return False, []
try:
if not self.vector_db:
self.vector_db = self.init_vector_db()
ids = await self.vector_db.insert_documents(docs)
PrintStyle.standard(f"Added document '{document_uri}' with {len(docs)} chunks")
return True, ids
except Exception as e:
err_text = errors.format_error(e)
PrintStyle.error(f"Error adding document '{document_uri}': {err_text}")
return False, []
def _split_text_for_index(self, text: str) -> list[str]:
chunk_size = _positive_int(
self.config.get("chunk_size"),
self.DEFAULT_CHUNK_SIZE,
)
chunk_overlap = min(
_nonnegative_int(
self.config.get("chunk_overlap"),
self.DEFAULT_CHUNK_OVERLAP,
),
max(0, chunk_size - 1),
)
chunks = self._split_text(text, chunk_size, chunk_overlap)
max_chunks = _nonnegative_int(
self.config.get("max_index_chunks"),
self.DEFAULT_MAX_INDEX_CHUNKS,
)
if not max_chunks or len(chunks) <= max_chunks:
return chunks
overlap_ratio = chunk_overlap / chunk_size if chunk_size else 0
overlap_ratio = max(0, min(overlap_ratio, 0.5))
target_size = max(
chunk_size + 1,
int(len(text) / max(1, max_chunks * (1 - overlap_ratio))) + 1,
)
for _ in range(8):
target_overlap = min(int(target_size * overlap_ratio), target_size - 1)
chunks = self._split_text(text, target_size, target_overlap)
if len(chunks) <= max_chunks or target_size >= len(text):
return chunks
target_size = min(len(text), int(target_size * 1.25) + 1)
return chunks
@staticmethod
def _split_text(text: str, chunk_size: int, chunk_overlap: int) -> list[str]:
text_splitter = RecursiveCharacterTextSplitter(
chunk_size=chunk_size,
chunk_overlap=chunk_overlap,
)
return text_splitter.split_text(text)
async def get_document(self, document_uri: str) -> Optional[Document]:
if not self.vector_db:
return None
document_uri = self.normalize_uri(document_uri)
docs = await self._get_document_chunks(document_uri)
if not docs:
return None
chunks = sorted(docs, key=lambda x: x.metadata.get("chunk_index", 0))
full_content = "\n".join(chunk.page_content for chunk in chunks)
metadata = chunks[0].metadata.copy()
metadata.pop("chunk_index", None)
metadata.pop("total_chunks", None)
return Document(page_content=full_content, metadata=metadata)
async def _get_document_chunks(self, document_uri: str) -> List[Document]:
if not self.vector_db:
return []
document_uri = self.normalize_uri(document_uri)
chunks = await self.vector_db.search_by_metadata(
filter=f"document_uri == '{document_uri}'",
)
PrintStyle.standard(f"Found {len(chunks)} chunks for document: {document_uri}")
return chunks
async def document_exists(self, document_uri: str) -> bool:
if not self.vector_db:
return False
document_uri = self.normalize_uri(document_uri)
chunks = await self._get_document_chunks(document_uri)
return len(chunks) > 0
async def delete_document(self, document_uri: str) -> bool:
if not self.vector_db:
return False
document_uri = self.normalize_uri(document_uri)
chunks = await self.vector_db.search_by_metadata(
filter=f"document_uri == '{document_uri}'",
)
if not chunks:
return False
ids_to_delete = [chunk.metadata["id"] for chunk in chunks]
if ids_to_delete:
dels = await self.vector_db.delete_documents_by_ids(ids_to_delete)
PrintStyle.standard(f"Deleted document '{document_uri}' with {len(dels)} chunks")
return True
return False
async def search_documents(
self, query: str, limit: int = 10, threshold: float = 0.5, filter: str = ""
) -> List[Document]:
if not self.vector_db:
return []
if not query:
return []
try:
results = await self.vector_db.search_by_similarity_threshold(
query=query, limit=limit, threshold=threshold, filter=filter
)
PrintStyle.standard(f"Search '{query}' returned {len(results)} results")
return results
except Exception as e:
PrintStyle.error(f"Error searching documents: {str(e)}")
return []
async def search_document(
self, document_uri: str, query: str, limit: int = 10, threshold: float = 0.5
) -> List[Document]:
return await self.search_documents(
query, limit, threshold, f"document_uri == '{document_uri}'"
)
async def list_documents(self) -> List[str]:
if not self.vector_db:
return []
uris = set()
for doc in self.vector_db.db.get_all_docs().values():
if isinstance(doc.metadata, dict):
uri = doc.metadata.get("document_uri")
if uri:
uris.add(uri)
return sorted(list(uris))
class DocumentQueryHelper:
def __init__(
self, agent: Agent, progress_callback: Callable[[str], None] | None = None
):
self.agent = agent
self.store = DocumentQueryStore.get(agent)
self.progress_callback = progress_callback or (lambda x: None)
self.store_lock = asyncio.Lock()
self.config = _load_config(agent)
async def document_qa(
self, document_uris: List[str] | str, questions: Sequence[str] | str
) -> Tuple[bool, str]:
if isinstance(document_uris, str):
document_uris = [document_uris]
if isinstance(questions, str):
questions = [questions]
self.progress_callback(f"Starting Q&A process for {len(document_uris)} documents")
await self.agent.handle_intervention()
gather_timeout = self.config.get("gather_timeout", 120)
try:
document_contents = await asyncio.wait_for(
asyncio.gather(
*[self.document_get_content(uri, True) for uri in document_uris]
),
timeout=gather_timeout,
)
except asyncio.TimeoutError:
raise ValueError(f"Document indexing timed out after {gather_timeout}s")
await self.agent.handle_intervention()
search_threshold = self.config.get("search_threshold", DEFAULT_SEARCH_THRESHOLD)
search_limit = self.config.get("search_limit", 100)
selected_chunks = {}
normalized_uris = [self.store.normalize_uri(uri) for uri in document_uris]
intro_chunk_count = _positive_int(
self.config.get("context_intro_chunks"),
2,
)
for uri in normalized_uris:
for chunk in await self._get_document_intro_chunks(uri, intro_chunk_count):
selected_chunks[chunk.metadata["id"]] = chunk
for question in questions:
self.progress_callback(f"Optimizing query: {question}")
await self.agent.handle_intervention()
system_content = self.agent.parse_prompt("fw.document_query.optimize_query.md")
optimized_query = (
await self.agent.call_utility_model(
system=system_content, message=f'Search Query: "{question}"',
)
).strip()
await self.agent.handle_intervention()
self.progress_callback(f"Searching documents with query: {optimized_query}")
doc_filter = " or ".join(
[f"document_uri == '{uri}'" for uri in normalized_uris]
)
chunks = await self.store.search_documents(
query=optimized_query, limit=search_limit,
threshold=search_threshold, filter=doc_filter,
)
self.progress_callback(f"Found {len(chunks)} chunks")
for chunk in chunks:
selected_chunks[chunk.metadata["id"]] = chunk
if not selected_chunks:
fallback_content = self._small_document_fallback_content(
document_uris,
document_contents,
)
if fallback_content:
self.progress_callback(
"No matching chunks found; using extracted document content"
)
ai_response = await self._answer_questions_from_content(
fallback_content,
questions,
"extracted document content",
)
self.progress_callback(f"Q&A process completed")
return True, ai_response
self.progress_callback("No relevant content found in the documents")
content = f"!!! No content found for documents: {json.dumps(document_uris)} matching queries: {json.dumps(questions)}"
return False, content
content = "\n\n----\n\n".join(
[chunk.page_content for chunk in selected_chunks.values()]
)
ai_response = await self._answer_questions_from_content(
content,
questions,
f"{len(selected_chunks)} chunks",
)
self.progress_callback(f"Q&A process completed")
return True, ai_response
async def _answer_questions_from_content(
self,
content: str,
questions: Sequence[str],
context_label: str,
) -> str:
self.progress_callback(
f"Processing {len(questions)} questions in context of {context_label}"
)
await self.agent.handle_intervention()
questions_str = "\n".join([f" * {question}" for question in questions])
qa_system_message = self.agent.parse_prompt("fw.document_query.system_prompt.md")
qa_user_message = f"# Document:\n{content}\n\n# Queries:\n{questions_str}"
ai_response, _reasoning = await self.agent.call_chat_model(
messages=[
SystemMessage(content=qa_system_message),
HumanMessage(content=qa_user_message),
],
explicit_caching=False,
)
return str(ai_response)
@staticmethod
def _small_document_fallback_content(
document_uris: Sequence[str],
document_contents: Sequence[str],
max_chars: int = SMALL_DOCUMENT_FALLBACK_MAX_CHARS,
) -> str:
blocks = []
for document_uri, document_content in zip(document_uris, document_contents):
text = (document_content or "").strip()
if text:
blocks.append(f"# Source: {document_uri}\n\n{text}")
if not blocks:
return ""
content = "\n\n----\n\n".join(blocks)
if len(content) > max_chars:
return ""
return content
async def _get_document_intro_chunks(
self,
document_uri: str,
limit: int,
) -> list[Document]:
if limit <= 0:
return []
if not hasattr(self.store, "_get_document_chunks"):
return []
chunks = await self.store._get_document_chunks(document_uri)
return sorted(chunks, key=lambda chunk: chunk.metadata.get("chunk_index", 0))[
:limit
]
async def document_get_content(
self, document_uri: str, add_to_db: bool = False
) -> str:
self.progress_callback(f"Fetching document content")
await self.agent.handle_intervention()
document = await fetch_public_resource(
document_uri,
self.config,
self.agent.handle_intervention,
)
document_uri_norm = self.store.normalize_uri(document.uri)
await self.agent.handle_intervention()
exists = await self.store.document_exists(document_uri_norm)
document_content = ""
if not exists:
await self.agent.handle_intervention()
parsers = get_parsers_for_mimetype(document.mimetype, self.config)
if not parsers:
raise ValueError(
f"No parser found for mimetype '{document.mimetype}' ({document.uri})"
)
per_doc_timeout = self.config.get("per_document_timeout", 60)
thread_offload = self.config.get("thread_offload", True)
document_content = await self._parse_document(
document=document,
parsers=parsers,
timeout=per_doc_timeout,
thread_offload=thread_offload,
)
if add_to_db:
self.progress_callback(f"Indexing document")
await self.agent.handle_intervention()
async with self.store_lock:
success, ids = await self.store.add_document(
document_content, document_uri_norm
)
if not success:
self.progress_callback(f"Failed to index document")
raise ValueError(f"Failed to index document: {document_uri_norm}")
self.progress_callback(f"Indexed {len(ids)} chunks")
else:
await self.agent.handle_intervention()
doc = await self.store.get_document(document_uri_norm)
if doc:
document_content = doc.page_content
else:
raise ValueError(f"Document not found: {document_uri_norm}")
return document_content
async def _parse_document(
self,
document: FetchedDocument,
parsers: list[BaseParser],
timeout: float,
thread_offload: bool,
) -> str:
errors_seen = []
semaphore = _parser_semaphore(self.config)
for parser in parsers:
try:
async with semaphore:
self.progress_callback("Parsing document content")
content = await parser.parse(
document=document,
config=self.config,
timeout=timeout,
thread_offload=thread_offload,
)
if content:
return content
errors_seen.append(f"{parser.__class__.__name__}: no content")
except Exception as e:
errors_seen.append(f"{parser.__class__.__name__}: {e}")
PrintStyle.error(f"Document parser failed: {errors_seen[-1]}")
raise ValueError(
f"No parser succeeded for mimetype '{document.mimetype}' ({document.uri}): "
+ "; ".join(errors_seen)
)
|