middleware.py 91 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285
  1. import time
  2. import logging
  3. import sys
  4. import os
  5. import base64
  6. import asyncio
  7. from aiocache import cached
  8. from typing import Any, Optional
  9. import random
  10. import json
  11. import html
  12. import inspect
  13. import re
  14. import ast
  15. from uuid import uuid4
  16. from concurrent.futures import ThreadPoolExecutor
  17. from fastapi import Request, HTTPException
  18. from starlette.responses import Response, StreamingResponse
  19. from open_webui.models.chats import Chats
  20. from open_webui.models.users import Users
  21. from open_webui.socket.main import (
  22. get_event_call,
  23. get_event_emitter,
  24. get_active_status_by_user_id,
  25. )
  26. from open_webui.routers.tasks import (
  27. generate_queries,
  28. generate_title,
  29. generate_image_prompt,
  30. generate_chat_tags,
  31. )
  32. from open_webui.routers.retrieval import process_web_search, SearchForm
  33. from open_webui.routers.images import image_generations, GenerateImageForm
  34. from open_webui.routers.pipelines import (
  35. process_pipeline_inlet_filter,
  36. process_pipeline_outlet_filter,
  37. )
  38. from open_webui.utils.webhook import post_webhook
  39. from open_webui.models.users import UserModel
  40. from open_webui.models.functions import Functions
  41. from open_webui.models.models import Models
  42. from open_webui.retrieval.utils import get_sources_from_files
  43. from open_webui.utils.chat import generate_chat_completion
  44. from open_webui.utils.task import (
  45. get_task_model_id,
  46. rag_template,
  47. tools_function_calling_generation_template,
  48. )
  49. from open_webui.utils.misc import (
  50. deep_update,
  51. get_message_list,
  52. add_or_update_system_message,
  53. add_or_update_user_message,
  54. get_last_user_message,
  55. get_last_assistant_message,
  56. prepend_to_first_user_message_content,
  57. convert_logit_bias_input_to_json,
  58. )
  59. from open_webui.utils.tools import get_tools
  60. from open_webui.utils.plugin import load_function_module_by_id
  61. from open_webui.utils.filter import (
  62. get_sorted_filter_ids,
  63. process_filter_functions,
  64. )
  65. from open_webui.utils.code_interpreter import execute_code_jupyter
  66. from open_webui.tasks import create_task
  67. from open_webui.config import (
  68. CACHE_DIR,
  69. DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
  70. DEFAULT_CODE_INTERPRETER_PROMPT,
  71. )
  72. from open_webui.env import (
  73. SRC_LOG_LEVELS,
  74. GLOBAL_LOG_LEVEL,
  75. BYPASS_MODEL_ACCESS_CONTROL,
  76. ENABLE_REALTIME_CHAT_SAVE,
  77. )
  78. from open_webui.constants import TASKS
  79. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
  80. log = logging.getLogger(__name__)
  81. log.setLevel(SRC_LOG_LEVELS["MAIN"])
  82. async def chat_completion_tools_handler(
  83. request: Request, body: dict, extra_params: dict, user: UserModel, models, tools
  84. ) -> tuple[dict, dict]:
  85. async def get_content_from_response(response) -> Optional[str]:
  86. content = None
  87. if hasattr(response, "body_iterator"):
  88. async for chunk in response.body_iterator:
  89. data = json.loads(chunk.decode("utf-8"))
  90. content = data["choices"][0]["message"]["content"]
  91. # Cleanup any remaining background tasks if necessary
  92. if response.background is not None:
  93. await response.background()
  94. else:
  95. content = response["choices"][0]["message"]["content"]
  96. return content
  97. def get_tools_function_calling_payload(messages, task_model_id, content):
  98. user_message = get_last_user_message(messages)
  99. history = "\n".join(
  100. f"{message['role'].upper()}: \"\"\"{message['content']}\"\"\""
  101. for message in messages[::-1][:4]
  102. )
  103. prompt = f"History:\n{history}\nQuery: {user_message}"
  104. return {
  105. "model": task_model_id,
  106. "messages": [
  107. {"role": "system", "content": content},
  108. {"role": "user", "content": f"Query: {prompt}"},
  109. ],
  110. "stream": False,
  111. "metadata": {"task": str(TASKS.FUNCTION_CALLING)},
  112. }
  113. event_caller = extra_params["__event_call__"]
  114. metadata = extra_params["__metadata__"]
  115. task_model_id = get_task_model_id(
  116. body["model"],
  117. request.app.state.config.TASK_MODEL,
  118. request.app.state.config.TASK_MODEL_EXTERNAL,
  119. models,
  120. )
  121. skip_files = False
  122. sources = []
  123. specs = [tool["spec"] for tool in tools.values()]
  124. tools_specs = json.dumps(specs)
  125. if request.app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE != "":
  126. template = request.app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  127. else:
  128. template = DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  129. tools_function_calling_prompt = tools_function_calling_generation_template(
  130. template, tools_specs
  131. )
  132. payload = get_tools_function_calling_payload(
  133. body["messages"], task_model_id, tools_function_calling_prompt
  134. )
  135. try:
  136. response = await generate_chat_completion(request, form_data=payload, user=user)
  137. log.debug(f"{response=}")
  138. content = await get_content_from_response(response)
  139. log.debug(f"{content=}")
  140. if not content:
  141. return body, {}
  142. try:
  143. content = content[content.find("{") : content.rfind("}") + 1]
  144. if not content:
  145. raise Exception("No JSON object found in the response")
  146. result = json.loads(content)
  147. async def tool_call_handler(tool_call):
  148. nonlocal skip_files
  149. log.debug(f"{tool_call=}")
  150. tool_function_name = tool_call.get("name", None)
  151. if tool_function_name not in tools:
  152. return body, {}
  153. tool_function_params = tool_call.get("parameters", {})
  154. try:
  155. tool = tools[tool_function_name]
  156. spec = tool.get("spec", {})
  157. allowed_params = (
  158. spec.get("parameters", {}).get("properties", {}).keys()
  159. )
  160. tool_function_params = {
  161. k: v
  162. for k, v in tool_function_params.items()
  163. if k in allowed_params
  164. }
  165. if tool.get("direct", False):
  166. tool_result = await event_caller(
  167. {
  168. "type": "execute:tool",
  169. "data": {
  170. "id": str(uuid4()),
  171. "name": tool_function_name,
  172. "params": tool_function_params,
  173. "server": tool.get("server", {}),
  174. "session_id": metadata.get("session_id", None),
  175. },
  176. }
  177. )
  178. else:
  179. tool_function = tool["callable"]
  180. tool_result = await tool_function(**tool_function_params)
  181. except Exception as e:
  182. tool_result = str(e)
  183. tool_result_files = []
  184. if isinstance(tool_result, list):
  185. for item in tool_result:
  186. # check if string
  187. if isinstance(item, str) and item.startswith("data:"):
  188. tool_result_files.append(item)
  189. tool_result.remove(item)
  190. if isinstance(tool_result, dict) or isinstance(tool_result, list):
  191. tool_result = json.dumps(tool_result, indent=2)
  192. if isinstance(tool_result, str):
  193. tool = tools[tool_function_name]
  194. tool_id = tool.get("tool_id", "")
  195. if tool.get("metadata", {}).get("citation", False) or tool.get(
  196. "direct", False
  197. ):
  198. sources.append(
  199. {
  200. "source": {
  201. "name": (
  202. f"TOOL:" + f"{tool_id}/{tool_function_name}"
  203. if tool_id
  204. else f"{tool_function_name}"
  205. ),
  206. },
  207. "document": [tool_result, *tool_result_files],
  208. "metadata": [
  209. {
  210. "source": (
  211. f"TOOL:" + f"{tool_id}/{tool_function_name}"
  212. if tool_id
  213. else f"{tool_function_name}"
  214. )
  215. }
  216. ],
  217. }
  218. )
  219. else:
  220. sources.append(
  221. {
  222. "source": {},
  223. "document": [tool_result, *tool_result_files],
  224. "metadata": [
  225. {
  226. "source": (
  227. f"TOOL:" + f"{tool_id}/{tool_function_name}"
  228. if tool_id
  229. else f"{tool_function_name}"
  230. )
  231. }
  232. ],
  233. }
  234. )
  235. if (
  236. tools[tool_function_name]
  237. .get("metadata", {})
  238. .get("file_handler", False)
  239. ):
  240. skip_files = True
  241. # check if "tool_calls" in result
  242. if result.get("tool_calls"):
  243. for tool_call in result.get("tool_calls"):
  244. await tool_call_handler(tool_call)
  245. else:
  246. await tool_call_handler(result)
  247. except Exception as e:
  248. log.debug(f"Error: {e}")
  249. content = None
  250. except Exception as e:
  251. log.debug(f"Error: {e}")
  252. content = None
  253. log.debug(f"tool_contexts: {sources}")
  254. if skip_files and "files" in body.get("metadata", {}):
  255. del body["metadata"]["files"]
  256. return body, {"sources": sources}
  257. async def chat_web_search_handler(
  258. request: Request, form_data: dict, extra_params: dict, user
  259. ):
  260. event_emitter = extra_params["__event_emitter__"]
  261. await event_emitter(
  262. {
  263. "type": "status",
  264. "data": {
  265. "action": "web_search",
  266. "description": "Generating search query",
  267. "done": False,
  268. },
  269. }
  270. )
  271. messages = form_data["messages"]
  272. user_message = get_last_user_message(messages)
  273. queries = []
  274. try:
  275. res = await generate_queries(
  276. request,
  277. {
  278. "model": form_data["model"],
  279. "messages": messages,
  280. "prompt": user_message,
  281. "type": "web_search",
  282. },
  283. user,
  284. )
  285. response = res["choices"][0]["message"]["content"]
  286. try:
  287. bracket_start = response.find("{")
  288. bracket_end = response.rfind("}") + 1
  289. if bracket_start == -1 or bracket_end == -1:
  290. raise Exception("No JSON object found in the response")
  291. response = response[bracket_start:bracket_end]
  292. queries = json.loads(response)
  293. queries = queries.get("queries", [])
  294. except Exception as e:
  295. queries = [response]
  296. except Exception as e:
  297. log.exception(e)
  298. queries = [user_message]
  299. if len(queries) == 0:
  300. await event_emitter(
  301. {
  302. "type": "status",
  303. "data": {
  304. "action": "web_search",
  305. "description": "No search query generated",
  306. "done": True,
  307. },
  308. }
  309. )
  310. return form_data
  311. all_results = []
  312. for searchQuery in queries:
  313. await event_emitter(
  314. {
  315. "type": "status",
  316. "data": {
  317. "action": "web_search",
  318. "description": 'Searching "{{searchQuery}}"',
  319. "query": searchQuery,
  320. "done": False,
  321. },
  322. }
  323. )
  324. try:
  325. results = await process_web_search(
  326. request,
  327. SearchForm(
  328. **{
  329. "query": searchQuery,
  330. }
  331. ),
  332. user=user,
  333. )
  334. if results:
  335. all_results.append(results)
  336. files = form_data.get("files", [])
  337. if results.get("collection_names"):
  338. for col_idx, collection_name in enumerate(
  339. results.get("collection_names")
  340. ):
  341. files.append(
  342. {
  343. "collection_name": collection_name,
  344. "name": searchQuery,
  345. "type": "web_search",
  346. "urls": [results["filenames"][col_idx]],
  347. }
  348. )
  349. elif results.get("docs"):
  350. # Invoked when bypass embedding and retrieval is set to True
  351. docs = results["docs"]
  352. if len(docs) == len(results["filenames"]):
  353. # the number of docs and filenames (urls) should be the same
  354. for doc_idx, doc in enumerate(docs):
  355. files.append(
  356. {
  357. "docs": [doc],
  358. "name": searchQuery,
  359. "type": "web_search",
  360. "urls": [results["filenames"][doc_idx]],
  361. }
  362. )
  363. else:
  364. # edge case when the number of docs and filenames (urls) are not the same
  365. # this should not happen, but if it does, we will just append the docs
  366. files.append(
  367. {
  368. "docs": results.get("docs", []),
  369. "name": searchQuery,
  370. "type": "web_search",
  371. "urls": results["filenames"],
  372. }
  373. )
  374. form_data["files"] = files
  375. except Exception as e:
  376. log.exception(e)
  377. await event_emitter(
  378. {
  379. "type": "status",
  380. "data": {
  381. "action": "web_search",
  382. "description": 'Error searching "{{searchQuery}}"',
  383. "query": searchQuery,
  384. "done": True,
  385. "error": True,
  386. },
  387. }
  388. )
  389. if all_results:
  390. urls = []
  391. for results in all_results:
  392. if "filenames" in results:
  393. urls.extend(results["filenames"])
  394. await event_emitter(
  395. {
  396. "type": "status",
  397. "data": {
  398. "action": "web_search",
  399. "description": "Searched {{count}} sites",
  400. "urls": urls,
  401. "done": True,
  402. },
  403. }
  404. )
  405. else:
  406. await event_emitter(
  407. {
  408. "type": "status",
  409. "data": {
  410. "action": "web_search",
  411. "description": "No search results found",
  412. "done": True,
  413. "error": True,
  414. },
  415. }
  416. )
  417. return form_data
  418. async def chat_image_generation_handler(
  419. request: Request, form_data: dict, extra_params: dict, user
  420. ):
  421. __event_emitter__ = extra_params["__event_emitter__"]
  422. await __event_emitter__(
  423. {
  424. "type": "status",
  425. "data": {"description": "Generating an image", "done": False},
  426. }
  427. )
  428. messages = form_data["messages"]
  429. user_message = get_last_user_message(messages)
  430. prompt = user_message
  431. negative_prompt = ""
  432. if request.app.state.config.ENABLE_IMAGE_PROMPT_GENERATION:
  433. try:
  434. res = await generate_image_prompt(
  435. request,
  436. {
  437. "model": form_data["model"],
  438. "messages": messages,
  439. },
  440. user,
  441. )
  442. response = res["choices"][0]["message"]["content"]
  443. try:
  444. bracket_start = response.find("{")
  445. bracket_end = response.rfind("}") + 1
  446. if bracket_start == -1 or bracket_end == -1:
  447. raise Exception("No JSON object found in the response")
  448. response = response[bracket_start:bracket_end]
  449. response = json.loads(response)
  450. prompt = response.get("prompt", [])
  451. except Exception as e:
  452. prompt = user_message
  453. except Exception as e:
  454. log.exception(e)
  455. prompt = user_message
  456. system_message_content = ""
  457. try:
  458. images = await image_generations(
  459. request=request,
  460. form_data=GenerateImageForm(**{"prompt": prompt}),
  461. user=user,
  462. )
  463. await __event_emitter__(
  464. {
  465. "type": "status",
  466. "data": {"description": "Generated an image", "done": True},
  467. }
  468. )
  469. for image in images:
  470. await __event_emitter__(
  471. {
  472. "type": "message",
  473. "data": {"content": f"![Generated Image]({image['url']})\n"},
  474. }
  475. )
  476. system_message_content = "<context>User is shown the generated image, tell the user that the image has been generated</context>"
  477. except Exception as e:
  478. log.exception(e)
  479. await __event_emitter__(
  480. {
  481. "type": "status",
  482. "data": {
  483. "description": f"An error occurred while generating an image",
  484. "done": True,
  485. },
  486. }
  487. )
  488. system_message_content = "<context>Unable to generate an image, tell the user that an error occurred</context>"
  489. if system_message_content:
  490. form_data["messages"] = add_or_update_system_message(
  491. system_message_content, form_data["messages"]
  492. )
  493. return form_data
  494. async def chat_completion_files_handler(
  495. request: Request, body: dict, user: UserModel
  496. ) -> tuple[dict, dict[str, list]]:
  497. sources = []
  498. if files := body.get("metadata", {}).get("files", None):
  499. queries = []
  500. try:
  501. queries_response = await generate_queries(
  502. request,
  503. {
  504. "model": body["model"],
  505. "messages": body["messages"],
  506. "type": "retrieval",
  507. },
  508. user,
  509. )
  510. queries_response = queries_response["choices"][0]["message"]["content"]
  511. try:
  512. bracket_start = queries_response.find("{")
  513. bracket_end = queries_response.rfind("}") + 1
  514. if bracket_start == -1 or bracket_end == -1:
  515. raise Exception("No JSON object found in the response")
  516. queries_response = queries_response[bracket_start:bracket_end]
  517. queries_response = json.loads(queries_response)
  518. except Exception as e:
  519. queries_response = {"queries": [queries_response]}
  520. queries = queries_response.get("queries", [])
  521. except:
  522. pass
  523. if len(queries) == 0:
  524. queries = [get_last_user_message(body["messages"])]
  525. try:
  526. # Offload get_sources_from_files to a separate thread
  527. loop = asyncio.get_running_loop()
  528. with ThreadPoolExecutor() as executor:
  529. sources = await loop.run_in_executor(
  530. executor,
  531. lambda: get_sources_from_files(
  532. request=request,
  533. files=files,
  534. queries=queries,
  535. embedding_function=lambda query, prefix: request.app.state.EMBEDDING_FUNCTION(
  536. query, prefix=prefix, user=user
  537. ),
  538. k=request.app.state.config.TOP_K,
  539. reranking_function=request.app.state.rf,
  540. k_reranker=request.app.state.config.TOP_K_RERANKER,
  541. r=request.app.state.config.RELEVANCE_THRESHOLD,
  542. hybrid_search=request.app.state.config.ENABLE_RAG_HYBRID_SEARCH,
  543. full_context=request.app.state.config.RAG_FULL_CONTEXT,
  544. ),
  545. )
  546. except Exception as e:
  547. log.exception(e)
  548. log.debug(f"rag_contexts:sources: {sources}")
  549. return body, {"sources": sources}
  550. def apply_params_to_form_data(form_data, model):
  551. params = form_data.pop("params", {})
  552. if model.get("ollama"):
  553. form_data["options"] = params
  554. if "format" in params:
  555. form_data["format"] = params["format"]
  556. if "keep_alive" in params:
  557. form_data["keep_alive"] = params["keep_alive"]
  558. else:
  559. if "seed" in params and params["seed"] is not None:
  560. form_data["seed"] = params["seed"]
  561. if "stop" in params and params["stop"] is not None:
  562. form_data["stop"] = params["stop"]
  563. if "temperature" in params and params["temperature"] is not None:
  564. form_data["temperature"] = params["temperature"]
  565. if "max_tokens" in params and params["max_tokens"] is not None:
  566. form_data["max_tokens"] = params["max_tokens"]
  567. if "top_p" in params and params["top_p"] is not None:
  568. form_data["top_p"] = params["top_p"]
  569. if "frequency_penalty" in params and params["frequency_penalty"] is not None:
  570. form_data["frequency_penalty"] = params["frequency_penalty"]
  571. if "reasoning_effort" in params and params["reasoning_effort"] is not None:
  572. form_data["reasoning_effort"] = params["reasoning_effort"]
  573. if "logit_bias" in params and params["logit_bias"] is not None:
  574. try:
  575. form_data["logit_bias"] = json.loads(
  576. convert_logit_bias_input_to_json(params["logit_bias"])
  577. )
  578. except Exception as e:
  579. print(f"Error parsing logit_bias: {e}")
  580. return form_data
  581. async def process_chat_payload(request, form_data, user, metadata, model):
  582. form_data = apply_params_to_form_data(form_data, model)
  583. log.debug(f"form_data: {form_data}")
  584. event_emitter = get_event_emitter(metadata)
  585. event_call = get_event_call(metadata)
  586. extra_params = {
  587. "__event_emitter__": event_emitter,
  588. "__event_call__": event_call,
  589. "__user__": {
  590. "id": user.id,
  591. "email": user.email,
  592. "name": user.name,
  593. "role": user.role,
  594. },
  595. "__metadata__": metadata,
  596. "__request__": request,
  597. "__model__": model,
  598. }
  599. # Initialize events to store additional event to be sent to the client
  600. # Initialize contexts and citation
  601. if getattr(request.state, "direct", False) and hasattr(request.state, "model"):
  602. models = {
  603. request.state.model["id"]: request.state.model,
  604. }
  605. else:
  606. models = request.app.state.MODELS
  607. task_model_id = get_task_model_id(
  608. form_data["model"],
  609. request.app.state.config.TASK_MODEL,
  610. request.app.state.config.TASK_MODEL_EXTERNAL,
  611. models,
  612. )
  613. events = []
  614. sources = []
  615. user_message = get_last_user_message(form_data["messages"])
  616. model_knowledge = model.get("info", {}).get("meta", {}).get("knowledge", False)
  617. if model_knowledge:
  618. await event_emitter(
  619. {
  620. "type": "status",
  621. "data": {
  622. "action": "knowledge_search",
  623. "query": user_message,
  624. "done": False,
  625. },
  626. }
  627. )
  628. knowledge_files = []
  629. for item in model_knowledge:
  630. if item.get("collection_name"):
  631. knowledge_files.append(
  632. {
  633. "id": item.get("collection_name"),
  634. "name": item.get("name"),
  635. "legacy": True,
  636. }
  637. )
  638. elif item.get("collection_names"):
  639. knowledge_files.append(
  640. {
  641. "name": item.get("name"),
  642. "type": "collection",
  643. "collection_names": item.get("collection_names"),
  644. "legacy": True,
  645. }
  646. )
  647. else:
  648. knowledge_files.append(item)
  649. files = form_data.get("files", [])
  650. files.extend(knowledge_files)
  651. form_data["files"] = files
  652. variables = form_data.pop("variables", None)
  653. # Process the form_data through the pipeline
  654. try:
  655. form_data = await process_pipeline_inlet_filter(
  656. request, form_data, user, models
  657. )
  658. except Exception as e:
  659. raise e
  660. try:
  661. filter_functions = [
  662. Functions.get_function_by_id(filter_id)
  663. for filter_id in get_sorted_filter_ids(model)
  664. ]
  665. form_data, flags = await process_filter_functions(
  666. request=request,
  667. filter_functions=filter_functions,
  668. filter_type="inlet",
  669. form_data=form_data,
  670. extra_params=extra_params,
  671. )
  672. except Exception as e:
  673. raise Exception(f"Error: {e}")
  674. features = form_data.pop("features", None)
  675. if features:
  676. if "web_search" in features and features["web_search"]:
  677. form_data = await chat_web_search_handler(
  678. request, form_data, extra_params, user
  679. )
  680. if "image_generation" in features and features["image_generation"]:
  681. form_data = await chat_image_generation_handler(
  682. request, form_data, extra_params, user
  683. )
  684. if "code_interpreter" in features and features["code_interpreter"]:
  685. form_data["messages"] = add_or_update_user_message(
  686. (
  687. request.app.state.config.CODE_INTERPRETER_PROMPT_TEMPLATE
  688. if request.app.state.config.CODE_INTERPRETER_PROMPT_TEMPLATE != ""
  689. else DEFAULT_CODE_INTERPRETER_PROMPT
  690. ),
  691. form_data["messages"],
  692. )
  693. tool_ids = form_data.pop("tool_ids", None)
  694. files = form_data.pop("files", None)
  695. # Remove files duplicates
  696. if files:
  697. files = list({json.dumps(f, sort_keys=True): f for f in files}.values())
  698. metadata = {
  699. **metadata,
  700. "tool_ids": tool_ids,
  701. "files": files,
  702. }
  703. form_data["metadata"] = metadata
  704. # Server side tools
  705. tool_ids = metadata.get("tool_ids", None)
  706. # Client side tools
  707. tool_servers = metadata.get("tool_servers", None)
  708. log.debug(f"{tool_ids=}")
  709. log.debug(f"{tool_servers=}")
  710. tools_dict = {}
  711. if tool_ids:
  712. tools_dict = get_tools(
  713. request,
  714. tool_ids,
  715. user,
  716. {
  717. **extra_params,
  718. "__model__": models[task_model_id],
  719. "__messages__": form_data["messages"],
  720. "__files__": metadata.get("files", []),
  721. },
  722. )
  723. if tool_servers:
  724. for tool_server in tool_servers:
  725. tool_specs = tool_server.pop("specs", [])
  726. for tool in tool_specs:
  727. tools_dict[tool["name"]] = {
  728. "spec": tool,
  729. "direct": True,
  730. "server": tool_server,
  731. }
  732. if tools_dict:
  733. if metadata.get("function_calling") == "native":
  734. # If the function calling is native, then call the tools function calling handler
  735. metadata["tools"] = tools_dict
  736. form_data["tools"] = [
  737. {"type": "function", "function": tool.get("spec", {})}
  738. for tool in tools_dict.values()
  739. ]
  740. else:
  741. # If the function calling is not native, then call the tools function calling handler
  742. try:
  743. form_data, flags = await chat_completion_tools_handler(
  744. request, form_data, extra_params, user, models, tools_dict
  745. )
  746. sources.extend(flags.get("sources", []))
  747. except Exception as e:
  748. log.exception(e)
  749. try:
  750. form_data, flags = await chat_completion_files_handler(request, form_data, user)
  751. sources.extend(flags.get("sources", []))
  752. except Exception as e:
  753. log.exception(e)
  754. # If context is not empty, insert it into the messages
  755. if len(sources) > 0:
  756. context_string = ""
  757. citated_file_idx = {}
  758. for _, source in enumerate(sources, 1):
  759. if "document" in source:
  760. for doc_context, doc_meta in zip(source["document"], source['metadata']):
  761. file_id = doc_meta.get('file_id')
  762. if file_id not in citated_file_idx:
  763. citated_file_idx[file_id] = len(citated_file_idx) + 1
  764. context_string += f"<source><source_id>{citated_file_idx[file_id]}</source_id><source_context>{doc_context}</source_context></source>\n"
  765. context_string = context_string.strip()
  766. prompt = get_last_user_message(form_data["messages"])
  767. if prompt is None:
  768. raise Exception("No user message found")
  769. if (
  770. request.app.state.config.RELEVANCE_THRESHOLD == 0
  771. and context_string.strip() == ""
  772. ):
  773. log.debug(
  774. f"With a 0 relevancy threshold for RAG, the context cannot be empty"
  775. )
  776. # Workaround for Ollama 2.0+ system prompt issue
  777. # TODO: replace with add_or_update_system_message
  778. if model.get("owned_by") == "ollama":
  779. form_data["messages"] = prepend_to_first_user_message_content(
  780. rag_template(
  781. request.app.state.config.RAG_TEMPLATE, context_string, prompt
  782. ),
  783. form_data["messages"],
  784. )
  785. else:
  786. form_data["messages"] = add_or_update_system_message(
  787. rag_template(
  788. request.app.state.config.RAG_TEMPLATE, context_string, prompt
  789. ),
  790. form_data["messages"],
  791. )
  792. # If there are citations, add them to the data_items
  793. sources = [source for source in sources if source.get("source", {}).get("name", "")]
  794. if len(sources) > 0:
  795. events.append({"sources": sources})
  796. if model_knowledge:
  797. await event_emitter(
  798. {
  799. "type": "status",
  800. "data": {
  801. "action": "knowledge_search",
  802. "query": user_message,
  803. "done": True,
  804. "hidden": True,
  805. },
  806. }
  807. )
  808. return form_data, metadata, events
  809. async def process_chat_response(
  810. request, response, form_data, user, metadata, model, events, tasks
  811. ):
  812. async def background_tasks_handler():
  813. message_map = Chats.get_messages_by_chat_id(metadata["chat_id"])
  814. message = message_map.get(metadata["message_id"]) if message_map else None
  815. if message:
  816. messages = get_message_list(message_map, message.get("id"))
  817. if tasks and messages:
  818. if TASKS.TITLE_GENERATION in tasks:
  819. if tasks[TASKS.TITLE_GENERATION]:
  820. res = await generate_title(
  821. request,
  822. {
  823. "model": message["model"],
  824. "messages": messages,
  825. "chat_id": metadata["chat_id"],
  826. },
  827. user,
  828. )
  829. if res and isinstance(res, dict):
  830. if len(res.get("choices", [])) == 1:
  831. title_string = (
  832. res.get("choices", [])[0]
  833. .get("message", {})
  834. .get("content", message.get("content", "New Chat"))
  835. )
  836. else:
  837. title_string = ""
  838. title_string = title_string[
  839. title_string.find("{") : title_string.rfind("}") + 1
  840. ]
  841. try:
  842. title = json.loads(title_string).get(
  843. "title", "New Chat"
  844. )
  845. except Exception as e:
  846. title = ""
  847. if not title:
  848. title = messages[0].get("content", "New Chat")
  849. Chats.update_chat_title_by_id(metadata["chat_id"], title)
  850. await event_emitter(
  851. {
  852. "type": "chat:title",
  853. "data": title,
  854. }
  855. )
  856. elif len(messages) == 2:
  857. title = messages[0].get("content", "New Chat")
  858. Chats.update_chat_title_by_id(metadata["chat_id"], title)
  859. await event_emitter(
  860. {
  861. "type": "chat:title",
  862. "data": message.get("content", "New Chat"),
  863. }
  864. )
  865. if TASKS.TAGS_GENERATION in tasks and tasks[TASKS.TAGS_GENERATION]:
  866. res = await generate_chat_tags(
  867. request,
  868. {
  869. "model": message["model"],
  870. "messages": messages,
  871. "chat_id": metadata["chat_id"],
  872. },
  873. user,
  874. )
  875. if res and isinstance(res, dict):
  876. if len(res.get("choices", [])) == 1:
  877. tags_string = (
  878. res.get("choices", [])[0]
  879. .get("message", {})
  880. .get("content", "")
  881. )
  882. else:
  883. tags_string = ""
  884. tags_string = tags_string[
  885. tags_string.find("{") : tags_string.rfind("}") + 1
  886. ]
  887. try:
  888. tags = json.loads(tags_string).get("tags", [])
  889. Chats.update_chat_tags_by_id(
  890. metadata["chat_id"], tags, user
  891. )
  892. await event_emitter(
  893. {
  894. "type": "chat:tags",
  895. "data": tags,
  896. }
  897. )
  898. except Exception as e:
  899. pass
  900. event_emitter = None
  901. event_caller = None
  902. if (
  903. "session_id" in metadata
  904. and metadata["session_id"]
  905. and "chat_id" in metadata
  906. and metadata["chat_id"]
  907. and "message_id" in metadata
  908. and metadata["message_id"]
  909. ):
  910. event_emitter = get_event_emitter(metadata)
  911. event_caller = get_event_call(metadata)
  912. # Non-streaming response
  913. if not isinstance(response, StreamingResponse):
  914. if event_emitter:
  915. if "error" in response:
  916. error = response["error"].get("detail", response["error"])
  917. Chats.upsert_message_to_chat_by_id_and_message_id(
  918. metadata["chat_id"],
  919. metadata["message_id"],
  920. {
  921. "error": {"content": error},
  922. },
  923. )
  924. if "selected_model_id" in response:
  925. Chats.upsert_message_to_chat_by_id_and_message_id(
  926. metadata["chat_id"],
  927. metadata["message_id"],
  928. {
  929. "selectedModelId": response["selected_model_id"],
  930. },
  931. )
  932. choices = response.get("choices", [])
  933. if choices and choices[0].get("message", {}).get("content"):
  934. content = response["choices"][0]["message"]["content"]
  935. if content:
  936. await event_emitter(
  937. {
  938. "type": "chat:completion",
  939. "data": response,
  940. }
  941. )
  942. title = Chats.get_chat_title_by_id(metadata["chat_id"])
  943. await event_emitter(
  944. {
  945. "type": "chat:completion",
  946. "data": {
  947. "done": True,
  948. "content": content,
  949. "title": title,
  950. },
  951. }
  952. )
  953. # Save message in the database
  954. Chats.upsert_message_to_chat_by_id_and_message_id(
  955. metadata["chat_id"],
  956. metadata["message_id"],
  957. {
  958. "content": content,
  959. },
  960. )
  961. # Send a webhook notification if the user is not active
  962. if get_active_status_by_user_id(user.id) is None:
  963. webhook_url = Users.get_user_webhook_url_by_id(user.id)
  964. if webhook_url:
  965. post_webhook(
  966. request.app.state.WEBUI_NAME,
  967. webhook_url,
  968. f"{title} - {request.app.state.config.WEBUI_URL}/c/{metadata['chat_id']}\n\n{content}",
  969. {
  970. "action": "chat",
  971. "message": content,
  972. "title": title,
  973. "url": f"{request.app.state.config.WEBUI_URL}/c/{metadata['chat_id']}",
  974. },
  975. )
  976. await background_tasks_handler()
  977. return response
  978. else:
  979. return response
  980. # Non standard response
  981. if not any(
  982. content_type in response.headers["Content-Type"]
  983. for content_type in ["text/event-stream", "application/x-ndjson"]
  984. ):
  985. return response
  986. extra_params = {
  987. "__event_emitter__": event_emitter,
  988. "__event_call__": event_caller,
  989. "__user__": {
  990. "id": user.id,
  991. "email": user.email,
  992. "name": user.name,
  993. "role": user.role,
  994. },
  995. "__metadata__": metadata,
  996. "__request__": request,
  997. "__model__": model,
  998. }
  999. filter_functions = [
  1000. Functions.get_function_by_id(filter_id)
  1001. for filter_id in get_sorted_filter_ids(model)
  1002. ]
  1003. # Streaming response
  1004. if event_emitter and event_caller:
  1005. task_id = str(uuid4()) # Create a unique task ID.
  1006. model_id = form_data.get("model", "")
  1007. Chats.upsert_message_to_chat_by_id_and_message_id(
  1008. metadata["chat_id"],
  1009. metadata["message_id"],
  1010. {
  1011. "model": model_id,
  1012. },
  1013. )
  1014. def split_content_and_whitespace(content):
  1015. content_stripped = content.rstrip()
  1016. original_whitespace = (
  1017. content[len(content_stripped) :]
  1018. if len(content) > len(content_stripped)
  1019. else ""
  1020. )
  1021. return content_stripped, original_whitespace
  1022. def is_opening_code_block(content):
  1023. backtick_segments = content.split("```")
  1024. # Even number of segments means the last backticks are opening a new block
  1025. return len(backtick_segments) > 1 and len(backtick_segments) % 2 == 0
  1026. # Handle as a background task
  1027. async def post_response_handler(response, events):
  1028. def serialize_content_blocks(content_blocks, raw=False):
  1029. content = ""
  1030. for block in content_blocks:
  1031. if block["type"] == "text":
  1032. content = f"{content}{block['content'].strip()}\n"
  1033. elif block["type"] == "tool_calls":
  1034. attributes = block.get("attributes", {})
  1035. tool_calls = block.get("content", [])
  1036. results = block.get("results", [])
  1037. if results:
  1038. tool_calls_display_content = ""
  1039. for tool_call in tool_calls:
  1040. tool_call_id = tool_call.get("id", "")
  1041. tool_name = tool_call.get("function", {}).get(
  1042. "name", ""
  1043. )
  1044. tool_arguments = tool_call.get("function", {}).get(
  1045. "arguments", ""
  1046. )
  1047. tool_result = None
  1048. tool_result_files = None
  1049. for result in results:
  1050. if tool_call_id == result.get("tool_call_id", ""):
  1051. tool_result = result.get("content", None)
  1052. tool_result_files = result.get("files", None)
  1053. break
  1054. if tool_result:
  1055. tool_calls_display_content = f'{tool_calls_display_content}\n<details type="tool_calls" done="true" id="{tool_call_id}" name="{tool_name}" arguments="{html.escape(json.dumps(tool_arguments))}" result="{html.escape(json.dumps(tool_result))}" files="{html.escape(json.dumps(tool_result_files)) if tool_result_files else ""}">\n<summary>Tool Executed</summary>\n</details>\n'
  1056. else:
  1057. tool_calls_display_content = f'{tool_calls_display_content}\n<details type="tool_calls" done="false" id="{tool_call_id}" name="{tool_name}" arguments="{html.escape(json.dumps(tool_arguments))}">\n<summary>Executing...</summary>\n</details>'
  1058. if not raw:
  1059. content = f"{content}\n{tool_calls_display_content}\n\n"
  1060. else:
  1061. tool_calls_display_content = ""
  1062. for tool_call in tool_calls:
  1063. tool_call_id = tool_call.get("id", "")
  1064. tool_name = tool_call.get("function", {}).get(
  1065. "name", ""
  1066. )
  1067. tool_arguments = tool_call.get("function", {}).get(
  1068. "arguments", ""
  1069. )
  1070. tool_calls_display_content = f'{tool_calls_display_content}\n<details type="tool_calls" done="false" id="{tool_call_id}" name="{tool_name}" arguments="{html.escape(json.dumps(tool_arguments))}">\n<summary>Executing...</summary>\n</details>'
  1071. if not raw:
  1072. content = f"{content}\n{tool_calls_display_content}\n\n"
  1073. elif block["type"] == "reasoning":
  1074. reasoning_display_content = "\n".join(
  1075. (f"> {line}" if not line.startswith(">") else line)
  1076. for line in block["content"].splitlines()
  1077. )
  1078. reasoning_duration = block.get("duration", None)
  1079. if reasoning_duration is not None:
  1080. if raw:
  1081. content = f'{content}\n<{block["start_tag"]}>{block["content"]}<{block["end_tag"]}>\n'
  1082. else:
  1083. content = f'{content}\n<details type="reasoning" done="true" duration="{reasoning_duration}">\n<summary>Thought for {reasoning_duration} seconds</summary>\n{reasoning_display_content}\n</details>\n'
  1084. else:
  1085. if raw:
  1086. content = f'{content}\n<{block["start_tag"]}>{block["content"]}<{block["end_tag"]}>\n'
  1087. else:
  1088. content = f'{content}\n<details type="reasoning" done="false">\n<summary>Thinking…</summary>\n{reasoning_display_content}\n</details>\n'
  1089. elif block["type"] == "code_interpreter":
  1090. attributes = block.get("attributes", {})
  1091. output = block.get("output", None)
  1092. lang = attributes.get("lang", "")
  1093. content_stripped, original_whitespace = (
  1094. split_content_and_whitespace(content)
  1095. )
  1096. if is_opening_code_block(content_stripped):
  1097. # Remove trailing backticks that would open a new block
  1098. content = (
  1099. content_stripped.rstrip("`").rstrip()
  1100. + original_whitespace
  1101. )
  1102. else:
  1103. # Keep content as is - either closing backticks or no backticks
  1104. content = content_stripped + original_whitespace
  1105. if output:
  1106. output = html.escape(json.dumps(output))
  1107. if raw:
  1108. content = f'{content}\n<code_interpreter type="code" lang="{lang}">\n{block["content"]}\n</code_interpreter>\n```output\n{output}\n```\n'
  1109. else:
  1110. content = f'{content}\n<details type="code_interpreter" done="true" output="{output}">\n<summary>Analyzed</summary>\n```{lang}\n{block["content"]}\n```\n</details>\n'
  1111. else:
  1112. if raw:
  1113. content = f'{content}\n<code_interpreter type="code" lang="{lang}">\n{block["content"]}\n</code_interpreter>\n'
  1114. else:
  1115. content = f'{content}\n<details type="code_interpreter" done="false">\n<summary>Analyzing...</summary>\n```{lang}\n{block["content"]}\n```\n</details>\n'
  1116. else:
  1117. block_content = str(block["content"]).strip()
  1118. content = f"{content}{block['type']}: {block_content}\n"
  1119. return content.strip()
  1120. def convert_content_blocks_to_messages(content_blocks):
  1121. messages = []
  1122. temp_blocks = []
  1123. for idx, block in enumerate(content_blocks):
  1124. if block["type"] == "tool_calls":
  1125. messages.append(
  1126. {
  1127. "role": "assistant",
  1128. "content": serialize_content_blocks(temp_blocks),
  1129. "tool_calls": block.get("content"),
  1130. }
  1131. )
  1132. results = block.get("results", [])
  1133. for result in results:
  1134. messages.append(
  1135. {
  1136. "role": "tool",
  1137. "tool_call_id": result["tool_call_id"],
  1138. "content": result["content"],
  1139. }
  1140. )
  1141. temp_blocks = []
  1142. else:
  1143. temp_blocks.append(block)
  1144. if temp_blocks:
  1145. content = serialize_content_blocks(temp_blocks)
  1146. if content:
  1147. messages.append(
  1148. {
  1149. "role": "assistant",
  1150. "content": content,
  1151. }
  1152. )
  1153. return messages
  1154. def tag_content_handler(content_type, tags, content, content_blocks):
  1155. end_flag = False
  1156. def extract_attributes(tag_content):
  1157. """Extract attributes from a tag if they exist."""
  1158. attributes = {}
  1159. if not tag_content: # Ensure tag_content is not None
  1160. return attributes
  1161. # Match attributes in the format: key="value" (ignores single quotes for simplicity)
  1162. matches = re.findall(r'(\w+)\s*=\s*"([^"]+)"', tag_content)
  1163. for key, value in matches:
  1164. attributes[key] = value
  1165. return attributes
  1166. if content_blocks[-1]["type"] == "text":
  1167. for start_tag, end_tag in tags:
  1168. # Match start tag e.g., <tag> or <tag attr="value">
  1169. start_tag_pattern = rf"<{re.escape(start_tag)}(\s.*?)?>"
  1170. match = re.search(start_tag_pattern, content)
  1171. if match:
  1172. attr_content = (
  1173. match.group(1) if match.group(1) else ""
  1174. ) # Ensure it's not None
  1175. attributes = extract_attributes(
  1176. attr_content
  1177. ) # Extract attributes safely
  1178. # Capture everything before and after the matched tag
  1179. before_tag = content[
  1180. : match.start()
  1181. ] # Content before opening tag
  1182. after_tag = content[
  1183. match.end() :
  1184. ] # Content after opening tag
  1185. # Remove the start tag and after from the currently handling text block
  1186. content_blocks[-1]["content"] = content_blocks[-1][
  1187. "content"
  1188. ].replace(match.group(0) + after_tag, "")
  1189. if before_tag:
  1190. content_blocks[-1]["content"] = before_tag
  1191. if not content_blocks[-1]["content"]:
  1192. content_blocks.pop()
  1193. # Append the new block
  1194. content_blocks.append(
  1195. {
  1196. "type": content_type,
  1197. "start_tag": start_tag,
  1198. "end_tag": end_tag,
  1199. "attributes": attributes,
  1200. "content": "",
  1201. "started_at": time.time(),
  1202. }
  1203. )
  1204. if after_tag:
  1205. content_blocks[-1]["content"] = after_tag
  1206. break
  1207. elif content_blocks[-1]["type"] == content_type:
  1208. start_tag = content_blocks[-1]["start_tag"]
  1209. end_tag = content_blocks[-1]["end_tag"]
  1210. # Match end tag e.g., </tag>
  1211. end_tag_pattern = rf"<{re.escape(end_tag)}>"
  1212. # Check if the content has the end tag
  1213. if re.search(end_tag_pattern, content):
  1214. end_flag = True
  1215. block_content = content_blocks[-1]["content"]
  1216. # Strip start and end tags from the content
  1217. start_tag_pattern = rf"<{re.escape(start_tag)}(.*?)>"
  1218. block_content = re.sub(
  1219. start_tag_pattern, "", block_content
  1220. ).strip()
  1221. end_tag_regex = re.compile(end_tag_pattern, re.DOTALL)
  1222. split_content = end_tag_regex.split(block_content, maxsplit=1)
  1223. # Content inside the tag
  1224. block_content = (
  1225. split_content[0].strip() if split_content else ""
  1226. )
  1227. # Leftover content (everything after `</tag>`)
  1228. leftover_content = (
  1229. split_content[1].strip() if len(split_content) > 1 else ""
  1230. )
  1231. if block_content:
  1232. content_blocks[-1]["content"] = block_content
  1233. content_blocks[-1]["ended_at"] = time.time()
  1234. content_blocks[-1]["duration"] = int(
  1235. content_blocks[-1]["ended_at"]
  1236. - content_blocks[-1]["started_at"]
  1237. )
  1238. # Reset the content_blocks by appending a new text block
  1239. if content_type != "code_interpreter":
  1240. if leftover_content:
  1241. content_blocks.append(
  1242. {
  1243. "type": "text",
  1244. "content": leftover_content,
  1245. }
  1246. )
  1247. else:
  1248. content_blocks.append(
  1249. {
  1250. "type": "text",
  1251. "content": "",
  1252. }
  1253. )
  1254. else:
  1255. # Remove the block if content is empty
  1256. content_blocks.pop()
  1257. if leftover_content:
  1258. content_blocks.append(
  1259. {
  1260. "type": "text",
  1261. "content": leftover_content,
  1262. }
  1263. )
  1264. else:
  1265. content_blocks.append(
  1266. {
  1267. "type": "text",
  1268. "content": "",
  1269. }
  1270. )
  1271. # Clean processed content
  1272. content = re.sub(
  1273. rf"<{re.escape(start_tag)}(.*?)>(.|\n)*?<{re.escape(end_tag)}>",
  1274. "",
  1275. content,
  1276. flags=re.DOTALL,
  1277. )
  1278. return content, content_blocks, end_flag
  1279. message = Chats.get_message_by_id_and_message_id(
  1280. metadata["chat_id"], metadata["message_id"]
  1281. )
  1282. tool_calls = []
  1283. last_assistant_message = None
  1284. try:
  1285. if form_data["messages"][-1]["role"] == "assistant":
  1286. last_assistant_message = get_last_assistant_message(
  1287. form_data["messages"]
  1288. )
  1289. except Exception as e:
  1290. pass
  1291. content = (
  1292. message.get("content", "")
  1293. if message
  1294. else last_assistant_message if last_assistant_message else ""
  1295. )
  1296. content_blocks = [
  1297. {
  1298. "type": "text",
  1299. "content": content,
  1300. }
  1301. ]
  1302. # We might want to disable this by default
  1303. DETECT_REASONING = True
  1304. DETECT_SOLUTION = True
  1305. DETECT_CODE_INTERPRETER = metadata.get("features", {}).get(
  1306. "code_interpreter", False
  1307. )
  1308. reasoning_tags = [
  1309. ("think", "/think"),
  1310. ("thinking", "/thinking"),
  1311. ("reason", "/reason"),
  1312. ("reasoning", "/reasoning"),
  1313. ("thought", "/thought"),
  1314. ("Thought", "/Thought"),
  1315. ("|begin_of_thought|", "|end_of_thought|"),
  1316. ]
  1317. code_interpreter_tags = [("code_interpreter", "/code_interpreter")]
  1318. solution_tags = [("|begin_of_solution|", "|end_of_solution|")]
  1319. try:
  1320. for event in events:
  1321. await event_emitter(
  1322. {
  1323. "type": "chat:completion",
  1324. "data": event,
  1325. }
  1326. )
  1327. # Save message in the database
  1328. Chats.upsert_message_to_chat_by_id_and_message_id(
  1329. metadata["chat_id"],
  1330. metadata["message_id"],
  1331. {
  1332. **event,
  1333. },
  1334. )
  1335. async def stream_body_handler(response):
  1336. nonlocal content
  1337. nonlocal content_blocks
  1338. response_tool_calls = []
  1339. async for line in response.body_iterator:
  1340. line = line.decode("utf-8") if isinstance(line, bytes) else line
  1341. data = line
  1342. # Skip empty lines
  1343. if not data.strip():
  1344. continue
  1345. # "data:" is the prefix for each event
  1346. if not data.startswith("data:"):
  1347. continue
  1348. # Remove the prefix
  1349. data = data[len("data:") :].strip()
  1350. try:
  1351. data = json.loads(data)
  1352. data, _ = await process_filter_functions(
  1353. request=request,
  1354. filter_functions=filter_functions,
  1355. filter_type="stream",
  1356. form_data=data,
  1357. extra_params=extra_params,
  1358. )
  1359. if data:
  1360. if "selected_model_id" in data:
  1361. model_id = data["selected_model_id"]
  1362. Chats.upsert_message_to_chat_by_id_and_message_id(
  1363. metadata["chat_id"],
  1364. metadata["message_id"],
  1365. {
  1366. "selectedModelId": model_id,
  1367. },
  1368. )
  1369. else:
  1370. choices = data.get("choices", [])
  1371. if not choices:
  1372. error = data.get("error", {})
  1373. if error:
  1374. await event_emitter(
  1375. {
  1376. "type": "chat:completion",
  1377. "data": {
  1378. "error": error,
  1379. },
  1380. }
  1381. )
  1382. usage = data.get("usage", {})
  1383. if usage:
  1384. await event_emitter(
  1385. {
  1386. "type": "chat:completion",
  1387. "data": {
  1388. "usage": usage,
  1389. },
  1390. }
  1391. )
  1392. continue
  1393. delta = choices[0].get("delta", {})
  1394. delta_tool_calls = delta.get("tool_calls", None)
  1395. if delta_tool_calls:
  1396. for delta_tool_call in delta_tool_calls:
  1397. tool_call_index = delta_tool_call.get(
  1398. "index"
  1399. )
  1400. if tool_call_index is not None:
  1401. if (
  1402. len(response_tool_calls)
  1403. <= tool_call_index
  1404. ):
  1405. response_tool_calls.append(
  1406. delta_tool_call
  1407. )
  1408. else:
  1409. delta_name = delta_tool_call.get(
  1410. "function", {}
  1411. ).get("name")
  1412. delta_arguments = (
  1413. delta_tool_call.get(
  1414. "function", {}
  1415. ).get("arguments")
  1416. )
  1417. if delta_name:
  1418. response_tool_calls[
  1419. tool_call_index
  1420. ]["function"][
  1421. "name"
  1422. ] += delta_name
  1423. if delta_arguments:
  1424. response_tool_calls[
  1425. tool_call_index
  1426. ]["function"][
  1427. "arguments"
  1428. ] += delta_arguments
  1429. value = delta.get("content")
  1430. reasoning_content = delta.get(
  1431. "reasoning_content"
  1432. ) or delta.get("reasoning")
  1433. if reasoning_content:
  1434. if (
  1435. not content_blocks
  1436. or content_blocks[-1]["type"] != "reasoning"
  1437. ):
  1438. reasoning_block = {
  1439. "type": "reasoning",
  1440. "start_tag": "think",
  1441. "end_tag": "/think",
  1442. "attributes": {
  1443. "type": "reasoning_content"
  1444. },
  1445. "content": "",
  1446. "started_at": time.time(),
  1447. }
  1448. content_blocks.append(reasoning_block)
  1449. else:
  1450. reasoning_block = content_blocks[-1]
  1451. reasoning_block["content"] += reasoning_content
  1452. data = {
  1453. "content": serialize_content_blocks(
  1454. content_blocks
  1455. )
  1456. }
  1457. if value:
  1458. if (
  1459. content_blocks
  1460. and content_blocks[-1]["type"]
  1461. == "reasoning"
  1462. and content_blocks[-1]
  1463. .get("attributes", {})
  1464. .get("type")
  1465. == "reasoning_content"
  1466. ):
  1467. reasoning_block = content_blocks[-1]
  1468. reasoning_block["ended_at"] = time.time()
  1469. reasoning_block["duration"] = int(
  1470. reasoning_block["ended_at"]
  1471. - reasoning_block["started_at"]
  1472. )
  1473. content_blocks.append(
  1474. {
  1475. "type": "text",
  1476. "content": "",
  1477. }
  1478. )
  1479. content = f"{content}{value}"
  1480. if not content_blocks:
  1481. content_blocks.append(
  1482. {
  1483. "type": "text",
  1484. "content": "",
  1485. }
  1486. )
  1487. content_blocks[-1]["content"] = (
  1488. content_blocks[-1]["content"] + value
  1489. )
  1490. if DETECT_REASONING:
  1491. content, content_blocks, _ = (
  1492. tag_content_handler(
  1493. "reasoning",
  1494. reasoning_tags,
  1495. content,
  1496. content_blocks,
  1497. )
  1498. )
  1499. if DETECT_CODE_INTERPRETER:
  1500. content, content_blocks, end = (
  1501. tag_content_handler(
  1502. "code_interpreter",
  1503. code_interpreter_tags,
  1504. content,
  1505. content_blocks,
  1506. )
  1507. )
  1508. if end:
  1509. break
  1510. if DETECT_SOLUTION:
  1511. content, content_blocks, _ = (
  1512. tag_content_handler(
  1513. "solution",
  1514. solution_tags,
  1515. content,
  1516. content_blocks,
  1517. )
  1518. )
  1519. if ENABLE_REALTIME_CHAT_SAVE:
  1520. # Save message in the database
  1521. Chats.upsert_message_to_chat_by_id_and_message_id(
  1522. metadata["chat_id"],
  1523. metadata["message_id"],
  1524. {
  1525. "content": serialize_content_blocks(
  1526. content_blocks
  1527. ),
  1528. },
  1529. )
  1530. else:
  1531. data = {
  1532. "content": serialize_content_blocks(
  1533. content_blocks
  1534. ),
  1535. }
  1536. await event_emitter(
  1537. {
  1538. "type": "chat:completion",
  1539. "data": data,
  1540. }
  1541. )
  1542. except Exception as e:
  1543. done = "data: [DONE]" in line
  1544. if done:
  1545. pass
  1546. else:
  1547. log.debug("Error: ", e)
  1548. continue
  1549. if content_blocks:
  1550. # Clean up the last text block
  1551. if content_blocks[-1]["type"] == "text":
  1552. content_blocks[-1]["content"] = content_blocks[-1][
  1553. "content"
  1554. ].strip()
  1555. if not content_blocks[-1]["content"]:
  1556. content_blocks.pop()
  1557. if not content_blocks:
  1558. content_blocks.append(
  1559. {
  1560. "type": "text",
  1561. "content": "",
  1562. }
  1563. )
  1564. if response_tool_calls:
  1565. tool_calls.append(response_tool_calls)
  1566. if response.background:
  1567. await response.background()
  1568. await stream_body_handler(response)
  1569. MAX_TOOL_CALL_RETRIES = 10
  1570. tool_call_retries = 0
  1571. while len(tool_calls) > 0 and tool_call_retries < MAX_TOOL_CALL_RETRIES:
  1572. tool_call_retries += 1
  1573. response_tool_calls = tool_calls.pop(0)
  1574. content_blocks.append(
  1575. {
  1576. "type": "tool_calls",
  1577. "content": response_tool_calls,
  1578. }
  1579. )
  1580. await event_emitter(
  1581. {
  1582. "type": "chat:completion",
  1583. "data": {
  1584. "content": serialize_content_blocks(content_blocks),
  1585. },
  1586. }
  1587. )
  1588. tools = metadata.get("tools", {})
  1589. results = []
  1590. for tool_call in response_tool_calls:
  1591. tool_call_id = tool_call.get("id", "")
  1592. tool_name = tool_call.get("function", {}).get("name", "")
  1593. tool_function_params = {}
  1594. try:
  1595. # json.loads cannot be used because some models do not produce valid JSON
  1596. tool_function_params = ast.literal_eval(
  1597. tool_call.get("function", {}).get("arguments", "{}")
  1598. )
  1599. except Exception as e:
  1600. log.debug(e)
  1601. # Fallback to JSON parsing
  1602. try:
  1603. tool_function_params = json.loads(
  1604. tool_call.get("function", {}).get("arguments", "{}")
  1605. )
  1606. except Exception as e:
  1607. log.debug(
  1608. f"Error parsing tool call arguments: {tool_call.get('function', {}).get('arguments', '{}')}"
  1609. )
  1610. tool_result = None
  1611. if tool_name in tools:
  1612. tool = tools[tool_name]
  1613. spec = tool.get("spec", {})
  1614. try:
  1615. allowed_params = (
  1616. spec.get("parameters", {})
  1617. .get("properties", {})
  1618. .keys()
  1619. )
  1620. tool_function_params = {
  1621. k: v
  1622. for k, v in tool_function_params.items()
  1623. if k in allowed_params
  1624. }
  1625. if tool.get("direct", False):
  1626. tool_result = await event_caller(
  1627. {
  1628. "type": "execute:tool",
  1629. "data": {
  1630. "id": str(uuid4()),
  1631. "name": tool_name,
  1632. "params": tool_function_params,
  1633. "server": tool.get("server", {}),
  1634. "session_id": metadata.get(
  1635. "session_id", None
  1636. ),
  1637. },
  1638. }
  1639. )
  1640. else:
  1641. tool_function = tool["callable"]
  1642. tool_result = await tool_function(
  1643. **tool_function_params
  1644. )
  1645. except Exception as e:
  1646. tool_result = str(e)
  1647. tool_result_files = []
  1648. if isinstance(tool_result, list):
  1649. for item in tool_result:
  1650. # check if string
  1651. if isinstance(item, str) and item.startswith("data:"):
  1652. tool_result_files.append(item)
  1653. tool_result.remove(item)
  1654. if isinstance(tool_result, dict) or isinstance(
  1655. tool_result, list
  1656. ):
  1657. tool_result = json.dumps(tool_result, indent=2)
  1658. results.append(
  1659. {
  1660. "tool_call_id": tool_call_id,
  1661. "content": tool_result,
  1662. **(
  1663. {"files": tool_result_files}
  1664. if tool_result_files
  1665. else {}
  1666. ),
  1667. }
  1668. )
  1669. content_blocks[-1]["results"] = results
  1670. content_blocks.append(
  1671. {
  1672. "type": "text",
  1673. "content": "",
  1674. }
  1675. )
  1676. await event_emitter(
  1677. {
  1678. "type": "chat:completion",
  1679. "data": {
  1680. "content": serialize_content_blocks(content_blocks),
  1681. },
  1682. }
  1683. )
  1684. try:
  1685. res = await generate_chat_completion(
  1686. request,
  1687. {
  1688. "model": model_id,
  1689. "stream": True,
  1690. "tools": form_data["tools"],
  1691. "messages": [
  1692. *form_data["messages"],
  1693. *convert_content_blocks_to_messages(content_blocks),
  1694. ],
  1695. },
  1696. user,
  1697. )
  1698. if isinstance(res, StreamingResponse):
  1699. await stream_body_handler(res)
  1700. else:
  1701. break
  1702. except Exception as e:
  1703. log.debug(e)
  1704. break
  1705. if DETECT_CODE_INTERPRETER:
  1706. MAX_RETRIES = 5
  1707. retries = 0
  1708. while (
  1709. content_blocks[-1]["type"] == "code_interpreter"
  1710. and retries < MAX_RETRIES
  1711. ):
  1712. await event_emitter(
  1713. {
  1714. "type": "chat:completion",
  1715. "data": {
  1716. "content": serialize_content_blocks(content_blocks),
  1717. },
  1718. }
  1719. )
  1720. retries += 1
  1721. log.debug(f"Attempt count: {retries}")
  1722. output = ""
  1723. try:
  1724. if content_blocks[-1]["attributes"].get("type") == "code":
  1725. code = content_blocks[-1]["content"]
  1726. if (
  1727. request.app.state.config.CODE_INTERPRETER_ENGINE
  1728. == "pyodide"
  1729. ):
  1730. output = await event_caller(
  1731. {
  1732. "type": "execute:python",
  1733. "data": {
  1734. "id": str(uuid4()),
  1735. "code": code,
  1736. "session_id": metadata.get(
  1737. "session_id", None
  1738. ),
  1739. },
  1740. }
  1741. )
  1742. elif (
  1743. request.app.state.config.CODE_INTERPRETER_ENGINE
  1744. == "jupyter"
  1745. ):
  1746. output = await execute_code_jupyter(
  1747. request.app.state.config.CODE_INTERPRETER_JUPYTER_URL,
  1748. code,
  1749. (
  1750. request.app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_TOKEN
  1751. if request.app.state.config.CODE_INTERPRETER_JUPYTER_AUTH
  1752. == "token"
  1753. else None
  1754. ),
  1755. (
  1756. request.app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD
  1757. if request.app.state.config.CODE_INTERPRETER_JUPYTER_AUTH
  1758. == "password"
  1759. else None
  1760. ),
  1761. request.app.state.config.CODE_INTERPRETER_JUPYTER_TIMEOUT,
  1762. )
  1763. else:
  1764. output = {
  1765. "stdout": "Code interpreter engine not configured."
  1766. }
  1767. log.debug(f"Code interpreter output: {output}")
  1768. if isinstance(output, dict):
  1769. stdout = output.get("stdout", "")
  1770. if isinstance(stdout, str):
  1771. stdoutLines = stdout.split("\n")
  1772. for idx, line in enumerate(stdoutLines):
  1773. if "data:image/png;base64" in line:
  1774. id = str(uuid4())
  1775. # ensure the path exists
  1776. os.makedirs(
  1777. os.path.join(CACHE_DIR, "images"),
  1778. exist_ok=True,
  1779. )
  1780. image_path = os.path.join(
  1781. CACHE_DIR,
  1782. f"images/{id}.png",
  1783. )
  1784. with open(image_path, "wb") as f:
  1785. f.write(
  1786. base64.b64decode(
  1787. line.split(",")[1]
  1788. )
  1789. )
  1790. stdoutLines[idx] = (
  1791. f"![Output Image {idx}](/cache/images/{id}.png)"
  1792. )
  1793. output["stdout"] = "\n".join(stdoutLines)
  1794. result = output.get("result", "")
  1795. if isinstance(result, str):
  1796. resultLines = result.split("\n")
  1797. for idx, line in enumerate(resultLines):
  1798. if "data:image/png;base64" in line:
  1799. id = str(uuid4())
  1800. # ensure the path exists
  1801. os.makedirs(
  1802. os.path.join(CACHE_DIR, "images"),
  1803. exist_ok=True,
  1804. )
  1805. image_path = os.path.join(
  1806. CACHE_DIR,
  1807. f"images/{id}.png",
  1808. )
  1809. with open(image_path, "wb") as f:
  1810. f.write(
  1811. base64.b64decode(
  1812. line.split(",")[1]
  1813. )
  1814. )
  1815. resultLines[idx] = (
  1816. f"![Output Image {idx}](/cache/images/{id}.png)"
  1817. )
  1818. output["result"] = "\n".join(resultLines)
  1819. except Exception as e:
  1820. output = str(e)
  1821. content_blocks[-1]["output"] = output
  1822. content_blocks.append(
  1823. {
  1824. "type": "text",
  1825. "content": "",
  1826. }
  1827. )
  1828. await event_emitter(
  1829. {
  1830. "type": "chat:completion",
  1831. "data": {
  1832. "content": serialize_content_blocks(content_blocks),
  1833. },
  1834. }
  1835. )
  1836. try:
  1837. res = await generate_chat_completion(
  1838. request,
  1839. {
  1840. "model": model_id,
  1841. "stream": True,
  1842. "messages": [
  1843. *form_data["messages"],
  1844. {
  1845. "role": "assistant",
  1846. "content": serialize_content_blocks(
  1847. content_blocks, raw=True
  1848. ),
  1849. },
  1850. ],
  1851. },
  1852. user,
  1853. )
  1854. if isinstance(res, StreamingResponse):
  1855. await stream_body_handler(res)
  1856. else:
  1857. break
  1858. except Exception as e:
  1859. log.debug(e)
  1860. break
  1861. title = Chats.get_chat_title_by_id(metadata["chat_id"])
  1862. data = {
  1863. "done": True,
  1864. "content": serialize_content_blocks(content_blocks),
  1865. "title": title,
  1866. }
  1867. if not ENABLE_REALTIME_CHAT_SAVE:
  1868. # Save message in the database
  1869. Chats.upsert_message_to_chat_by_id_and_message_id(
  1870. metadata["chat_id"],
  1871. metadata["message_id"],
  1872. {
  1873. "content": serialize_content_blocks(content_blocks),
  1874. },
  1875. )
  1876. # Send a webhook notification if the user is not active
  1877. if get_active_status_by_user_id(user.id) is None:
  1878. webhook_url = Users.get_user_webhook_url_by_id(user.id)
  1879. if webhook_url:
  1880. post_webhook(
  1881. request.app.state.WEBUI_NAME,
  1882. webhook_url,
  1883. f"{title} - {request.app.state.config.WEBUI_URL}/c/{metadata['chat_id']}\n\n{content}",
  1884. {
  1885. "action": "chat",
  1886. "message": content,
  1887. "title": title,
  1888. "url": f"{request.app.state.config.WEBUI_URL}/c/{metadata['chat_id']}",
  1889. },
  1890. )
  1891. await event_emitter(
  1892. {
  1893. "type": "chat:completion",
  1894. "data": data,
  1895. }
  1896. )
  1897. await background_tasks_handler()
  1898. except asyncio.CancelledError:
  1899. log.warning("Task was cancelled!")
  1900. await event_emitter({"type": "task-cancelled"})
  1901. if not ENABLE_REALTIME_CHAT_SAVE:
  1902. # Save message in the database
  1903. Chats.upsert_message_to_chat_by_id_and_message_id(
  1904. metadata["chat_id"],
  1905. metadata["message_id"],
  1906. {
  1907. "content": serialize_content_blocks(content_blocks),
  1908. },
  1909. )
  1910. if response.background is not None:
  1911. await response.background()
  1912. # background_tasks.add_task(post_response_handler, response, events)
  1913. task_id, _ = create_task(post_response_handler(response, events))
  1914. return {"status": True, "task_id": task_id}
  1915. else:
  1916. # Fallback to the original response
  1917. async def stream_wrapper(original_generator, events):
  1918. def wrap_item(item):
  1919. return f"data: {item}\n\n"
  1920. for event in events:
  1921. event, _ = await process_filter_functions(
  1922. request=request,
  1923. filter_functions=filter_functions,
  1924. filter_type="stream",
  1925. form_data=event,
  1926. extra_params=extra_params,
  1927. )
  1928. if event:
  1929. yield wrap_item(json.dumps(event))
  1930. async for data in original_generator:
  1931. data, _ = await process_filter_functions(
  1932. request=request,
  1933. filter_functions=filter_functions,
  1934. filter_type="stream",
  1935. form_data=data,
  1936. extra_params=extra_params,
  1937. )
  1938. if data:
  1939. yield data
  1940. return StreamingResponse(
  1941. stream_wrapper(response.body_iterator, events),
  1942. headers=dict(response.headers),
  1943. background=response.background,
  1944. )