middleware.py 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170
  1. import time
  2. import logging
  3. import sys
  4. import asyncio
  5. from aiocache import cached
  6. from typing import Any, Optional
  7. import random
  8. import json
  9. import inspect
  10. from uuid import uuid4
  11. from concurrent.futures import ThreadPoolExecutor
  12. from fastapi import Request
  13. from fastapi import BackgroundTasks
  14. from starlette.responses import Response, StreamingResponse
  15. from open_webui.models.chats import Chats
  16. from open_webui.models.users import Users
  17. from open_webui.socket.main import (
  18. get_event_call,
  19. get_event_emitter,
  20. get_active_status_by_user_id,
  21. )
  22. from open_webui.routers.tasks import (
  23. generate_queries,
  24. generate_title,
  25. generate_chat_tags,
  26. )
  27. from open_webui.routers.retrieval import process_web_search, SearchForm
  28. from open_webui.routers.images import image_generations, GenerateImageForm
  29. from open_webui.utils.webhook import post_webhook
  30. from open_webui.models.users import UserModel
  31. from open_webui.models.functions import Functions
  32. from open_webui.models.models import Models
  33. from open_webui.retrieval.utils import get_sources_from_files
  34. from open_webui.utils.chat import generate_chat_completion
  35. from open_webui.utils.task import (
  36. get_task_model_id,
  37. rag_template,
  38. tools_function_calling_generation_template,
  39. )
  40. from open_webui.utils.misc import (
  41. get_message_list,
  42. add_or_update_system_message,
  43. get_last_user_message,
  44. get_last_assistant_message,
  45. prepend_to_first_user_message_content,
  46. )
  47. from open_webui.utils.tools import get_tools
  48. from open_webui.utils.plugin import load_function_module_by_id
  49. from open_webui.tasks import create_task
  50. from open_webui.config import DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  51. from open_webui.env import (
  52. SRC_LOG_LEVELS,
  53. GLOBAL_LOG_LEVEL,
  54. BYPASS_MODEL_ACCESS_CONTROL,
  55. ENABLE_REALTIME_CHAT_SAVE,
  56. )
  57. from open_webui.constants import TASKS
  58. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
  59. log = logging.getLogger(__name__)
  60. log.setLevel(SRC_LOG_LEVELS["MAIN"])
  61. async def chat_completion_filter_functions_handler(request, body, model, extra_params):
  62. skip_files = None
  63. def get_filter_function_ids(model):
  64. def get_priority(function_id):
  65. function = Functions.get_function_by_id(function_id)
  66. if function is not None and hasattr(function, "valves"):
  67. # TODO: Fix FunctionModel
  68. return (function.valves if function.valves else {}).get("priority", 0)
  69. return 0
  70. filter_ids = [
  71. function.id for function in Functions.get_global_filter_functions()
  72. ]
  73. if "info" in model and "meta" in model["info"]:
  74. filter_ids.extend(model["info"]["meta"].get("filterIds", []))
  75. filter_ids = list(set(filter_ids))
  76. enabled_filter_ids = [
  77. function.id
  78. for function in Functions.get_functions_by_type("filter", active_only=True)
  79. ]
  80. filter_ids = [
  81. filter_id for filter_id in filter_ids if filter_id in enabled_filter_ids
  82. ]
  83. filter_ids.sort(key=get_priority)
  84. return filter_ids
  85. filter_ids = get_filter_function_ids(model)
  86. for filter_id in filter_ids:
  87. filter = Functions.get_function_by_id(filter_id)
  88. if not filter:
  89. continue
  90. if filter_id in request.app.state.FUNCTIONS:
  91. function_module = request.app.state.FUNCTIONS[filter_id]
  92. else:
  93. function_module, _, _ = load_function_module_by_id(filter_id)
  94. request.app.state.FUNCTIONS[filter_id] = function_module
  95. # Check if the function has a file_handler variable
  96. if hasattr(function_module, "file_handler"):
  97. skip_files = function_module.file_handler
  98. # Apply valves to the function
  99. if hasattr(function_module, "valves") and hasattr(function_module, "Valves"):
  100. valves = Functions.get_function_valves_by_id(filter_id)
  101. function_module.valves = function_module.Valves(
  102. **(valves if valves else {})
  103. )
  104. if hasattr(function_module, "inlet"):
  105. try:
  106. inlet = function_module.inlet
  107. # Create a dictionary of parameters to be passed to the function
  108. params = {"body": body} | {
  109. k: v
  110. for k, v in {
  111. **extra_params,
  112. "__model__": model,
  113. "__id__": filter_id,
  114. }.items()
  115. if k in inspect.signature(inlet).parameters
  116. }
  117. if "__user__" in params and hasattr(function_module, "UserValves"):
  118. try:
  119. params["__user__"]["valves"] = function_module.UserValves(
  120. **Functions.get_user_valves_by_id_and_user_id(
  121. filter_id, params["__user__"]["id"]
  122. )
  123. )
  124. except Exception as e:
  125. print(e)
  126. if inspect.iscoroutinefunction(inlet):
  127. body = await inlet(**params)
  128. else:
  129. body = inlet(**params)
  130. except Exception as e:
  131. print(f"Error: {e}")
  132. raise e
  133. if skip_files and "files" in body.get("metadata", {}):
  134. del body["metadata"]["files"]
  135. return body, {}
  136. async def chat_completion_tools_handler(
  137. request: Request, body: dict, user: UserModel, models, extra_params: dict
  138. ) -> tuple[dict, dict]:
  139. async def get_content_from_response(response) -> Optional[str]:
  140. content = None
  141. if hasattr(response, "body_iterator"):
  142. async for chunk in response.body_iterator:
  143. data = json.loads(chunk.decode("utf-8"))
  144. content = data["choices"][0]["message"]["content"]
  145. # Cleanup any remaining background tasks if necessary
  146. if response.background is not None:
  147. await response.background()
  148. else:
  149. content = response["choices"][0]["message"]["content"]
  150. return content
  151. def get_tools_function_calling_payload(messages, task_model_id, content):
  152. user_message = get_last_user_message(messages)
  153. history = "\n".join(
  154. f"{message['role'].upper()}: \"\"\"{message['content']}\"\"\""
  155. for message in messages[::-1][:4]
  156. )
  157. prompt = f"History:\n{history}\nQuery: {user_message}"
  158. return {
  159. "model": task_model_id,
  160. "messages": [
  161. {"role": "system", "content": content},
  162. {"role": "user", "content": f"Query: {prompt}"},
  163. ],
  164. "stream": False,
  165. "metadata": {"task": str(TASKS.FUNCTION_CALLING)},
  166. }
  167. # If tool_ids field is present, call the functions
  168. metadata = body.get("metadata", {})
  169. tool_ids = metadata.get("tool_ids", None)
  170. log.debug(f"{tool_ids=}")
  171. if not tool_ids:
  172. return body, {}
  173. skip_files = False
  174. sources = []
  175. task_model_id = get_task_model_id(
  176. body["model"],
  177. request.app.state.config.TASK_MODEL,
  178. request.app.state.config.TASK_MODEL_EXTERNAL,
  179. models,
  180. )
  181. tools = get_tools(
  182. request,
  183. tool_ids,
  184. user,
  185. {
  186. **extra_params,
  187. "__model__": models[task_model_id],
  188. "__messages__": body["messages"],
  189. "__files__": metadata.get("files", []),
  190. },
  191. )
  192. log.info(f"{tools=}")
  193. specs = [tool["spec"] for tool in tools.values()]
  194. tools_specs = json.dumps(specs)
  195. if request.app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE != "":
  196. template = request.app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  197. else:
  198. template = DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  199. tools_function_calling_prompt = tools_function_calling_generation_template(
  200. template, tools_specs
  201. )
  202. log.info(f"{tools_function_calling_prompt=}")
  203. payload = get_tools_function_calling_payload(
  204. body["messages"], task_model_id, tools_function_calling_prompt
  205. )
  206. try:
  207. response = await generate_chat_completion(request, form_data=payload, user=user)
  208. log.debug(f"{response=}")
  209. content = await get_content_from_response(response)
  210. log.debug(f"{content=}")
  211. if not content:
  212. return body, {}
  213. try:
  214. content = content[content.find("{") : content.rfind("}") + 1]
  215. if not content:
  216. raise Exception("No JSON object found in the response")
  217. result = json.loads(content)
  218. tool_function_name = result.get("name", None)
  219. if tool_function_name not in tools:
  220. return body, {}
  221. tool_function_params = result.get("parameters", {})
  222. try:
  223. required_params = (
  224. tools[tool_function_name]
  225. .get("spec", {})
  226. .get("parameters", {})
  227. .get("required", [])
  228. )
  229. tool_function = tools[tool_function_name]["callable"]
  230. tool_function_params = {
  231. k: v
  232. for k, v in tool_function_params.items()
  233. if k in required_params
  234. }
  235. tool_output = await tool_function(**tool_function_params)
  236. except Exception as e:
  237. tool_output = str(e)
  238. if isinstance(tool_output, str):
  239. if tools[tool_function_name]["citation"]:
  240. sources.append(
  241. {
  242. "source": {
  243. "name": f"TOOL:{tools[tool_function_name]['toolkit_id']}/{tool_function_name}"
  244. },
  245. "document": [tool_output],
  246. "metadata": [
  247. {
  248. "source": f"TOOL:{tools[tool_function_name]['toolkit_id']}/{tool_function_name}"
  249. }
  250. ],
  251. }
  252. )
  253. else:
  254. sources.append(
  255. {
  256. "source": {},
  257. "document": [tool_output],
  258. "metadata": [
  259. {
  260. "source": f"TOOL:{tools[tool_function_name]['toolkit_id']}/{tool_function_name}"
  261. }
  262. ],
  263. }
  264. )
  265. if tools[tool_function_name]["file_handler"]:
  266. skip_files = True
  267. except Exception as e:
  268. log.exception(f"Error: {e}")
  269. content = None
  270. except Exception as e:
  271. log.exception(f"Error: {e}")
  272. content = None
  273. log.debug(f"tool_contexts: {sources}")
  274. if skip_files and "files" in body.get("metadata", {}):
  275. del body["metadata"]["files"]
  276. return body, {"sources": sources}
  277. async def chat_web_search_handler(
  278. request: Request, form_data: dict, extra_params: dict, user
  279. ):
  280. event_emitter = extra_params["__event_emitter__"]
  281. await event_emitter(
  282. {
  283. "type": "status",
  284. "data": {
  285. "action": "web_search",
  286. "description": "Generating search query",
  287. "done": False,
  288. },
  289. }
  290. )
  291. messages = form_data["messages"]
  292. user_message = get_last_user_message(messages)
  293. queries = []
  294. try:
  295. res = await generate_queries(
  296. request,
  297. {
  298. "model": form_data["model"],
  299. "messages": messages,
  300. "prompt": user_message,
  301. "type": "web_search",
  302. },
  303. user,
  304. )
  305. response = res["choices"][0]["message"]["content"]
  306. try:
  307. bracket_start = response.find("{")
  308. bracket_end = response.rfind("}") + 1
  309. if bracket_start == -1 or bracket_end == -1:
  310. raise Exception("No JSON object found in the response")
  311. response = response[bracket_start:bracket_end]
  312. queries = json.loads(response)
  313. queries = queries.get("queries", [])
  314. except Exception as e:
  315. queries = [response]
  316. except Exception as e:
  317. log.exception(e)
  318. queries = [user_message]
  319. if len(queries) == 0:
  320. await event_emitter(
  321. {
  322. "type": "status",
  323. "data": {
  324. "action": "web_search",
  325. "description": "No search query generated",
  326. "done": True,
  327. },
  328. }
  329. )
  330. return
  331. searchQuery = queries[0]
  332. await event_emitter(
  333. {
  334. "type": "status",
  335. "data": {
  336. "action": "web_search",
  337. "description": 'Searching "{{searchQuery}}"',
  338. "query": searchQuery,
  339. "done": False,
  340. },
  341. }
  342. )
  343. try:
  344. # Offload process_web_search to a separate thread
  345. loop = asyncio.get_running_loop()
  346. with ThreadPoolExecutor() as executor:
  347. results = await loop.run_in_executor(
  348. executor,
  349. lambda: process_web_search(
  350. request,
  351. SearchForm(
  352. **{
  353. "query": searchQuery,
  354. }
  355. ),
  356. user,
  357. ),
  358. )
  359. if results:
  360. await event_emitter(
  361. {
  362. "type": "status",
  363. "data": {
  364. "action": "web_search",
  365. "description": "Searched {{count}} sites",
  366. "query": searchQuery,
  367. "urls": results["filenames"],
  368. "done": True,
  369. },
  370. }
  371. )
  372. files = form_data.get("files", [])
  373. files.append(
  374. {
  375. "collection_name": results["collection_name"],
  376. "name": searchQuery,
  377. "type": "web_search_results",
  378. "urls": results["filenames"],
  379. }
  380. )
  381. form_data["files"] = files
  382. else:
  383. await event_emitter(
  384. {
  385. "type": "status",
  386. "data": {
  387. "action": "web_search",
  388. "description": "No search results found",
  389. "query": searchQuery,
  390. "done": True,
  391. "error": True,
  392. },
  393. }
  394. )
  395. except Exception as e:
  396. log.exception(e)
  397. await event_emitter(
  398. {
  399. "type": "status",
  400. "data": {
  401. "action": "web_search",
  402. "description": 'Error searching "{{searchQuery}}"',
  403. "query": searchQuery,
  404. "done": True,
  405. "error": True,
  406. },
  407. }
  408. )
  409. return form_data
  410. async def chat_image_generation_handler(
  411. request: Request, form_data: dict, extra_params: dict, user
  412. ):
  413. __event_emitter__ = extra_params["__event_emitter__"]
  414. await __event_emitter__(
  415. {
  416. "type": "status",
  417. "data": {"description": "Generating an image", "done": False},
  418. }
  419. )
  420. messages = form_data["messages"]
  421. user_message = get_last_user_message(messages)
  422. system_message_content = ""
  423. try:
  424. images = await image_generations(
  425. request=request,
  426. form_data=GenerateImageForm(**{"prompt": user_message}),
  427. user=user,
  428. )
  429. await __event_emitter__(
  430. {
  431. "type": "status",
  432. "data": {"description": "Generated an image", "done": True},
  433. }
  434. )
  435. for image in images:
  436. await __event_emitter__(
  437. {
  438. "type": "message",
  439. "data": {"content": f"![Generated Image]({image['url']})"},
  440. }
  441. )
  442. system_message_content = "<context>User is shown the generated image, tell the user that the image has been generated</context>"
  443. except Exception as e:
  444. log.exception(e)
  445. await __event_emitter__(
  446. {
  447. "type": "status",
  448. "data": {
  449. "description": f"An error occured while generating an image",
  450. "done": True,
  451. },
  452. }
  453. )
  454. system_message_content = "<context>Unable to generate an image, tell the user that an error occured</context>"
  455. if system_message_content:
  456. form_data["messages"] = add_or_update_system_message(
  457. system_message_content, form_data["messages"]
  458. )
  459. return form_data
  460. async def chat_completion_files_handler(
  461. request: Request, body: dict, user: UserModel
  462. ) -> tuple[dict, dict[str, list]]:
  463. sources = []
  464. if files := body.get("metadata", {}).get("files", None):
  465. try:
  466. queries_response = await generate_queries(
  467. request,
  468. {
  469. "model": body["model"],
  470. "messages": body["messages"],
  471. "type": "retrieval",
  472. },
  473. user,
  474. )
  475. queries_response = queries_response["choices"][0]["message"]["content"]
  476. try:
  477. bracket_start = queries_response.find("{")
  478. bracket_end = queries_response.rfind("}") + 1
  479. if bracket_start == -1 or bracket_end == -1:
  480. raise Exception("No JSON object found in the response")
  481. queries_response = queries_response[bracket_start:bracket_end]
  482. queries_response = json.loads(queries_response)
  483. except Exception as e:
  484. queries_response = {"queries": [queries_response]}
  485. queries = queries_response.get("queries", [])
  486. except Exception as e:
  487. queries = []
  488. if len(queries) == 0:
  489. queries = [get_last_user_message(body["messages"])]
  490. sources = get_sources_from_files(
  491. files=files,
  492. queries=queries,
  493. embedding_function=request.app.state.EMBEDDING_FUNCTION,
  494. k=request.app.state.config.TOP_K,
  495. reranking_function=request.app.state.rf,
  496. r=request.app.state.config.RELEVANCE_THRESHOLD,
  497. hybrid_search=request.app.state.config.ENABLE_RAG_HYBRID_SEARCH,
  498. )
  499. log.debug(f"rag_contexts:sources: {sources}")
  500. return body, {"sources": sources}
  501. def apply_params_to_form_data(form_data, model):
  502. params = form_data.pop("params", {})
  503. if model.get("ollama"):
  504. form_data["options"] = params
  505. if "format" in params:
  506. form_data["format"] = params["format"]
  507. if "keep_alive" in params:
  508. form_data["keep_alive"] = params["keep_alive"]
  509. else:
  510. if "seed" in params:
  511. form_data["seed"] = params["seed"]
  512. if "stop" in params:
  513. form_data["stop"] = params["stop"]
  514. if "temperature" in params:
  515. form_data["temperature"] = params["temperature"]
  516. if "top_p" in params:
  517. form_data["top_p"] = params["top_p"]
  518. if "frequency_penalty" in params:
  519. form_data["frequency_penalty"] = params["frequency_penalty"]
  520. return form_data
  521. async def process_chat_payload(request, form_data, metadata, user, model):
  522. form_data = apply_params_to_form_data(form_data, model)
  523. log.debug(f"form_data: {form_data}")
  524. event_emitter = get_event_emitter(metadata)
  525. event_call = get_event_call(metadata)
  526. extra_params = {
  527. "__event_emitter__": event_emitter,
  528. "__event_call__": event_call,
  529. "__user__": {
  530. "id": user.id,
  531. "email": user.email,
  532. "name": user.name,
  533. "role": user.role,
  534. },
  535. "__metadata__": metadata,
  536. "__request__": request,
  537. }
  538. # Initialize events to store additional event to be sent to the client
  539. # Initialize contexts and citation
  540. models = request.app.state.MODELS
  541. events = []
  542. sources = []
  543. user_message = get_last_user_message(form_data["messages"])
  544. model_knowledge = model.get("info", {}).get("meta", {}).get("knowledge", False)
  545. if model_knowledge:
  546. await event_emitter(
  547. {
  548. "type": "status",
  549. "data": {
  550. "action": "knowledge_search",
  551. "query": user_message,
  552. "done": False,
  553. },
  554. }
  555. )
  556. knowledge_files = []
  557. for item in model_knowledge:
  558. if item.get("collection_name"):
  559. knowledge_files.append(
  560. {
  561. "id": item.get("collection_name"),
  562. "name": item.get("name"),
  563. "legacy": True,
  564. }
  565. )
  566. elif item.get("collection_names"):
  567. knowledge_files.append(
  568. {
  569. "name": item.get("name"),
  570. "type": "collection",
  571. "collection_names": item.get("collection_names"),
  572. "legacy": True,
  573. }
  574. )
  575. else:
  576. knowledge_files.append(item)
  577. files = form_data.get("files", [])
  578. files.extend(knowledge_files)
  579. form_data["files"] = files
  580. features = form_data.pop("features", None)
  581. if features:
  582. if "web_search" in features and features["web_search"]:
  583. form_data = await chat_web_search_handler(
  584. request, form_data, extra_params, user
  585. )
  586. if "image_generation" in features and features["image_generation"]:
  587. form_data = await chat_image_generation_handler(
  588. request, form_data, extra_params, user
  589. )
  590. try:
  591. form_data, flags = await chat_completion_filter_functions_handler(
  592. request, form_data, model, extra_params
  593. )
  594. except Exception as e:
  595. raise Exception(f"Error: {e}")
  596. tool_ids = form_data.pop("tool_ids", None)
  597. files = form_data.pop("files", None)
  598. # Remove files duplicates
  599. if files:
  600. files = list({json.dumps(f, sort_keys=True): f for f in files}.values())
  601. metadata = {
  602. **metadata,
  603. "tool_ids": tool_ids,
  604. "files": files,
  605. }
  606. form_data["metadata"] = metadata
  607. try:
  608. form_data, flags = await chat_completion_tools_handler(
  609. request, form_data, user, models, extra_params
  610. )
  611. sources.extend(flags.get("sources", []))
  612. except Exception as e:
  613. log.exception(e)
  614. try:
  615. form_data, flags = await chat_completion_files_handler(request, form_data, user)
  616. sources.extend(flags.get("sources", []))
  617. except Exception as e:
  618. log.exception(e)
  619. # If context is not empty, insert it into the messages
  620. if len(sources) > 0:
  621. context_string = ""
  622. for source_idx, source in enumerate(sources):
  623. source_id = source.get("source", {}).get("name", "")
  624. if "document" in source:
  625. for doc_idx, doc_context in enumerate(source["document"]):
  626. metadata = source.get("metadata")
  627. doc_source_id = None
  628. if metadata:
  629. doc_source_id = metadata[doc_idx].get("source", source_id)
  630. if source_id:
  631. context_string += f"<source><source_id>{doc_source_id if doc_source_id is not None else source_id}</source_id><source_context>{doc_context}</source_context></source>\n"
  632. else:
  633. # If there is no source_id, then do not include the source_id tag
  634. context_string += f"<source><source_context>{doc_context}</source_context></source>\n"
  635. context_string = context_string.strip()
  636. prompt = get_last_user_message(form_data["messages"])
  637. if prompt is None:
  638. raise Exception("No user message found")
  639. if (
  640. request.app.state.config.RELEVANCE_THRESHOLD == 0
  641. and context_string.strip() == ""
  642. ):
  643. log.debug(
  644. f"With a 0 relevancy threshold for RAG, the context cannot be empty"
  645. )
  646. # Workaround for Ollama 2.0+ system prompt issue
  647. # TODO: replace with add_or_update_system_message
  648. if model["owned_by"] == "ollama":
  649. form_data["messages"] = prepend_to_first_user_message_content(
  650. rag_template(
  651. request.app.state.config.RAG_TEMPLATE, context_string, prompt
  652. ),
  653. form_data["messages"],
  654. )
  655. else:
  656. form_data["messages"] = add_or_update_system_message(
  657. rag_template(
  658. request.app.state.config.RAG_TEMPLATE, context_string, prompt
  659. ),
  660. form_data["messages"],
  661. )
  662. # If there are citations, add them to the data_items
  663. sources = [source for source in sources if source.get("source", {}).get("name", "")]
  664. if len(sources) > 0:
  665. events.append({"sources": sources})
  666. if model_knowledge:
  667. await event_emitter(
  668. {
  669. "type": "status",
  670. "data": {
  671. "action": "knowledge_search",
  672. "query": user_message,
  673. "done": True,
  674. "hidden": True,
  675. },
  676. }
  677. )
  678. return form_data, events
  679. async def process_chat_response(
  680. request, response, form_data, user, events, metadata, tasks
  681. ):
  682. async def background_tasks_handler():
  683. message_map = Chats.get_messages_by_chat_id(metadata["chat_id"])
  684. message = message_map.get(metadata["message_id"]) if message_map else None
  685. if message:
  686. messages = get_message_list(message_map, message.get("id"))
  687. if tasks:
  688. if TASKS.TITLE_GENERATION in tasks:
  689. if tasks[TASKS.TITLE_GENERATION]:
  690. res = await generate_title(
  691. request,
  692. {
  693. "model": message["model"],
  694. "messages": messages,
  695. "chat_id": metadata["chat_id"],
  696. },
  697. user,
  698. )
  699. if res and isinstance(res, dict):
  700. if len(res.get("choices", [])) == 1:
  701. title = (
  702. res.get("choices", [])[0]
  703. .get("message", {})
  704. .get(
  705. "content",
  706. message.get("content", "New Chat"),
  707. )
  708. ).strip()
  709. else:
  710. title = None
  711. if not title:
  712. title = messages[0].get("content", "New Chat")
  713. Chats.update_chat_title_by_id(metadata["chat_id"], title)
  714. await event_emitter(
  715. {
  716. "type": "chat:title",
  717. "data": title,
  718. }
  719. )
  720. elif len(messages) == 2:
  721. title = messages[0].get("content", "New Chat")
  722. Chats.update_chat_title_by_id(metadata["chat_id"], title)
  723. await event_emitter(
  724. {
  725. "type": "chat:title",
  726. "data": message.get("content", "New Chat"),
  727. }
  728. )
  729. if TASKS.TAGS_GENERATION in tasks and tasks[TASKS.TAGS_GENERATION]:
  730. res = await generate_chat_tags(
  731. request,
  732. {
  733. "model": message["model"],
  734. "messages": messages,
  735. "chat_id": metadata["chat_id"],
  736. },
  737. user,
  738. )
  739. if res and isinstance(res, dict):
  740. if len(res.get("choices", [])) == 1:
  741. tags_string = (
  742. res.get("choices", [])[0]
  743. .get("message", {})
  744. .get("content", "")
  745. )
  746. else:
  747. tags_string = ""
  748. tags_string = tags_string[
  749. tags_string.find("{") : tags_string.rfind("}") + 1
  750. ]
  751. try:
  752. tags = json.loads(tags_string).get("tags", [])
  753. Chats.update_chat_tags_by_id(
  754. metadata["chat_id"], tags, user
  755. )
  756. await event_emitter(
  757. {
  758. "type": "chat:tags",
  759. "data": tags,
  760. }
  761. )
  762. except Exception as e:
  763. pass
  764. event_emitter = None
  765. if (
  766. "session_id" in metadata
  767. and metadata["session_id"]
  768. and "chat_id" in metadata
  769. and metadata["chat_id"]
  770. and "message_id" in metadata
  771. and metadata["message_id"]
  772. ):
  773. event_emitter = get_event_emitter(metadata)
  774. if not isinstance(response, StreamingResponse):
  775. if event_emitter:
  776. if "selected_model_id" in response:
  777. Chats.upsert_message_to_chat_by_id_and_message_id(
  778. metadata["chat_id"],
  779. metadata["message_id"],
  780. {
  781. "selectedModelId": response["selected_model_id"],
  782. },
  783. )
  784. if response.get("choices", [])[0].get("message", {}).get("content"):
  785. content = response["choices"][0]["message"]["content"]
  786. if content:
  787. await event_emitter(
  788. {
  789. "type": "chat:completion",
  790. "data": response,
  791. }
  792. )
  793. title = Chats.get_chat_title_by_id(metadata["chat_id"])
  794. await event_emitter(
  795. {
  796. "type": "chat:completion",
  797. "data": {
  798. "done": True,
  799. "content": content,
  800. "title": title,
  801. },
  802. }
  803. )
  804. # Save message in the database
  805. Chats.upsert_message_to_chat_by_id_and_message_id(
  806. metadata["chat_id"],
  807. metadata["message_id"],
  808. {
  809. "content": content,
  810. },
  811. )
  812. # Send a webhook notification if the user is not active
  813. if get_active_status_by_user_id(user.id) is None:
  814. webhook_url = Users.get_user_webhook_url_by_id(user.id)
  815. if webhook_url:
  816. post_webhook(
  817. webhook_url,
  818. f"{title} - {request.app.state.config.WEBUI_URL}/c/{metadata['chat_id']}\n\n{content}",
  819. {
  820. "action": "chat",
  821. "message": content,
  822. "title": title,
  823. "url": f"{request.app.state.config.WEBUI_URL}/c/{metadata['chat_id']}",
  824. },
  825. )
  826. await background_tasks_handler()
  827. return response
  828. else:
  829. return response
  830. if not any(
  831. content_type in response.headers["Content-Type"]
  832. for content_type in ["text/event-stream", "application/x-ndjson"]
  833. ):
  834. return response
  835. if event_emitter:
  836. task_id = str(uuid4()) # Create a unique task ID.
  837. # Handle as a background task
  838. async def post_response_handler(response, events):
  839. message = Chats.get_message_by_id_and_message_id(
  840. metadata["chat_id"], metadata["message_id"]
  841. )
  842. content = message.get("content", "") if message else ""
  843. try:
  844. for event in events:
  845. await event_emitter(
  846. {
  847. "type": "chat:completion",
  848. "data": event,
  849. }
  850. )
  851. # Save message in the database
  852. Chats.upsert_message_to_chat_by_id_and_message_id(
  853. metadata["chat_id"],
  854. metadata["message_id"],
  855. {
  856. **event,
  857. },
  858. )
  859. async for line in response.body_iterator:
  860. line = line.decode("utf-8") if isinstance(line, bytes) else line
  861. data = line
  862. # Skip empty lines
  863. if not data.strip():
  864. continue
  865. # "data:" is the prefix for each event
  866. if not data.startswith("data:"):
  867. continue
  868. # Remove the prefix
  869. data = data[len("data:") :].strip()
  870. try:
  871. data = json.loads(data)
  872. if "selected_model_id" in data:
  873. Chats.upsert_message_to_chat_by_id_and_message_id(
  874. metadata["chat_id"],
  875. metadata["message_id"],
  876. {
  877. "selectedModelId": data["selected_model_id"],
  878. },
  879. )
  880. else:
  881. value = (
  882. data.get("choices", [])[0]
  883. .get("delta", {})
  884. .get("content")
  885. )
  886. if value:
  887. content = f"{content}{value}"
  888. if ENABLE_REALTIME_CHAT_SAVE:
  889. # Save message in the database
  890. Chats.upsert_message_to_chat_by_id_and_message_id(
  891. metadata["chat_id"],
  892. metadata["message_id"],
  893. {
  894. "content": content,
  895. },
  896. )
  897. else:
  898. data = {
  899. "content": content,
  900. }
  901. await event_emitter(
  902. {
  903. "type": "chat:completion",
  904. "data": data,
  905. }
  906. )
  907. except Exception as e:
  908. done = "data: [DONE]" in line
  909. if done:
  910. pass
  911. else:
  912. continue
  913. title = Chats.get_chat_title_by_id(metadata["chat_id"])
  914. data = {"done": True, "content": content, "title": title}
  915. if not ENABLE_REALTIME_CHAT_SAVE:
  916. # Save message in the database
  917. Chats.upsert_message_to_chat_by_id_and_message_id(
  918. metadata["chat_id"],
  919. metadata["message_id"],
  920. {
  921. "content": content,
  922. },
  923. )
  924. # Send a webhook notification if the user is not active
  925. if get_active_status_by_user_id(user.id) is None:
  926. webhook_url = Users.get_user_webhook_url_by_id(user.id)
  927. if webhook_url:
  928. post_webhook(
  929. webhook_url,
  930. f"{title} - {request.app.state.config.WEBUI_URL}/c/{metadata['chat_id']}\n\n{content}",
  931. {
  932. "action": "chat",
  933. "message": content,
  934. "title": title,
  935. "url": f"{request.app.state.config.WEBUI_URL}/c/{metadata['chat_id']}",
  936. },
  937. )
  938. await event_emitter(
  939. {
  940. "type": "chat:completion",
  941. "data": data,
  942. }
  943. )
  944. await background_tasks_handler()
  945. except asyncio.CancelledError:
  946. print("Task was cancelled!")
  947. await event_emitter({"type": "task-cancelled"})
  948. if not ENABLE_REALTIME_CHAT_SAVE:
  949. # Save message in the database
  950. Chats.upsert_message_to_chat_by_id_and_message_id(
  951. metadata["chat_id"],
  952. metadata["message_id"],
  953. {
  954. "content": content,
  955. },
  956. )
  957. if response.background is not None:
  958. await response.background()
  959. # background_tasks.add_task(post_response_handler, response, events)
  960. task_id, _ = create_task(post_response_handler(response, events))
  961. return {"status": True, "task_id": task_id}
  962. else:
  963. # Fallback to the original response
  964. async def stream_wrapper(original_generator, events):
  965. def wrap_item(item):
  966. return f"data: {item}\n\n"
  967. for event in events:
  968. yield wrap_item(json.dumps(event))
  969. async for data in original_generator:
  970. yield data
  971. return StreamingResponse(
  972. stream_wrapper(response.body_iterator, events),
  973. headers=dict(response.headers),
  974. background=response.background,
  975. )