middleware.py 37 KB

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