@mseep/open-computer-use 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (769) hide show
  1. package/.coderabbit.yaml +25 -0
  2. package/.dockerignore +95 -0
  3. package/.env.example +137 -0
  4. package/.githooks/pre-commit +68 -0
  5. package/.github/CODEOWNERS +125 -0
  6. package/.github/ISSUE_TEMPLATE/adr-proposal.md +41 -0
  7. package/.github/ISSUE_TEMPLATE/bug-report.md +49 -0
  8. package/.github/ISSUE_TEMPLATE/component-proposal.md +38 -0
  9. package/.github/ISSUE_TEMPLATE/config.yml +15 -0
  10. package/.github/ISSUE_TEMPLATE/dependency-proposal.md +59 -0
  11. package/.github/ISSUE_TEMPLATE/feature_request.md +15 -0
  12. package/.github/ISSUE_TEMPLATE/nfr-proposal.md +44 -0
  13. package/.github/PULL_REQUEST_TEMPLATE.md +15 -0
  14. package/.github/codeql/codeql-config.yml +11 -0
  15. package/.github/codeql/extensions/security-models/python-sanitizers.model.yml +17 -0
  16. package/.github/codeql/extensions/security-models/qlpack.yml +7 -0
  17. package/.github/dependabot.yml +23 -0
  18. package/.github/security-exceptions.yml +23 -0
  19. package/.github/workflows/build.yml +420 -0
  20. package/.github/workflows/codeql.yml +33 -0
  21. package/.github/workflows/contracts-lint.yml +90 -0
  22. package/.github/workflows/docs-lint.yml +151 -0
  23. package/.github/workflows/helm.yml +131 -0
  24. package/.github/workflows/identity-lint.yml +30 -0
  25. package/.github/workflows/release-chart.yml +177 -0
  26. package/.github/workflows/release.yml +95 -0
  27. package/.github/workflows/security.yml +332 -0
  28. package/.github/workflows/stale.yml +31 -0
  29. package/.github/workflows/supply-chain.yml +242 -0
  30. package/.gitleaks.toml +53 -0
  31. package/.markdownlint.yaml +51 -0
  32. package/.semgrepignore +85 -0
  33. package/.vale/styles/Architecture/ap13-data-class-substrate.yml +12 -0
  34. package/.vale/styles/Architecture/banned-phrases.yml +23 -0
  35. package/.vale/styles/Architecture/banned-vocab.yml +23 -0
  36. package/.vale/styles/Architecture/marketing-tone.yml +19 -0
  37. package/.vale.ini +18 -0
  38. package/CHANGELOG.md +411 -0
  39. package/CLAUDE.md +218 -0
  40. package/CONTRIBUTING.md +82 -0
  41. package/Dockerfile +676 -0
  42. package/LICENSE +98 -0
  43. package/LICENSE-APACHE +202 -0
  44. package/LICENSE-MIT +21 -0
  45. package/NOTICE +36 -0
  46. package/README.md +516 -0
  47. package/SECURITY.md +45 -0
  48. package/THIRD-PARTY-LICENSES.md +14 -0
  49. package/apt-packages.txt +108 -0
  50. package/computer-use-server/.dockerignore +13 -0
  51. package/computer-use-server/Dockerfile +44 -0
  52. package/computer-use-server/README.md +84 -0
  53. package/computer-use-server/app.py +1544 -0
  54. package/computer-use-server/bin/list-subagent-models +449 -0
  55. package/computer-use-server/cli-defaults/README.md +31 -0
  56. package/computer-use-server/cli-defaults/codex.json +7 -0
  57. package/computer-use-server/cli-defaults/opencode.json +18 -0
  58. package/computer-use-server/cli_adapters/__init__.py +46 -0
  59. package/computer-use-server/cli_adapters/claude.py +163 -0
  60. package/computer-use-server/cli_adapters/codex.py +163 -0
  61. package/computer-use-server/cli_adapters/opencode.py +169 -0
  62. package/computer-use-server/cli_adapters/result.py +34 -0
  63. package/computer-use-server/cli_runtime.py +316 -0
  64. package/computer-use-server/context_vars.py +24 -0
  65. package/computer-use-server/docker_manager.py +1100 -0
  66. package/computer-use-server/docs_html.py +12 -0
  67. package/computer-use-server/mcp_resources.py +170 -0
  68. package/computer-use-server/mcp_tools.py +1430 -0
  69. package/computer-use-server/requirements.txt +17 -0
  70. package/computer-use-server/security.py +50 -0
  71. package/computer-use-server/skill_manager.py +664 -0
  72. package/computer-use-server/static/browser-viewer.js +445 -0
  73. package/computer-use-server/static/chart.umd.js +14 -0
  74. package/computer-use-server/static/docs.html +203 -0
  75. package/computer-use-server/static/github-dark.min.css +10 -0
  76. package/computer-use-server/static/github.min.css +10 -0
  77. package/computer-use-server/static/highlight.min.js +1213 -0
  78. package/computer-use-server/static/highlightjs-line-numbers.min.js +1 -0
  79. package/computer-use-server/static/icons.js +74 -0
  80. package/computer-use-server/static/jszip.min.js +13 -0
  81. package/computer-use-server/static/katex/auto-render.min.js +1 -0
  82. package/computer-use-server/static/katex/fonts/KaTeX_AMS-Regular.ttf +0 -0
  83. package/computer-use-server/static/katex/fonts/KaTeX_AMS-Regular.woff +0 -0
  84. package/computer-use-server/static/katex/fonts/KaTeX_AMS-Regular.woff2 +0 -0
  85. package/computer-use-server/static/katex/fonts/KaTeX_Caligraphic-Bold.ttf +0 -0
  86. package/computer-use-server/static/katex/fonts/KaTeX_Caligraphic-Bold.woff +0 -0
  87. package/computer-use-server/static/katex/fonts/KaTeX_Caligraphic-Bold.woff2 +0 -0
  88. package/computer-use-server/static/katex/fonts/KaTeX_Caligraphic-Regular.ttf +0 -0
  89. package/computer-use-server/static/katex/fonts/KaTeX_Caligraphic-Regular.woff +0 -0
  90. package/computer-use-server/static/katex/fonts/KaTeX_Caligraphic-Regular.woff2 +0 -0
  91. package/computer-use-server/static/katex/fonts/KaTeX_Fraktur-Bold.ttf +0 -0
  92. package/computer-use-server/static/katex/fonts/KaTeX_Fraktur-Bold.woff +0 -0
  93. package/computer-use-server/static/katex/fonts/KaTeX_Fraktur-Bold.woff2 +0 -0
  94. package/computer-use-server/static/katex/fonts/KaTeX_Fraktur-Regular.ttf +0 -0
  95. package/computer-use-server/static/katex/fonts/KaTeX_Fraktur-Regular.woff +0 -0
  96. package/computer-use-server/static/katex/fonts/KaTeX_Fraktur-Regular.woff2 +0 -0
  97. package/computer-use-server/static/katex/fonts/KaTeX_Main-Bold.ttf +0 -0
  98. package/computer-use-server/static/katex/fonts/KaTeX_Main-Bold.woff +0 -0
  99. package/computer-use-server/static/katex/fonts/KaTeX_Main-Bold.woff2 +0 -0
  100. package/computer-use-server/static/katex/fonts/KaTeX_Main-BoldItalic.ttf +0 -0
  101. package/computer-use-server/static/katex/fonts/KaTeX_Main-BoldItalic.woff +0 -0
  102. package/computer-use-server/static/katex/fonts/KaTeX_Main-BoldItalic.woff2 +0 -0
  103. package/computer-use-server/static/katex/fonts/KaTeX_Main-Italic.ttf +0 -0
  104. package/computer-use-server/static/katex/fonts/KaTeX_Main-Italic.woff +0 -0
  105. package/computer-use-server/static/katex/fonts/KaTeX_Main-Italic.woff2 +0 -0
  106. package/computer-use-server/static/katex/fonts/KaTeX_Main-Regular.ttf +0 -0
  107. package/computer-use-server/static/katex/fonts/KaTeX_Main-Regular.woff +0 -0
  108. package/computer-use-server/static/katex/fonts/KaTeX_Main-Regular.woff2 +0 -0
  109. package/computer-use-server/static/katex/fonts/KaTeX_Math-BoldItalic.ttf +0 -0
  110. package/computer-use-server/static/katex/fonts/KaTeX_Math-BoldItalic.woff +0 -0
  111. package/computer-use-server/static/katex/fonts/KaTeX_Math-BoldItalic.woff2 +0 -0
  112. package/computer-use-server/static/katex/fonts/KaTeX_Math-Italic.ttf +0 -0
  113. package/computer-use-server/static/katex/fonts/KaTeX_Math-Italic.woff +0 -0
  114. package/computer-use-server/static/katex/fonts/KaTeX_Math-Italic.woff2 +0 -0
  115. package/computer-use-server/static/katex/fonts/KaTeX_SansSerif-Bold.ttf +0 -0
  116. package/computer-use-server/static/katex/fonts/KaTeX_SansSerif-Bold.woff +0 -0
  117. package/computer-use-server/static/katex/fonts/KaTeX_SansSerif-Bold.woff2 +0 -0
  118. package/computer-use-server/static/katex/fonts/KaTeX_SansSerif-Italic.ttf +0 -0
  119. package/computer-use-server/static/katex/fonts/KaTeX_SansSerif-Italic.woff +0 -0
  120. package/computer-use-server/static/katex/fonts/KaTeX_SansSerif-Italic.woff2 +0 -0
  121. package/computer-use-server/static/katex/fonts/KaTeX_SansSerif-Regular.ttf +0 -0
  122. package/computer-use-server/static/katex/fonts/KaTeX_SansSerif-Regular.woff +0 -0
  123. package/computer-use-server/static/katex/fonts/KaTeX_SansSerif-Regular.woff2 +0 -0
  124. package/computer-use-server/static/katex/fonts/KaTeX_Script-Regular.ttf +0 -0
  125. package/computer-use-server/static/katex/fonts/KaTeX_Script-Regular.woff +0 -0
  126. package/computer-use-server/static/katex/fonts/KaTeX_Script-Regular.woff2 +0 -0
  127. package/computer-use-server/static/katex/fonts/KaTeX_Size1-Regular.ttf +0 -0
  128. package/computer-use-server/static/katex/fonts/KaTeX_Size1-Regular.woff +0 -0
  129. package/computer-use-server/static/katex/fonts/KaTeX_Size1-Regular.woff2 +0 -0
  130. package/computer-use-server/static/katex/fonts/KaTeX_Size2-Regular.ttf +0 -0
  131. package/computer-use-server/static/katex/fonts/KaTeX_Size2-Regular.woff +0 -0
  132. package/computer-use-server/static/katex/fonts/KaTeX_Size2-Regular.woff2 +0 -0
  133. package/computer-use-server/static/katex/fonts/KaTeX_Size3-Regular.ttf +0 -0
  134. package/computer-use-server/static/katex/fonts/KaTeX_Size3-Regular.woff +0 -0
  135. package/computer-use-server/static/katex/fonts/KaTeX_Size3-Regular.woff2 +0 -0
  136. package/computer-use-server/static/katex/fonts/KaTeX_Size4-Regular.ttf +0 -0
  137. package/computer-use-server/static/katex/fonts/KaTeX_Size4-Regular.woff +0 -0
  138. package/computer-use-server/static/katex/fonts/KaTeX_Size4-Regular.woff2 +0 -0
  139. package/computer-use-server/static/katex/fonts/KaTeX_Typewriter-Regular.ttf +0 -0
  140. package/computer-use-server/static/katex/fonts/KaTeX_Typewriter-Regular.woff +0 -0
  141. package/computer-use-server/static/katex/fonts/KaTeX_Typewriter-Regular.woff2 +0 -0
  142. package/computer-use-server/static/katex/katex.min.css +1 -0
  143. package/computer-use-server/static/katex/katex.min.js +1 -0
  144. package/computer-use-server/static/locale.js +242 -0
  145. package/computer-use-server/static/mammoth.browser.min.js +21 -0
  146. package/computer-use-server/static/marked.min.js +6 -0
  147. package/computer-use-server/static/mermaid.min.js +2811 -0
  148. package/computer-use-server/static/pdf.min.js +22 -0
  149. package/computer-use-server/static/pdf.worker.min.js +22 -0
  150. package/computer-use-server/static/pptxviewjs.min.js +1 -0
  151. package/computer-use-server/static/preact-htm.min.js +1 -0
  152. package/computer-use-server/static/preview.css +1030 -0
  153. package/computer-use-server/static/preview.js +1522 -0
  154. package/computer-use-server/static/xlsx.full.min.js +22 -0
  155. package/computer-use-server/static/xterm-addon-fit.min.js +2 -0
  156. package/computer-use-server/static/xterm-addon-web-links.min.js +2 -0
  157. package/computer-use-server/static/xterm.css +218 -0
  158. package/computer-use-server/static/xterm.min.js +2 -0
  159. package/computer-use-server/system_prompt.py +761 -0
  160. package/computer-use-server/uploads.py +82 -0
  161. package/contracts/README.md +53 -0
  162. package/contracts/audit/audit-fanin.asyncapi.yaml +407 -0
  163. package/contracts/exec/exec-channel.schema.json +240 -0
  164. package/contracts/mcp/2025-06-18/ocu-constraints.schema.json +178 -0
  165. package/contracts/storage/file-artifact-api.schema.json +390 -0
  166. package/contracts/storage/file-ops.schema.json +217 -0
  167. package/contracts/storage/mount-config.schema.json +197 -0
  168. package/cron/Dockerfile +15 -0
  169. package/cron/cleanup-quick.sh +21 -0
  170. package/cron/cleanup.sh +127 -0
  171. package/data/outputs/.gitkeep +0 -0
  172. package/data/uploads/.gitkeep +0 -0
  173. package/docker-compose.test.yml +54 -0
  174. package/docker-compose.webui.yml +77 -0
  175. package/docker-compose.yml +96 -0
  176. package/docs/CLOUD.md +29 -0
  177. package/docs/COMPARISON.md +128 -0
  178. package/docs/DOCKER.md +469 -0
  179. package/docs/DYNAMIC-SKILLS.md +77 -0
  180. package/docs/FEATURES.md +100 -0
  181. package/docs/INSTALL.md +111 -0
  182. package/docs/KNOWN-BUGS.md +86 -0
  183. package/docs/MCP.md +320 -0
  184. package/docs/SCREENSHOTS.md +39 -0
  185. package/docs/SKILLS-USER-GUIDE.md +86 -0
  186. package/docs/SKILLS.md +483 -0
  187. package/docs/TERMINAL-TAB.md +56 -0
  188. package/docs/architecture/02-trust-boundaries.md +224 -0
  189. package/docs/architecture/03-c4-context.md +61 -0
  190. package/docs/architecture/04-bounded-contexts.md +119 -0
  191. package/docs/architecture/05-c4-container.md +88 -0
  192. package/docs/architecture/06-threat-model.md +172 -0
  193. package/docs/architecture/08-contracts.md +105 -0
  194. package/docs/architecture/MANIFESTO.md +38 -0
  195. package/docs/architecture/PROCESS.md +64 -0
  196. package/docs/architecture/README.md +37 -0
  197. package/docs/architecture/adr/0000-template.md +65 -0
  198. package/docs/architecture/adr/0001-layer-0-gate-legacy-exclusion.md +75 -0
  199. package/docs/architecture/adr/0002-session-view-descriptor.md +57 -0
  200. package/docs/architecture/adr/0003-sandbox-runtime-tier-ladder.md +63 -0
  201. package/docs/architecture/adr/0004-operator-authentication-substrate.md +63 -0
  202. package/docs/architecture/adr/0005-egress-credential-delivery-envoy-sds.md +62 -0
  203. package/docs/architecture/adr/0006-egress-forward-proxy-substrate.md +65 -0
  204. package/docs/architecture/adr/0007-egress-auth-mechanism.md +72 -0
  205. package/docs/architecture/adr/0008-session-egress-attribution.md +59 -0
  206. package/docs/architecture/adr/0009-audit-pipeline-pluggable-by-contract.md +76 -0
  207. package/docs/architecture/adr/0010-storage-backend-pluggable-adapter.md +60 -0
  208. package/docs/architecture/adr/0011-storage-egress-lane.md +67 -0
  209. package/docs/architecture/adr/0012-implementation-language.md +67 -0
  210. package/docs/architecture/adr/0020-sandbox-image-provisioning.md +82 -0
  211. package/docs/architecture/adr/README.md +53 -0
  212. package/docs/architecture/compliance/.gitkeep +0 -0
  213. package/docs/architecture/components/00-overview.md +42 -0
  214. package/docs/architecture/components/0000-template.md +50 -0
  215. package/docs/architecture/components/01-mcp-gateway.md +80 -0
  216. package/docs/architecture/components/02-control-operator-api.md +80 -0
  217. package/docs/architecture/components/04-storage-broker.md +104 -0
  218. package/docs/architecture/components/05-session-sandbox.md +93 -0
  219. package/docs/architecture/components/06-egress-trust-edge.md +95 -0
  220. package/docs/architecture/components/07-audit-pipeline.md +110 -0
  221. package/docs/architecture/diagrams/.gitkeep +0 -0
  222. package/docs/architecture/diagrams/02-trust-boundaries.mmd +111 -0
  223. package/docs/architecture/diagrams/06-threat-model.mmd +41 -0
  224. package/docs/architecture/diagrams/08-contracts.mmd +47 -0
  225. package/docs/architecture/diagrams/c4-container.mmd +59 -0
  226. package/docs/architecture/diagrams/c4-context.mmd +46 -0
  227. package/docs/architecture/glossary.md +172 -0
  228. package/docs/architecture/manifesto/.gitkeep +0 -0
  229. package/docs/architecture/manifesto/01-audience-and-buyer.md +57 -0
  230. package/docs/architecture/manifesto/02-nfrs.md +325 -0
  231. package/docs/architecture/manifesto/03-non-negotiables.md +35 -0
  232. package/docs/architecture/manifesto/04-non-goals.md +23 -0
  233. package/docs/architecture/manifesto/05-licensing-posture.md +61 -0
  234. package/docs/architecture/manifesto/06-starter-mode-policy.md +49 -0
  235. package/docs/architecture/manifesto/07-governance.md +60 -0
  236. package/docs/architecture/primitives-backlog.md +51 -0
  237. package/docs/architecture.svg +117 -0
  238. package/docs/claude-code-gateway.md +173 -0
  239. package/docs/cli-config-templates.md +240 -0
  240. package/docs/data-flow.svg +72 -0
  241. package/docs/demo-landing-page.gif +0 -0
  242. package/docs/demo-qwen-trending.gif +0 -0
  243. package/docs/dynamic-skills.svg +77 -0
  244. package/docs/file-flow.svg +126 -0
  245. package/docs/future-architecture/README.md +152 -0
  246. package/docs/future-architecture/adr/0001-control-plane-language-go.md +80 -0
  247. package/docs/future-architecture/adr/0002-guest-agent-language-go.md +84 -0
  248. package/docs/future-architecture/adr/0003-docker-poc-first-then-k8s.md +37 -0
  249. package/docs/future-architecture/adr/0004-pluggable-runtime-via-runtimeclass.md +34 -0
  250. package/docs/future-architecture/adr/0005-mcp-as-control-plane-gateway.md +34 -0
  251. package/docs/future-architecture/adr/0006-no-agpl-no-bsl-dependencies.md +41 -0
  252. package/docs/future-architecture/adr/0007-superseded-by-future-architecture.md +37 -0
  253. package/docs/future-architecture/adr/0008-internal-grpc-external-rest-mcp.md +106 -0
  254. package/docs/future-architecture/adr/0009-external-protocol-dialects.md +94 -0
  255. package/docs/future-architecture/adr/0010-lambda-as-inspiration-not-runtime.md +86 -0
  256. package/docs/future-architecture/adr/0011-kata-as-first-class-dind-runtime.md +84 -0
  257. package/docs/future-architecture/antipatterns.md +552 -0
  258. package/docs/future-architecture/architecture/01-layers.md +109 -0
  259. package/docs/future-architecture/architecture/02-layer4-control-plane.md +122 -0
  260. package/docs/future-architecture/architecture/03-layer3-providers.md +174 -0
  261. package/docs/future-architecture/architecture/04-layer2-runtimes.md +114 -0
  262. package/docs/future-architecture/architecture/04b-credential-broker.md +153 -0
  263. package/docs/future-architecture/architecture/05-layer1-guest-agent.md +138 -0
  264. package/docs/future-architecture/architecture/06-storage.md +134 -0
  265. package/docs/future-architecture/architecture/07-security.md +194 -0
  266. package/docs/future-architecture/architecture/08-networking.md +149 -0
  267. package/docs/future-architecture/architecture/09-templates.md +122 -0
  268. package/docs/future-architecture/architecture/10-observability.md +121 -0
  269. package/docs/future-architecture/design-notes.md +72 -0
  270. package/docs/future-architecture/gaps.md +281 -0
  271. package/docs/future-architecture/phase-template.md +123 -0
  272. package/docs/future-architecture/references.md +225 -0
  273. package/docs/future-architecture/research/01-kata-containers.md +100 -0
  274. package/docs/future-architecture/research/02-e2b-infra.md +133 -0
  275. package/docs/future-architecture/research/03-coder.md +115 -0
  276. package/docs/future-architecture/research/04-cloud-hypervisor.md +99 -0
  277. package/docs/future-architecture/research/05-firecracker.md +114 -0
  278. package/docs/future-architecture/research/06-agent-sandbox.md +142 -0
  279. package/docs/future-architecture/research/07-chromedp.md +78 -0
  280. package/docs/future-architecture/research/08-microsandbox.md +78 -0
  281. package/docs/future-architecture/research/09-agentbox.md +135 -0
  282. package/docs/future-architecture/research/10-sysbox.md +100 -0
  283. package/docs/future-architecture/research/11-firecracker-containerd.md +93 -0
  284. package/docs/future-architecture/research/12-docker-socket-proxy.md +59 -0
  285. package/docs/future-architecture/research/14-e2b-desktop-and-surf.md +107 -0
  286. package/docs/future-architecture/research/18-open-webui-terminals-observed.md +135 -0
  287. package/docs/future-architecture/research/bank-buyer.md +96 -0
  288. package/docs/future-architecture/research/enthusiast-audience.md +106 -0
  289. package/docs/future-architecture/research/proof-uipath-anthropic-2026-05.md +76 -0
  290. package/docs/future-architecture/research/widemoat-thesis-advisor.md +124 -0
  291. package/docs/future-architecture/roadmap.md +438 -0
  292. package/docs/kata-runtime.md +267 -0
  293. package/docs/kubernetes.md +86 -0
  294. package/docs/logo.png +0 -0
  295. package/docs/multi-cli.md +161 -0
  296. package/docs/openwebui-filter.md +134 -0
  297. package/docs/roadmap/implementation-roadmap.md +104 -0
  298. package/docs/sandbox-contents.svg +229 -0
  299. package/docs/screenshots/01-create-document.png +0 -0
  300. package/docs/screenshots/02-file-preview.png +0 -0
  301. package/docs/screenshots/03-browser-viewer.png +0 -0
  302. package/docs/screenshots/04-sub-agent-terminal.png +0 -0
  303. package/docs/screenshots/05-chat-overview.png +0 -0
  304. package/docs/screenshots/06-sub-agent-dashboard.png +0 -0
  305. package/docs/screenshots/07-frontend-design-skill.png +0 -0
  306. package/docs/screenshots/08-pptx-skill.png +0 -0
  307. package/docs/screenshots/09-skill-creator.png +0 -0
  308. package/docs/screenshots/10-data-chart.png +0 -0
  309. package/docs/shared-browser.svg +102 -0
  310. package/docs/system-prompt.md +113 -0
  311. package/docs/terminal-flow.svg +69 -0
  312. package/examples/helm/README.md +20 -0
  313. package/examples/helm/standalone/values.yaml +49 -0
  314. package/examples/helm/with-open-webui/README.md +99 -0
  315. package/examples/helm/with-open-webui/values-computer-use.yaml +32 -0
  316. package/examples/helm/with-open-webui/values-open-webui.yaml +67 -0
  317. package/fonts/NotoEmoji-Regular.ttf +0 -0
  318. package/helm/computer-use-server/.helmignore +17 -0
  319. package/helm/computer-use-server/Chart.yaml +32 -0
  320. package/helm/computer-use-server/README.md +211 -0
  321. package/helm/computer-use-server/templates/NOTES.txt +66 -0
  322. package/helm/computer-use-server/templates/_helpers.tpl +115 -0
  323. package/helm/computer-use-server/templates/configmap-dind-init.yaml +82 -0
  324. package/helm/computer-use-server/templates/configmap.yaml +18 -0
  325. package/helm/computer-use-server/templates/deployment.yaml +248 -0
  326. package/helm/computer-use-server/templates/ingress.yaml +38 -0
  327. package/helm/computer-use-server/templates/networkpolicy.yaml +50 -0
  328. package/helm/computer-use-server/templates/pdb.yaml +16 -0
  329. package/helm/computer-use-server/templates/pvc-data.yaml +20 -0
  330. package/helm/computer-use-server/templates/pvc-skills-cache.yaml +20 -0
  331. package/helm/computer-use-server/templates/pvc-user-data.yaml +20 -0
  332. package/helm/computer-use-server/templates/pvc-var-lib-docker.yaml +27 -0
  333. package/helm/computer-use-server/templates/secret.yaml +23 -0
  334. package/helm/computer-use-server/templates/service.yaml +22 -0
  335. package/helm/computer-use-server/templates/serviceaccount.yaml +15 -0
  336. package/helm/computer-use-server/templates/tests/test-health.yaml +23 -0
  337. package/helm/computer-use-server/values.schema.json +183 -0
  338. package/helm/computer-use-server/values.yaml +297 -0
  339. package/lychee.toml +36 -0
  340. package/openwebui/Dockerfile +52 -0
  341. package/openwebui/README.md +38 -0
  342. package/openwebui/functions/README.md +48 -0
  343. package/openwebui/functions/computer_link_filter.py +487 -0
  344. package/openwebui/init.sh +305 -0
  345. package/openwebui/patches/README.md +44 -0
  346. package/openwebui/patches/fix_artifacts_auto_show.py +441 -0
  347. package/openwebui/patches/fix_attached_files_position.py +87 -0
  348. package/openwebui/patches/fix_large_tool_args.py +156 -0
  349. package/openwebui/patches/fix_large_tool_results.py +289 -0
  350. package/openwebui/patches/fix_preview_url_detection.py +230 -0
  351. package/openwebui/patches/fix_skip_embedding_chat_files.py +229 -0
  352. package/openwebui/patches/fix_skip_rag_files_native_fc.py +100 -0
  353. package/openwebui/patches/fix_tool_loop_errors.py +510 -0
  354. package/package.json +39 -0
  355. package/requirements.txt +112 -0
  356. package/scripts/check-config.sh +141 -0
  357. package/scripts/docs-lint/ai-slop-detector.sh +202 -0
  358. package/scripts/docs-lint/architecture-tree-whitelist.sh +131 -0
  359. package/scripts/docs-lint/ascii-diagram-detector.sh +58 -0
  360. package/scripts/docs-lint/front-matter-validator.sh +97 -0
  361. package/scripts/docs-lint/gitignored-ref-detector.sh +122 -0
  362. package/scripts/docs-lint/identity-email-detector.sh +48 -0
  363. package/scripts/docs-lint/test-linters.sh +354 -0
  364. package/scripts/docs-lint/wc-budget.sh +61 -0
  365. package/scripts/githooks/pre-push +75 -0
  366. package/server.json +13 -0
  367. package/settings-wrapper/Dockerfile +9 -0
  368. package/settings-wrapper/README.md +119 -0
  369. package/settings-wrapper/app.py +113 -0
  370. package/settings-wrapper/requirements.txt +2 -0
  371. package/settings-wrapper/skills.json +25 -0
  372. package/skills/README.md +46 -0
  373. package/skills/examples/algorithmic-art/SKILL.md +405 -0
  374. package/skills/examples/algorithmic-art/templates/generator_template.js +223 -0
  375. package/skills/examples/algorithmic-art/templates/viewer.html +601 -0
  376. package/skills/examples/artifacts-builder/SKILL.md +74 -0
  377. package/skills/examples/artifacts-builder/scripts/bundle-artifact.sh +54 -0
  378. package/skills/examples/artifacts-builder/scripts/init-artifact.sh +322 -0
  379. package/skills/examples/artifacts-builder/scripts/shadcn-components.tar.gz +0 -0
  380. package/skills/examples/canvas-design/LICENSE.txt +202 -0
  381. package/skills/examples/canvas-design/SKILL.md +130 -0
  382. package/skills/examples/canvas-design/canvas-fonts/ArsenalSC-OFL.txt +93 -0
  383. package/skills/examples/canvas-design/canvas-fonts/ArsenalSC-Regular.ttf +0 -0
  384. package/skills/examples/canvas-design/canvas-fonts/BigShoulders-Bold.ttf +0 -0
  385. package/skills/examples/canvas-design/canvas-fonts/BigShoulders-OFL.txt +93 -0
  386. package/skills/examples/canvas-design/canvas-fonts/BigShoulders-Regular.ttf +0 -0
  387. package/skills/examples/canvas-design/canvas-fonts/Boldonse-OFL.txt +93 -0
  388. package/skills/examples/canvas-design/canvas-fonts/Boldonse-Regular.ttf +0 -0
  389. package/skills/examples/canvas-design/canvas-fonts/BricolageGrotesque-Bold.ttf +0 -0
  390. package/skills/examples/canvas-design/canvas-fonts/BricolageGrotesque-OFL.txt +93 -0
  391. package/skills/examples/canvas-design/canvas-fonts/BricolageGrotesque-Regular.ttf +0 -0
  392. package/skills/examples/canvas-design/canvas-fonts/CrimsonPro-Bold.ttf +0 -0
  393. package/skills/examples/canvas-design/canvas-fonts/CrimsonPro-Italic.ttf +0 -0
  394. package/skills/examples/canvas-design/canvas-fonts/CrimsonPro-OFL.txt +93 -0
  395. package/skills/examples/canvas-design/canvas-fonts/CrimsonPro-Regular.ttf +0 -0
  396. package/skills/examples/canvas-design/canvas-fonts/DMMono-OFL.txt +93 -0
  397. package/skills/examples/canvas-design/canvas-fonts/DMMono-Regular.ttf +0 -0
  398. package/skills/examples/canvas-design/canvas-fonts/EricaOne-OFL.txt +94 -0
  399. package/skills/examples/canvas-design/canvas-fonts/EricaOne-Regular.ttf +0 -0
  400. package/skills/examples/canvas-design/canvas-fonts/GeistMono-Bold.ttf +0 -0
  401. package/skills/examples/canvas-design/canvas-fonts/GeistMono-OFL.txt +93 -0
  402. package/skills/examples/canvas-design/canvas-fonts/GeistMono-Regular.ttf +0 -0
  403. package/skills/examples/canvas-design/canvas-fonts/Gloock-OFL.txt +93 -0
  404. package/skills/examples/canvas-design/canvas-fonts/Gloock-Regular.ttf +0 -0
  405. package/skills/examples/canvas-design/canvas-fonts/IBMPlexMono-Bold.ttf +0 -0
  406. package/skills/examples/canvas-design/canvas-fonts/IBMPlexMono-OFL.txt +93 -0
  407. package/skills/examples/canvas-design/canvas-fonts/IBMPlexMono-Regular.ttf +0 -0
  408. package/skills/examples/canvas-design/canvas-fonts/IBMPlexSerif-Bold.ttf +0 -0
  409. package/skills/examples/canvas-design/canvas-fonts/IBMPlexSerif-BoldItalic.ttf +0 -0
  410. package/skills/examples/canvas-design/canvas-fonts/IBMPlexSerif-Italic.ttf +0 -0
  411. package/skills/examples/canvas-design/canvas-fonts/IBMPlexSerif-Regular.ttf +0 -0
  412. package/skills/examples/canvas-design/canvas-fonts/InstrumentSans-Bold.ttf +0 -0
  413. package/skills/examples/canvas-design/canvas-fonts/InstrumentSans-BoldItalic.ttf +0 -0
  414. package/skills/examples/canvas-design/canvas-fonts/InstrumentSans-Italic.ttf +0 -0
  415. package/skills/examples/canvas-design/canvas-fonts/InstrumentSans-OFL.txt +93 -0
  416. package/skills/examples/canvas-design/canvas-fonts/InstrumentSans-Regular.ttf +0 -0
  417. package/skills/examples/canvas-design/canvas-fonts/InstrumentSerif-Italic.ttf +0 -0
  418. package/skills/examples/canvas-design/canvas-fonts/InstrumentSerif-Regular.ttf +0 -0
  419. package/skills/examples/canvas-design/canvas-fonts/Italiana-OFL.txt +93 -0
  420. package/skills/examples/canvas-design/canvas-fonts/Italiana-Regular.ttf +0 -0
  421. package/skills/examples/canvas-design/canvas-fonts/JetBrainsMono-Bold.ttf +0 -0
  422. package/skills/examples/canvas-design/canvas-fonts/JetBrainsMono-OFL.txt +93 -0
  423. package/skills/examples/canvas-design/canvas-fonts/JetBrainsMono-Regular.ttf +0 -0
  424. package/skills/examples/canvas-design/canvas-fonts/Jura-Light.ttf +0 -0
  425. package/skills/examples/canvas-design/canvas-fonts/Jura-Medium.ttf +0 -0
  426. package/skills/examples/canvas-design/canvas-fonts/Jura-OFL.txt +93 -0
  427. package/skills/examples/canvas-design/canvas-fonts/LibreBaskerville-OFL.txt +93 -0
  428. package/skills/examples/canvas-design/canvas-fonts/LibreBaskerville-Regular.ttf +0 -0
  429. package/skills/examples/canvas-design/canvas-fonts/Lora-Bold.ttf +0 -0
  430. package/skills/examples/canvas-design/canvas-fonts/Lora-BoldItalic.ttf +0 -0
  431. package/skills/examples/canvas-design/canvas-fonts/Lora-Italic.ttf +0 -0
  432. package/skills/examples/canvas-design/canvas-fonts/Lora-OFL.txt +93 -0
  433. package/skills/examples/canvas-design/canvas-fonts/Lora-Regular.ttf +0 -0
  434. package/skills/examples/canvas-design/canvas-fonts/NationalPark-Bold.ttf +0 -0
  435. package/skills/examples/canvas-design/canvas-fonts/NationalPark-OFL.txt +93 -0
  436. package/skills/examples/canvas-design/canvas-fonts/NationalPark-Regular.ttf +0 -0
  437. package/skills/examples/canvas-design/canvas-fonts/NothingYouCouldDo-OFL.txt +93 -0
  438. package/skills/examples/canvas-design/canvas-fonts/NothingYouCouldDo-Regular.ttf +0 -0
  439. package/skills/examples/canvas-design/canvas-fonts/Outfit-Bold.ttf +0 -0
  440. package/skills/examples/canvas-design/canvas-fonts/Outfit-OFL.txt +93 -0
  441. package/skills/examples/canvas-design/canvas-fonts/Outfit-Regular.ttf +0 -0
  442. package/skills/examples/canvas-design/canvas-fonts/PixelifySans-Medium.ttf +0 -0
  443. package/skills/examples/canvas-design/canvas-fonts/PixelifySans-OFL.txt +93 -0
  444. package/skills/examples/canvas-design/canvas-fonts/PoiretOne-OFL.txt +93 -0
  445. package/skills/examples/canvas-design/canvas-fonts/PoiretOne-Regular.ttf +0 -0
  446. package/skills/examples/canvas-design/canvas-fonts/RedHatMono-Bold.ttf +0 -0
  447. package/skills/examples/canvas-design/canvas-fonts/RedHatMono-OFL.txt +93 -0
  448. package/skills/examples/canvas-design/canvas-fonts/RedHatMono-Regular.ttf +0 -0
  449. package/skills/examples/canvas-design/canvas-fonts/Silkscreen-OFL.txt +93 -0
  450. package/skills/examples/canvas-design/canvas-fonts/Silkscreen-Regular.ttf +0 -0
  451. package/skills/examples/canvas-design/canvas-fonts/SmoochSans-Medium.ttf +0 -0
  452. package/skills/examples/canvas-design/canvas-fonts/SmoochSans-OFL.txt +93 -0
  453. package/skills/examples/canvas-design/canvas-fonts/Tektur-Medium.ttf +0 -0
  454. package/skills/examples/canvas-design/canvas-fonts/Tektur-OFL.txt +93 -0
  455. package/skills/examples/canvas-design/canvas-fonts/Tektur-Regular.ttf +0 -0
  456. package/skills/examples/canvas-design/canvas-fonts/WorkSans-Bold.ttf +0 -0
  457. package/skills/examples/canvas-design/canvas-fonts/WorkSans-BoldItalic.ttf +0 -0
  458. package/skills/examples/canvas-design/canvas-fonts/WorkSans-Italic.ttf +0 -0
  459. package/skills/examples/canvas-design/canvas-fonts/WorkSans-OFL.txt +93 -0
  460. package/skills/examples/canvas-design/canvas-fonts/WorkSans-Regular.ttf +0 -0
  461. package/skills/examples/canvas-design/canvas-fonts/YoungSerif-OFL.txt +93 -0
  462. package/skills/examples/canvas-design/canvas-fonts/YoungSerif-Regular.ttf +0 -0
  463. package/skills/examples/copy-editing/SKILL.md +447 -0
  464. package/skills/examples/copy-editing/evals/evals.json +89 -0
  465. package/skills/examples/copy-editing/references/plain-english-alternatives.md +394 -0
  466. package/skills/examples/internal-comms/LICENSE.txt +202 -0
  467. package/skills/examples/internal-comms/SKILL.md +32 -0
  468. package/skills/examples/internal-comms/examples/3p-updates.md +47 -0
  469. package/skills/examples/internal-comms/examples/company-newsletter.md +65 -0
  470. package/skills/examples/internal-comms/examples/faq-answers.md +30 -0
  471. package/skills/examples/internal-comms/examples/general-comms.md +16 -0
  472. package/skills/examples/mcp-builder/SKILL.md +328 -0
  473. package/skills/examples/mcp-builder/reference/evaluation.md +602 -0
  474. package/skills/examples/mcp-builder/reference/mcp_best_practices.md +915 -0
  475. package/skills/examples/mcp-builder/reference/node_mcp_server.md +916 -0
  476. package/skills/examples/mcp-builder/reference/python_mcp_server.md +752 -0
  477. package/skills/examples/mcp-builder/scripts/connections.py +151 -0
  478. package/skills/examples/mcp-builder/scripts/evaluation.py +373 -0
  479. package/skills/examples/mcp-builder/scripts/example_evaluation.xml +22 -0
  480. package/skills/examples/mcp-builder/scripts/requirements.txt +2 -0
  481. package/skills/examples/product-marketing-context/SKILL.md +241 -0
  482. package/skills/examples/product-marketing-context/evals/evals.json +85 -0
  483. package/skills/examples/single-cell-rna-qc/SKILL.md +175 -0
  484. package/skills/examples/single-cell-rna-qc/references/scverse_qc_guidelines.md +186 -0
  485. package/skills/examples/single-cell-rna-qc/scripts/qc_analysis.py +232 -0
  486. package/skills/examples/single-cell-rna-qc/scripts/qc_core.py +233 -0
  487. package/skills/examples/single-cell-rna-qc/scripts/qc_plotting.py +235 -0
  488. package/skills/examples/skill-creator/SKILL.md +355 -0
  489. package/skills/examples/skill-creator/references/output-patterns.md +82 -0
  490. package/skills/examples/skill-creator/references/workflows.md +28 -0
  491. package/skills/examples/skill-creator/scripts/init_skill.py +303 -0
  492. package/skills/examples/skill-creator/scripts/package_skill.py +110 -0
  493. package/skills/examples/skill-creator/scripts/quick_validate.py +95 -0
  494. package/skills/examples/slack-gif-creator/SKILL.md +254 -0
  495. package/skills/examples/slack-gif-creator/core/easing.py +234 -0
  496. package/skills/examples/slack-gif-creator/core/frame_composer.py +176 -0
  497. package/skills/examples/slack-gif-creator/core/gif_builder.py +269 -0
  498. package/skills/examples/slack-gif-creator/core/validators.py +136 -0
  499. package/skills/examples/slack-gif-creator/requirements.txt +4 -0
  500. package/skills/examples/social-content/SKILL.md +278 -0
  501. package/skills/examples/social-content/evals/evals.json +92 -0
  502. package/skills/examples/social-content/references/platforms.md +170 -0
  503. package/skills/examples/social-content/references/post-templates.md +177 -0
  504. package/skills/examples/social-content/references/reverse-engineering.md +195 -0
  505. package/skills/examples/theme-factory/SKILL.md +59 -0
  506. package/skills/examples/theme-factory/theme-showcase.pdf +0 -0
  507. package/skills/examples/theme-factory/themes/arctic-frost.md +19 -0
  508. package/skills/examples/theme-factory/themes/botanical-garden.md +19 -0
  509. package/skills/examples/theme-factory/themes/desert-rose.md +19 -0
  510. package/skills/examples/theme-factory/themes/forest-canopy.md +19 -0
  511. package/skills/examples/theme-factory/themes/golden-hour.md +19 -0
  512. package/skills/examples/theme-factory/themes/midnight-galaxy.md +19 -0
  513. package/skills/examples/theme-factory/themes/modern-minimalist.md +19 -0
  514. package/skills/examples/theme-factory/themes/ocean-depths.md +19 -0
  515. package/skills/examples/theme-factory/themes/sunset-boulevard.md +19 -0
  516. package/skills/examples/theme-factory/themes/tech-innovation.md +19 -0
  517. package/skills/examples/web-artifacts-builder/LICENSE.txt +202 -0
  518. package/skills/examples/web-artifacts-builder/SKILL.md +74 -0
  519. package/skills/examples/web-artifacts-builder/scripts/bundle-artifact.sh +54 -0
  520. package/skills/examples/web-artifacts-builder/scripts/init-artifact.sh +322 -0
  521. package/skills/examples/web-artifacts-builder/scripts/shadcn-components.tar.gz +0 -0
  522. package/skills/examples/writing-skills/SKILL.md +655 -0
  523. package/skills/examples/writing-skills/anthropic-best-practices.md +1150 -0
  524. package/skills/examples/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -0
  525. package/skills/examples/writing-skills/graphviz-conventions.dot +172 -0
  526. package/skills/examples/writing-skills/persuasion-principles.md +187 -0
  527. package/skills/examples/writing-skills/render-graphs.js +168 -0
  528. package/skills/examples/writing-skills/testing-skills-with-subagents.md +384 -0
  529. package/skills/public/describe-image/SKILL.md +105 -0
  530. package/skills/public/describe-image/scripts/describe.py +389 -0
  531. package/skills/public/doc-coauthoring/SKILL.md +375 -0
  532. package/skills/public/docx/LICENSE.txt +30 -0
  533. package/skills/public/docx/SKILL.md +199 -0
  534. package/skills/public/docx/docx-js.md +350 -0
  535. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +1499 -0
  536. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +146 -0
  537. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +1085 -0
  538. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +11 -0
  539. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +3081 -0
  540. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +23 -0
  541. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +185 -0
  542. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +287 -0
  543. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +1676 -0
  544. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +28 -0
  545. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +144 -0
  546. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +174 -0
  547. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +25 -0
  548. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +18 -0
  549. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +59 -0
  550. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +56 -0
  551. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +195 -0
  552. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +582 -0
  553. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +25 -0
  554. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +4439 -0
  555. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +570 -0
  556. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +509 -0
  557. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +12 -0
  558. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +108 -0
  559. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +96 -0
  560. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +3646 -0
  561. package/skills/public/docx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +116 -0
  562. package/skills/public/docx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +42 -0
  563. package/skills/public/docx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +50 -0
  564. package/skills/public/docx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +49 -0
  565. package/skills/public/docx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +33 -0
  566. package/skills/public/docx/ooxml/schemas/mce/mc.xsd +75 -0
  567. package/skills/public/docx/ooxml/schemas/microsoft/wml-2010.xsd +560 -0
  568. package/skills/public/docx/ooxml/schemas/microsoft/wml-2012.xsd +67 -0
  569. package/skills/public/docx/ooxml/schemas/microsoft/wml-2018.xsd +14 -0
  570. package/skills/public/docx/ooxml/schemas/microsoft/wml-cex-2018.xsd +20 -0
  571. package/skills/public/docx/ooxml/schemas/microsoft/wml-cid-2016.xsd +13 -0
  572. package/skills/public/docx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +4 -0
  573. package/skills/public/docx/ooxml/schemas/microsoft/wml-symex-2015.xsd +8 -0
  574. package/skills/public/docx/ooxml/scripts/pack.py +159 -0
  575. package/skills/public/docx/ooxml/scripts/unpack.py +29 -0
  576. package/skills/public/docx/ooxml/scripts/validate.py +69 -0
  577. package/skills/public/docx/ooxml/scripts/validation/__init__.py +15 -0
  578. package/skills/public/docx/ooxml/scripts/validation/base.py +951 -0
  579. package/skills/public/docx/ooxml/scripts/validation/docx.py +274 -0
  580. package/skills/public/docx/ooxml/scripts/validation/pptx.py +315 -0
  581. package/skills/public/docx/ooxml/scripts/validation/redlining.py +279 -0
  582. package/skills/public/docx/ooxml.md +632 -0
  583. package/skills/public/docx/scripts/__init__.py +1 -0
  584. package/skills/public/docx/scripts/document.py +1292 -0
  585. package/skills/public/docx/scripts/templates/comments.xml +3 -0
  586. package/skills/public/docx/scripts/templates/commentsExtended.xml +3 -0
  587. package/skills/public/docx/scripts/templates/commentsExtensible.xml +3 -0
  588. package/skills/public/docx/scripts/templates/commentsIds.xml +3 -0
  589. package/skills/public/docx/scripts/templates/people.xml +3 -0
  590. package/skills/public/docx/scripts/utilities.py +374 -0
  591. package/skills/public/file-reading/LICENSE.txt +30 -0
  592. package/skills/public/file-reading/SKILL.md +350 -0
  593. package/skills/public/frontend-design/LICENSE.txt +177 -0
  594. package/skills/public/frontend-design/SKILL.md +42 -0
  595. package/skills/public/gitlab-explorer/SKILL.md +174 -0
  596. package/skills/public/gitlab-explorer/references/git-commands.md +323 -0
  597. package/skills/public/gitlab-explorer/references/glab-commands.md +282 -0
  598. package/skills/public/gitlab-explorer/scripts/check_gitlab_auth.sh +109 -0
  599. package/skills/public/pdf/FORMS.md +205 -0
  600. package/skills/public/pdf/REFERENCE.md +612 -0
  601. package/skills/public/pdf/SKILL.md +364 -0
  602. package/skills/public/pdf/scripts/check_bounding_boxes.py +70 -0
  603. package/skills/public/pdf/scripts/check_bounding_boxes_test.py +226 -0
  604. package/skills/public/pdf/scripts/check_fillable_fields.py +12 -0
  605. package/skills/public/pdf/scripts/convert_pdf_to_images.py +35 -0
  606. package/skills/public/pdf/scripts/create_validation_image.py +41 -0
  607. package/skills/public/pdf/scripts/extract_form_field_info.py +152 -0
  608. package/skills/public/pdf/scripts/fill_fillable_fields.py +114 -0
  609. package/skills/public/pdf/scripts/fill_pdf_form_with_annotations.py +108 -0
  610. package/skills/public/pdf-reading/LICENSE.txt +30 -0
  611. package/skills/public/pdf-reading/REFERENCE.md +196 -0
  612. package/skills/public/pdf-reading/SKILL.md +305 -0
  613. package/skills/public/playwright-cli/SKILL.md +278 -0
  614. package/skills/public/playwright-cli/references/request-mocking.md +87 -0
  615. package/skills/public/playwright-cli/references/running-code.md +232 -0
  616. package/skills/public/playwright-cli/references/session-management.md +169 -0
  617. package/skills/public/playwright-cli/references/storage-state.md +275 -0
  618. package/skills/public/playwright-cli/references/test-generation.md +88 -0
  619. package/skills/public/playwright-cli/references/tracing.md +139 -0
  620. package/skills/public/playwright-cli/references/video-recording.md +43 -0
  621. package/skills/public/pptx/LICENSE.txt +30 -0
  622. package/skills/public/pptx/SKILL.md +484 -0
  623. package/skills/public/pptx/css.md +335 -0
  624. package/skills/public/pptx/html2pptx.md +893 -0
  625. package/skills/public/pptx/html2pptx.tgz +0 -0
  626. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +1499 -0
  627. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +146 -0
  628. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +1085 -0
  629. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +11 -0
  630. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +3081 -0
  631. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +23 -0
  632. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +185 -0
  633. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +287 -0
  634. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +1676 -0
  635. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +28 -0
  636. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +144 -0
  637. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +174 -0
  638. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +25 -0
  639. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +18 -0
  640. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +59 -0
  641. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +56 -0
  642. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +195 -0
  643. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +582 -0
  644. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +25 -0
  645. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +4439 -0
  646. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +570 -0
  647. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +509 -0
  648. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +12 -0
  649. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +108 -0
  650. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +96 -0
  651. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +3646 -0
  652. package/skills/public/pptx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +116 -0
  653. package/skills/public/pptx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +42 -0
  654. package/skills/public/pptx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +50 -0
  655. package/skills/public/pptx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +49 -0
  656. package/skills/public/pptx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +33 -0
  657. package/skills/public/pptx/ooxml/schemas/mce/mc.xsd +75 -0
  658. package/skills/public/pptx/ooxml/schemas/microsoft/wml-2010.xsd +560 -0
  659. package/skills/public/pptx/ooxml/schemas/microsoft/wml-2012.xsd +67 -0
  660. package/skills/public/pptx/ooxml/schemas/microsoft/wml-2018.xsd +14 -0
  661. package/skills/public/pptx/ooxml/schemas/microsoft/wml-cex-2018.xsd +20 -0
  662. package/skills/public/pptx/ooxml/schemas/microsoft/wml-cid-2016.xsd +13 -0
  663. package/skills/public/pptx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +4 -0
  664. package/skills/public/pptx/ooxml/schemas/microsoft/wml-symex-2015.xsd +8 -0
  665. package/skills/public/pptx/ooxml/scripts/pack.py +159 -0
  666. package/skills/public/pptx/ooxml/scripts/unpack.py +29 -0
  667. package/skills/public/pptx/ooxml/scripts/validate.py +69 -0
  668. package/skills/public/pptx/ooxml/scripts/validation/__init__.py +15 -0
  669. package/skills/public/pptx/ooxml/scripts/validation/base.py +951 -0
  670. package/skills/public/pptx/ooxml/scripts/validation/docx.py +274 -0
  671. package/skills/public/pptx/ooxml/scripts/validation/pptx.py +315 -0
  672. package/skills/public/pptx/ooxml/scripts/validation/redlining.py +279 -0
  673. package/skills/public/pptx/ooxml.md +427 -0
  674. package/skills/public/pptx/scripts/inventory.py +1020 -0
  675. package/skills/public/pptx/scripts/rearrange.py +231 -0
  676. package/skills/public/pptx/scripts/replace.py +385 -0
  677. package/skills/public/pptx/scripts/thumbnail.py +450 -0
  678. package/skills/public/skill-creator/SKILL.md +356 -0
  679. package/skills/public/skill-creator/references/output-patterns.md +82 -0
  680. package/skills/public/skill-creator/references/workflows.md +28 -0
  681. package/skills/public/skill-creator/scripts/init_skill.py +303 -0
  682. package/skills/public/skill-creator/scripts/package_skill.py +110 -0
  683. package/skills/public/skill-creator/scripts/quick_validate.py +95 -0
  684. package/skills/public/sub-agent/SKILL.md +186 -0
  685. package/skills/public/sub-agent/references/security-review.md +153 -0
  686. package/skills/public/sub-agent/references/usage.md +207 -0
  687. package/skills/public/sub-agent/scripts/list_subagent_models.sh +22 -0
  688. package/skills/public/test-driven-development/SKILL.md +371 -0
  689. package/skills/public/test-driven-development/testing-anti-patterns.md +299 -0
  690. package/skills/public/webapp-testing/LICENSE.txt +202 -0
  691. package/skills/public/webapp-testing/SKILL.md +96 -0
  692. package/skills/public/webapp-testing/examples/console_logging.py +35 -0
  693. package/skills/public/webapp-testing/examples/element_discovery.py +40 -0
  694. package/skills/public/webapp-testing/examples/static_html_automation.py +33 -0
  695. package/skills/public/webapp-testing/scripts/with_server.py +106 -0
  696. package/skills/public/xlsx/LICENSE.txt +30 -0
  697. package/skills/public/xlsx/SKILL.md +316 -0
  698. package/skills/public/xlsx/preview_data.py +93 -0
  699. package/skills/public/xlsx/recalc.py +178 -0
  700. package/tests/README.md +42 -0
  701. package/tests/fixtures/cli/claude_v0.9.2.0_argv.json +46 -0
  702. package/tests/fixtures/cli/claude_v0.9.2.0_stdout.json +32 -0
  703. package/tests/fixtures/cli/codex_run.jsonl +4 -0
  704. package/tests/fixtures/cli/opencode_run.jsonl +6 -0
  705. package/tests/integration/README.md +56 -0
  706. package/tests/integration/conftest.py +280 -0
  707. package/tests/integration/pytest.ini +13 -0
  708. package/tests/integration/test_mcp_auth.py +85 -0
  709. package/tests/integration/test_mcp_tools.py +101 -0
  710. package/tests/integration/test_workspace_lifecycle.py +125 -0
  711. package/tests/orchestrator/mock_llm_server.py +343 -0
  712. package/tests/orchestrator/test_cli_adapters.py +566 -0
  713. package/tests/orchestrator/test_cli_adapters_live.py +527 -0
  714. package/tests/orchestrator/test_cli_runtime.py +451 -0
  715. package/tests/orchestrator/test_docker_manager.py +302 -0
  716. package/tests/orchestrator/test_dynamic_instructions.py +69 -0
  717. package/tests/orchestrator/test_mcp_resources.py +140 -0
  718. package/tests/orchestrator/test_mcp_tools.py +224 -0
  719. package/tests/orchestrator/test_passthrough_isolation.py +201 -0
  720. package/tests/orchestrator/test_readme_in_container.py +76 -0
  721. package/tests/orchestrator/test_render_cache.py +84 -0
  722. package/tests/orchestrator/test_runtime_cli_endpoint.py +108 -0
  723. package/tests/orchestrator/test_single_user_mode.py +212 -0
  724. package/tests/orchestrator/test_startup_warnings.py +123 -0
  725. package/tests/orchestrator/test_sub_agent_dispatch.py +327 -0
  726. package/tests/orchestrator/test_subagent_claude_compat.py +367 -0
  727. package/tests/orchestrator/test_system_prompt_endpoint.py +191 -0
  728. package/tests/orchestrator/test_tool_descriptions.py +52 -0
  729. package/tests/orchestrator/test_view_image.py +201 -0
  730. package/tests/patches/conftest.py +30 -0
  731. package/tests/patches/fixtures/__init__.py +10 -0
  732. package/tests/patches/fixtures/middleware_v0.9.1.py +5057 -0
  733. package/tests/patches/fixtures/middleware_v0.9.2.py +5120 -0
  734. package/tests/patches/fixtures/retrieval_v0.9.1.py +2684 -0
  735. package/tests/patches/fixtures/retrieval_v0.9.2.py +2700 -0
  736. package/tests/patches/test_fix_attached_files_position.py +118 -0
  737. package/tests/patches/test_fix_large_tool_args.py +130 -0
  738. package/tests/patches/test_fix_large_tool_results.py +531 -0
  739. package/tests/patches/test_fix_skip_embedding_chat_files.py +160 -0
  740. package/tests/patches/test_fix_skip_rag_files_native_fc.py +120 -0
  741. package/tests/patches/test_fix_tool_loop_errors.py +128 -0
  742. package/tests/security/test_path_traversal_app.py +132 -0
  743. package/tests/security/test_path_traversal_docker.py +36 -0
  744. package/tests/security/test_path_traversal_settings.py +87 -0
  745. package/tests/security/test_safe_path_util.py +166 -0
  746. package/tests/security/test_xss_preview.py +46 -0
  747. package/tests/test-default-model-resolution.py +136 -0
  748. package/tests/test-docker-image.sh +358 -0
  749. package/tests/test-list-subagent-models.sh +421 -0
  750. package/tests/test-mcp-endpoint-live.sh +92 -0
  751. package/tests/test-mcp-native-surface.sh +213 -0
  752. package/tests/test-no-cyrillic.sh +135 -0
  753. package/tests/test-opencode-error-mapping.py +130 -0
  754. package/tests/test-pr88-skills.sh +305 -0
  755. package/tests/test-project-structure.sh +202 -0
  756. package/tests/test-single-user-mode.sh +269 -0
  757. package/tests/test-skill-no-hardcoded-models.sh +65 -0
  758. package/tests/test-subagent-cli-surface.py +137 -0
  759. package/tests/test-subagent-runtime.sh +109 -0
  760. package/tests/test_codex_toml_converter.py +204 -0
  761. package/tests/test_default_resolver_no_legacy_global.py +159 -0
  762. package/tests/test_filter.py +648 -0
  763. package/tests/test_init_sh_unchanged.sh +49 -0
  764. package/tests/test_opencode_alias_map_drop.py +144 -0
  765. package/tests/test_requirements.py +91 -0
  766. package/tests/test_subagent_docstring.py +193 -0
  767. package/tests/test_tools.py +34 -0
  768. package/vendor/extract-text/README.md +46 -0
  769. package/vendor/extract-text/extract-text +0 -0
@@ -0,0 +1,2700 @@
1
+ import json
2
+ import logging
3
+ import mimetypes
4
+ import os
5
+ import shutil
6
+ import asyncio
7
+
8
+ import re
9
+ import uuid
10
+ from datetime import datetime
11
+ from pathlib import Path
12
+ from typing import Iterator, List, Optional, Sequence, Union
13
+
14
+ from fastapi import (
15
+ Depends,
16
+ FastAPI,
17
+ Query,
18
+ File,
19
+ Form,
20
+ HTTPException,
21
+ UploadFile,
22
+ Request,
23
+ status,
24
+ APIRouter,
25
+ )
26
+ from fastapi.middleware.cors import CORSMiddleware
27
+ from fastapi.concurrency import run_in_threadpool
28
+ from pydantic import BaseModel
29
+ import tiktoken
30
+
31
+
32
+ from langchain_text_splitters import (
33
+ RecursiveCharacterTextSplitter,
34
+ TokenTextSplitter,
35
+ MarkdownHeaderTextSplitter,
36
+ )
37
+ from langchain_core.documents import Document
38
+
39
+ from open_webui.models.files import FileModel, FileUpdateForm, Files
40
+ from open_webui.utils.access_control.files import has_access_to_file
41
+ from open_webui.models.knowledge import Knowledges
42
+ from open_webui.storage.provider import Storage
43
+ from open_webui.internal.db import get_async_db, get_async_session
44
+ from sqlalchemy.ext.asyncio import AsyncSession
45
+
46
+
47
+ from open_webui.retrieval.vector.factory import VECTOR_DB_CLIENT
48
+ from open_webui.retrieval.vector.async_client import ASYNC_VECTOR_DB_CLIENT
49
+
50
+ # Document loaders
51
+
52
+ from open_webui.retrieval.loaders.youtube import YoutubeLoader
53
+
54
+ # Web search engines
55
+ from open_webui.retrieval.web.main import SearchResult
56
+ from open_webui.retrieval.web.utils import get_web_loader
57
+ from open_webui.retrieval.web.ollama import search_ollama_cloud
58
+ from open_webui.retrieval.web.perplexity_search import search_perplexity_search
59
+ from open_webui.retrieval.web.brave import search_brave
60
+ from open_webui.retrieval.web.kagi import search_kagi
61
+ from open_webui.retrieval.web.mojeek import search_mojeek
62
+ from open_webui.retrieval.web.bocha import search_bocha
63
+ from open_webui.retrieval.web.duckduckgo import search_duckduckgo
64
+ from open_webui.retrieval.web.google_pse import search_google_pse
65
+ from open_webui.retrieval.web.jina_search import search_jina
66
+ from open_webui.retrieval.web.searchapi import search_searchapi
67
+ from open_webui.retrieval.web.serpapi import search_serpapi
68
+ from open_webui.retrieval.web.searxng import search_searxng
69
+ from open_webui.retrieval.web.yacy import search_yacy
70
+ from open_webui.retrieval.web.serper import search_serper
71
+ from open_webui.retrieval.web.serply import search_serply
72
+ from open_webui.retrieval.web.serpstack import search_serpstack
73
+ from open_webui.retrieval.web.tavily import search_tavily
74
+ from open_webui.retrieval.web.bing import search_bing
75
+ from open_webui.retrieval.web.azure import search_azure
76
+ from open_webui.retrieval.web.exa import search_exa
77
+ from open_webui.retrieval.web.perplexity import search_perplexity
78
+ from open_webui.retrieval.web.sougou import search_sougou
79
+ from open_webui.retrieval.web.firecrawl import search_firecrawl
80
+ from open_webui.retrieval.web.external import search_external
81
+ from open_webui.retrieval.web.yandex import search_yandex
82
+ from open_webui.retrieval.web.ydc import search_youcom
83
+
84
+ from open_webui.retrieval.utils import (
85
+ build_loader_from_config,
86
+ filter_accessible_collections,
87
+ get_content_from_url,
88
+ get_embedding_function,
89
+ get_reranking_function,
90
+ get_model_path,
91
+ query_collection,
92
+ query_collection_with_hybrid_search,
93
+ query_doc,
94
+ query_doc_with_hybrid_search,
95
+ )
96
+ from open_webui.retrieval.vector.utils import filter_metadata
97
+ from open_webui.utils.misc import (
98
+ calculate_sha256_string,
99
+ sanitize_text_for_db,
100
+ )
101
+ from open_webui.utils.auth import get_admin_user, get_verified_user
102
+ from open_webui.utils.access_control import has_permission
103
+
104
+ from open_webui.config import (
105
+ ENV,
106
+ RAG_EMBEDDING_MODEL_AUTO_UPDATE,
107
+ RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
108
+ RAG_RERANKING_MODEL_AUTO_UPDATE,
109
+ RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
110
+ UPLOAD_DIR,
111
+ DEFAULT_LOCALE,
112
+ RAG_EMBEDDING_CONTENT_PREFIX,
113
+ RAG_EMBEDDING_QUERY_PREFIX,
114
+ )
115
+ from open_webui.env import (
116
+ DEVICE_TYPE,
117
+ DOCKER,
118
+ RAG_EMBEDDING_TIMEOUT,
119
+ SENTENCE_TRANSFORMERS_BACKEND,
120
+ SENTENCE_TRANSFORMERS_MODEL_KWARGS,
121
+ SENTENCE_TRANSFORMERS_CROSS_ENCODER_BACKEND,
122
+ SENTENCE_TRANSFORMERS_CROSS_ENCODER_MODEL_KWARGS,
123
+ SENTENCE_TRANSFORMERS_CROSS_ENCODER_SIGMOID_ACTIVATION_FUNCTION,
124
+ )
125
+
126
+ from open_webui.constants import ERROR_MESSAGES
127
+
128
+ log = logging.getLogger(__name__)
129
+
130
+ ##########################################
131
+ #
132
+ # Utility functions
133
+ # Give us this day our relevant chunks, and lead us
134
+ # not into hallucination, but deliver us from noise.
135
+ #
136
+ ##########################################
137
+
138
+
139
+ def get_ef(
140
+ engine: str,
141
+ embedding_model: str,
142
+ auto_update: bool = RAG_EMBEDDING_MODEL_AUTO_UPDATE,
143
+ ):
144
+ ef = None
145
+ if embedding_model and engine == '':
146
+ from sentence_transformers import SentenceTransformer
147
+
148
+ try:
149
+ ef = SentenceTransformer(
150
+ get_model_path(embedding_model, auto_update),
151
+ device=DEVICE_TYPE,
152
+ trust_remote_code=RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
153
+ backend=SENTENCE_TRANSFORMERS_BACKEND,
154
+ model_kwargs=SENTENCE_TRANSFORMERS_MODEL_KWARGS,
155
+ )
156
+ except Exception as e:
157
+ log.error(f'Error loading SentenceTransformer: {e}')
158
+
159
+ return ef
160
+
161
+
162
+ def get_rf(
163
+ engine: str = '',
164
+ reranking_model: Optional[str] = None,
165
+ external_reranker_url: str = '',
166
+ external_reranker_api_key: str = '',
167
+ external_reranker_timeout: str = '',
168
+ auto_update: bool = RAG_RERANKING_MODEL_AUTO_UPDATE,
169
+ ):
170
+ rf = None
171
+ # Convert timeout string to int or None (system default)
172
+ timeout_value = int(external_reranker_timeout) if external_reranker_timeout else None
173
+ if reranking_model:
174
+ if any(model in reranking_model for model in ['jinaai/jina-colbert-v2']):
175
+ try:
176
+ from open_webui.retrieval.models.colbert import ColBERT
177
+
178
+ rf = ColBERT(
179
+ get_model_path(reranking_model, auto_update),
180
+ env='docker' if DOCKER else None,
181
+ )
182
+
183
+ except Exception as e:
184
+ log.error(f'ColBERT: {e}')
185
+ raise Exception(ERROR_MESSAGES.DEFAULT(e))
186
+ else:
187
+ if engine == 'external':
188
+ try:
189
+ from open_webui.retrieval.models.external import ExternalReranker
190
+
191
+ rf = ExternalReranker(
192
+ url=external_reranker_url,
193
+ api_key=external_reranker_api_key,
194
+ model=reranking_model,
195
+ timeout=timeout_value,
196
+ )
197
+ except Exception as e:
198
+ log.error(f'ExternalReranking: {e}')
199
+ raise Exception(ERROR_MESSAGES.DEFAULT(e))
200
+ else:
201
+ import sentence_transformers
202
+ import torch
203
+
204
+ try:
205
+ rf = sentence_transformers.CrossEncoder(
206
+ get_model_path(reranking_model, auto_update),
207
+ device=DEVICE_TYPE,
208
+ trust_remote_code=RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
209
+ backend=SENTENCE_TRANSFORMERS_CROSS_ENCODER_BACKEND,
210
+ model_kwargs=SENTENCE_TRANSFORMERS_CROSS_ENCODER_MODEL_KWARGS,
211
+ activation_fn=(
212
+ torch.nn.Sigmoid()
213
+ if SENTENCE_TRANSFORMERS_CROSS_ENCODER_SIGMOID_ACTIVATION_FUNCTION
214
+ else None
215
+ ),
216
+ )
217
+ except Exception as e:
218
+ log.error(f'CrossEncoder: {e}')
219
+ raise Exception(ERROR_MESSAGES.DEFAULT('CrossEncoder error'))
220
+
221
+ # Safely adjust pad_token_id if missing as some models do not have this in config
222
+ try:
223
+ model_cfg = getattr(rf, 'model', None)
224
+ if model_cfg and hasattr(model_cfg, 'config'):
225
+ cfg = model_cfg.config
226
+ if getattr(cfg, 'pad_token_id', None) is None:
227
+ # Fallback to eos_token_id when available
228
+ eos = getattr(cfg, 'eos_token_id', None)
229
+ if eos is not None:
230
+ cfg.pad_token_id = eos
231
+ log.debug(f'Missing pad_token_id detected; set to eos_token_id={eos}')
232
+ else:
233
+ log.warning('Neither pad_token_id nor eos_token_id present in model config')
234
+ except Exception as e2:
235
+ log.warning(f'Failed to adjust pad_token_id on CrossEncoder: {e2}')
236
+
237
+ return rf
238
+
239
+
240
+ ##########################################
241
+ #
242
+ # API routes
243
+ #
244
+ ##########################################
245
+
246
+
247
+ router = APIRouter()
248
+
249
+
250
+ class CollectionNameForm(BaseModel):
251
+ collection_name: Optional[str] = None
252
+
253
+
254
+ class ProcessUrlForm(CollectionNameForm):
255
+ url: str
256
+
257
+
258
+ class SearchForm(BaseModel):
259
+ queries: List[str]
260
+
261
+
262
+ @router.get('/')
263
+ async def get_status(request: Request):
264
+ return {
265
+ 'status': True,
266
+ 'CHUNK_SIZE': request.app.state.config.CHUNK_SIZE,
267
+ 'CHUNK_OVERLAP': request.app.state.config.CHUNK_OVERLAP,
268
+ 'RAG_TEMPLATE': request.app.state.config.RAG_TEMPLATE,
269
+ 'RAG_EMBEDDING_ENGINE': request.app.state.config.RAG_EMBEDDING_ENGINE,
270
+ 'RAG_EMBEDDING_MODEL': request.app.state.config.RAG_EMBEDDING_MODEL,
271
+ 'RAG_RERANKING_MODEL': request.app.state.config.RAG_RERANKING_MODEL,
272
+ 'RAG_EMBEDDING_BATCH_SIZE': request.app.state.config.RAG_EMBEDDING_BATCH_SIZE,
273
+ 'ENABLE_ASYNC_EMBEDDING': request.app.state.config.ENABLE_ASYNC_EMBEDDING,
274
+ 'RAG_EMBEDDING_CONCURRENT_REQUESTS': request.app.state.config.RAG_EMBEDDING_CONCURRENT_REQUESTS,
275
+ }
276
+
277
+
278
+ @router.get('/embedding')
279
+ async def get_embedding_config(request: Request, user=Depends(get_admin_user)):
280
+ return {
281
+ 'status': True,
282
+ 'RAG_EMBEDDING_ENGINE': request.app.state.config.RAG_EMBEDDING_ENGINE,
283
+ 'RAG_EMBEDDING_MODEL': request.app.state.config.RAG_EMBEDDING_MODEL,
284
+ 'RAG_EMBEDDING_BATCH_SIZE': request.app.state.config.RAG_EMBEDDING_BATCH_SIZE,
285
+ 'ENABLE_ASYNC_EMBEDDING': request.app.state.config.ENABLE_ASYNC_EMBEDDING,
286
+ 'RAG_EMBEDDING_CONCURRENT_REQUESTS': request.app.state.config.RAG_EMBEDDING_CONCURRENT_REQUESTS,
287
+ 'openai_config': {
288
+ 'url': request.app.state.config.RAG_OPENAI_API_BASE_URL,
289
+ 'key': request.app.state.config.RAG_OPENAI_API_KEY,
290
+ },
291
+ 'ollama_config': {
292
+ 'url': request.app.state.config.RAG_OLLAMA_BASE_URL,
293
+ 'key': request.app.state.config.RAG_OLLAMA_API_KEY,
294
+ },
295
+ 'azure_openai_config': {
296
+ 'url': request.app.state.config.RAG_AZURE_OPENAI_BASE_URL,
297
+ 'key': request.app.state.config.RAG_AZURE_OPENAI_API_KEY,
298
+ 'version': request.app.state.config.RAG_AZURE_OPENAI_API_VERSION,
299
+ },
300
+ }
301
+
302
+
303
+ class OpenAIConfigForm(BaseModel):
304
+ url: str
305
+ key: str
306
+
307
+
308
+ class OllamaConfigForm(BaseModel):
309
+ url: str
310
+ key: str
311
+
312
+
313
+ class AzureOpenAIConfigForm(BaseModel):
314
+ url: str
315
+ key: str
316
+ version: str
317
+
318
+
319
+ class EmbeddingModelUpdateForm(BaseModel):
320
+ openai_config: Optional[OpenAIConfigForm] = None
321
+ ollama_config: Optional[OllamaConfigForm] = None
322
+ azure_openai_config: Optional[AzureOpenAIConfigForm] = None
323
+ RAG_EMBEDDING_ENGINE: str
324
+ RAG_EMBEDDING_MODEL: str
325
+ RAG_EMBEDDING_BATCH_SIZE: Optional[int] = 1
326
+ ENABLE_ASYNC_EMBEDDING: Optional[bool] = True
327
+ RAG_EMBEDDING_CONCURRENT_REQUESTS: Optional[int] = 0
328
+
329
+
330
+ def unload_embedding_model(request: Request):
331
+ if request.app.state.config.RAG_EMBEDDING_ENGINE == '':
332
+ # unloads current internal embedding model and clears VRAM cache
333
+ request.app.state.ef = None
334
+ request.app.state.EMBEDDING_FUNCTION = None
335
+ import gc
336
+
337
+ gc.collect()
338
+ if DEVICE_TYPE == 'cuda':
339
+ import torch
340
+
341
+ if torch.cuda.is_available():
342
+ torch.cuda.empty_cache()
343
+
344
+
345
+ @router.post('/embedding/update')
346
+ async def update_embedding_config(request: Request, form_data: EmbeddingModelUpdateForm, user=Depends(get_admin_user)):
347
+ log.info(
348
+ f'Updating embedding model: {request.app.state.config.RAG_EMBEDDING_MODEL} to {form_data.RAG_EMBEDDING_MODEL}'
349
+ )
350
+ unload_embedding_model(request)
351
+ try:
352
+ request.app.state.config.RAG_EMBEDDING_ENGINE = form_data.RAG_EMBEDDING_ENGINE
353
+ request.app.state.config.RAG_EMBEDDING_MODEL = form_data.RAG_EMBEDDING_MODEL
354
+ request.app.state.config.RAG_EMBEDDING_BATCH_SIZE = form_data.RAG_EMBEDDING_BATCH_SIZE
355
+ request.app.state.config.ENABLE_ASYNC_EMBEDDING = form_data.ENABLE_ASYNC_EMBEDDING
356
+ request.app.state.config.RAG_EMBEDDING_CONCURRENT_REQUESTS = form_data.RAG_EMBEDDING_CONCURRENT_REQUESTS
357
+
358
+ if request.app.state.config.RAG_EMBEDDING_ENGINE in [
359
+ 'ollama',
360
+ 'openai',
361
+ 'azure_openai',
362
+ ]:
363
+ if form_data.openai_config is not None:
364
+ request.app.state.config.RAG_OPENAI_API_BASE_URL = form_data.openai_config.url
365
+ request.app.state.config.RAG_OPENAI_API_KEY = form_data.openai_config.key
366
+
367
+ if form_data.ollama_config is not None:
368
+ request.app.state.config.RAG_OLLAMA_BASE_URL = form_data.ollama_config.url
369
+ request.app.state.config.RAG_OLLAMA_API_KEY = form_data.ollama_config.key
370
+
371
+ if form_data.azure_openai_config is not None:
372
+ request.app.state.config.RAG_AZURE_OPENAI_BASE_URL = form_data.azure_openai_config.url
373
+ request.app.state.config.RAG_AZURE_OPENAI_API_KEY = form_data.azure_openai_config.key
374
+ request.app.state.config.RAG_AZURE_OPENAI_API_VERSION = form_data.azure_openai_config.version
375
+
376
+ request.app.state.ef = get_ef(
377
+ request.app.state.config.RAG_EMBEDDING_ENGINE,
378
+ request.app.state.config.RAG_EMBEDDING_MODEL,
379
+ )
380
+
381
+ request.app.state.EMBEDDING_FUNCTION = get_embedding_function(
382
+ request.app.state.config.RAG_EMBEDDING_ENGINE,
383
+ request.app.state.config.RAG_EMBEDDING_MODEL,
384
+ request.app.state.ef,
385
+ (
386
+ request.app.state.config.RAG_OPENAI_API_BASE_URL
387
+ if request.app.state.config.RAG_EMBEDDING_ENGINE == 'openai'
388
+ else (
389
+ request.app.state.config.RAG_OLLAMA_BASE_URL
390
+ if request.app.state.config.RAG_EMBEDDING_ENGINE == 'ollama'
391
+ else request.app.state.config.RAG_AZURE_OPENAI_BASE_URL
392
+ )
393
+ ),
394
+ (
395
+ request.app.state.config.RAG_OPENAI_API_KEY
396
+ if request.app.state.config.RAG_EMBEDDING_ENGINE == 'openai'
397
+ else (
398
+ request.app.state.config.RAG_OLLAMA_API_KEY
399
+ if request.app.state.config.RAG_EMBEDDING_ENGINE == 'ollama'
400
+ else request.app.state.config.RAG_AZURE_OPENAI_API_KEY
401
+ )
402
+ ),
403
+ request.app.state.config.RAG_EMBEDDING_BATCH_SIZE,
404
+ azure_api_version=(
405
+ request.app.state.config.RAG_AZURE_OPENAI_API_VERSION
406
+ if request.app.state.config.RAG_EMBEDDING_ENGINE == 'azure_openai'
407
+ else None
408
+ ),
409
+ enable_async=request.app.state.config.ENABLE_ASYNC_EMBEDDING,
410
+ concurrent_requests=request.app.state.config.RAG_EMBEDDING_CONCURRENT_REQUESTS,
411
+ )
412
+
413
+ return {
414
+ 'status': True,
415
+ 'RAG_EMBEDDING_ENGINE': request.app.state.config.RAG_EMBEDDING_ENGINE,
416
+ 'RAG_EMBEDDING_MODEL': request.app.state.config.RAG_EMBEDDING_MODEL,
417
+ 'RAG_EMBEDDING_BATCH_SIZE': request.app.state.config.RAG_EMBEDDING_BATCH_SIZE,
418
+ 'ENABLE_ASYNC_EMBEDDING': request.app.state.config.ENABLE_ASYNC_EMBEDDING,
419
+ 'RAG_EMBEDDING_CONCURRENT_REQUESTS': request.app.state.config.RAG_EMBEDDING_CONCURRENT_REQUESTS,
420
+ 'openai_config': {
421
+ 'url': request.app.state.config.RAG_OPENAI_API_BASE_URL,
422
+ 'key': request.app.state.config.RAG_OPENAI_API_KEY,
423
+ },
424
+ 'ollama_config': {
425
+ 'url': request.app.state.config.RAG_OLLAMA_BASE_URL,
426
+ 'key': request.app.state.config.RAG_OLLAMA_API_KEY,
427
+ },
428
+ 'azure_openai_config': {
429
+ 'url': request.app.state.config.RAG_AZURE_OPENAI_BASE_URL,
430
+ 'key': request.app.state.config.RAG_AZURE_OPENAI_API_KEY,
431
+ 'version': request.app.state.config.RAG_AZURE_OPENAI_API_VERSION,
432
+ },
433
+ }
434
+ except Exception as e:
435
+ log.exception(f'Problem updating embedding model: {e}')
436
+ raise HTTPException(
437
+ status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
438
+ detail=ERROR_MESSAGES.DEFAULT(e),
439
+ )
440
+
441
+
442
+ @router.get('/config')
443
+ async def get_rag_config(request: Request, user=Depends(get_admin_user)):
444
+ return {
445
+ 'status': True,
446
+ # RAG settings
447
+ 'RAG_TEMPLATE': request.app.state.config.RAG_TEMPLATE,
448
+ 'TOP_K': request.app.state.config.TOP_K,
449
+ 'BYPASS_EMBEDDING_AND_RETRIEVAL': request.app.state.config.BYPASS_EMBEDDING_AND_RETRIEVAL,
450
+ 'RAG_FULL_CONTEXT': request.app.state.config.RAG_FULL_CONTEXT,
451
+ # Hybrid search settings
452
+ 'ENABLE_RAG_HYBRID_SEARCH': request.app.state.config.ENABLE_RAG_HYBRID_SEARCH,
453
+ 'ENABLE_RAG_HYBRID_SEARCH_ENRICHED_TEXTS': request.app.state.config.ENABLE_RAG_HYBRID_SEARCH_ENRICHED_TEXTS,
454
+ 'TOP_K_RERANKER': request.app.state.config.TOP_K_RERANKER,
455
+ 'RELEVANCE_THRESHOLD': request.app.state.config.RELEVANCE_THRESHOLD,
456
+ 'HYBRID_BM25_WEIGHT': request.app.state.config.HYBRID_BM25_WEIGHT,
457
+ # Content extraction settings
458
+ 'CONTENT_EXTRACTION_ENGINE': request.app.state.config.CONTENT_EXTRACTION_ENGINE,
459
+ 'PDF_EXTRACT_IMAGES': request.app.state.config.PDF_EXTRACT_IMAGES,
460
+ 'PDF_LOADER_MODE': request.app.state.config.PDF_LOADER_MODE,
461
+ 'DATALAB_MARKER_API_KEY': request.app.state.config.DATALAB_MARKER_API_KEY,
462
+ 'DATALAB_MARKER_API_BASE_URL': request.app.state.config.DATALAB_MARKER_API_BASE_URL,
463
+ 'DATALAB_MARKER_ADDITIONAL_CONFIG': request.app.state.config.DATALAB_MARKER_ADDITIONAL_CONFIG,
464
+ 'DATALAB_MARKER_SKIP_CACHE': request.app.state.config.DATALAB_MARKER_SKIP_CACHE,
465
+ 'DATALAB_MARKER_FORCE_OCR': request.app.state.config.DATALAB_MARKER_FORCE_OCR,
466
+ 'DATALAB_MARKER_PAGINATE': request.app.state.config.DATALAB_MARKER_PAGINATE,
467
+ 'DATALAB_MARKER_STRIP_EXISTING_OCR': request.app.state.config.DATALAB_MARKER_STRIP_EXISTING_OCR,
468
+ 'DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION': request.app.state.config.DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION,
469
+ 'DATALAB_MARKER_FORMAT_LINES': request.app.state.config.DATALAB_MARKER_FORMAT_LINES,
470
+ 'DATALAB_MARKER_USE_LLM': request.app.state.config.DATALAB_MARKER_USE_LLM,
471
+ 'DATALAB_MARKER_OUTPUT_FORMAT': request.app.state.config.DATALAB_MARKER_OUTPUT_FORMAT,
472
+ 'EXTERNAL_DOCUMENT_LOADER_URL': request.app.state.config.EXTERNAL_DOCUMENT_LOADER_URL,
473
+ 'EXTERNAL_DOCUMENT_LOADER_API_KEY': request.app.state.config.EXTERNAL_DOCUMENT_LOADER_API_KEY,
474
+ 'TIKA_SERVER_URL': request.app.state.config.TIKA_SERVER_URL,
475
+ 'DOCLING_SERVER_URL': request.app.state.config.DOCLING_SERVER_URL,
476
+ 'DOCLING_API_KEY': request.app.state.config.DOCLING_API_KEY,
477
+ 'DOCLING_PARAMS': request.app.state.config.DOCLING_PARAMS,
478
+ 'DOCUMENT_INTELLIGENCE_ENDPOINT': request.app.state.config.DOCUMENT_INTELLIGENCE_ENDPOINT,
479
+ 'DOCUMENT_INTELLIGENCE_KEY': request.app.state.config.DOCUMENT_INTELLIGENCE_KEY,
480
+ 'DOCUMENT_INTELLIGENCE_MODEL': request.app.state.config.DOCUMENT_INTELLIGENCE_MODEL,
481
+ 'MISTRAL_OCR_API_BASE_URL': request.app.state.config.MISTRAL_OCR_API_BASE_URL,
482
+ 'MISTRAL_OCR_API_KEY': request.app.state.config.MISTRAL_OCR_API_KEY,
483
+ 'PADDLEOCR_VL_BASE_URL': request.app.state.config.PADDLEOCR_VL_BASE_URL,
484
+ 'PADDLEOCR_VL_TOKEN': request.app.state.config.PADDLEOCR_VL_TOKEN,
485
+ # MinerU settings
486
+ 'MINERU_API_MODE': request.app.state.config.MINERU_API_MODE,
487
+ 'MINERU_API_URL': request.app.state.config.MINERU_API_URL,
488
+ 'MINERU_API_KEY': request.app.state.config.MINERU_API_KEY,
489
+ 'MINERU_API_TIMEOUT': request.app.state.config.MINERU_API_TIMEOUT,
490
+ 'MINERU_PARAMS': request.app.state.config.MINERU_PARAMS,
491
+ # Reranking settings
492
+ 'RAG_RERANKING_MODEL': request.app.state.config.RAG_RERANKING_MODEL,
493
+ 'RAG_RERANKING_ENGINE': request.app.state.config.RAG_RERANKING_ENGINE,
494
+ 'RAG_RERANKING_BATCH_SIZE': request.app.state.config.RAG_RERANKING_BATCH_SIZE,
495
+ 'RAG_EXTERNAL_RERANKER_URL': request.app.state.config.RAG_EXTERNAL_RERANKER_URL,
496
+ 'RAG_EXTERNAL_RERANKER_API_KEY': request.app.state.config.RAG_EXTERNAL_RERANKER_API_KEY,
497
+ 'RAG_EXTERNAL_RERANKER_TIMEOUT': request.app.state.config.RAG_EXTERNAL_RERANKER_TIMEOUT,
498
+ # Chunking settings
499
+ 'TEXT_SPLITTER': request.app.state.config.TEXT_SPLITTER,
500
+ 'ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER': request.app.state.config.ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER,
501
+ 'CHUNK_SIZE': request.app.state.config.CHUNK_SIZE,
502
+ 'CHUNK_MIN_SIZE_TARGET': request.app.state.config.CHUNK_MIN_SIZE_TARGET,
503
+ 'CHUNK_OVERLAP': request.app.state.config.CHUNK_OVERLAP,
504
+ # File upload settings
505
+ 'FILE_MAX_SIZE': request.app.state.config.FILE_MAX_SIZE,
506
+ 'FILE_MAX_COUNT': request.app.state.config.FILE_MAX_COUNT,
507
+ 'FILE_IMAGE_COMPRESSION_WIDTH': request.app.state.config.FILE_IMAGE_COMPRESSION_WIDTH,
508
+ 'FILE_IMAGE_COMPRESSION_HEIGHT': request.app.state.config.FILE_IMAGE_COMPRESSION_HEIGHT,
509
+ 'ALLOWED_FILE_EXTENSIONS': request.app.state.config.ALLOWED_FILE_EXTENSIONS,
510
+ # Integration settings
511
+ 'ENABLE_GOOGLE_DRIVE_INTEGRATION': request.app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION,
512
+ 'ENABLE_ONEDRIVE_INTEGRATION': request.app.state.config.ENABLE_ONEDRIVE_INTEGRATION,
513
+ # Web search settings
514
+ 'web': {
515
+ 'ENABLE_WEB_SEARCH': request.app.state.config.ENABLE_WEB_SEARCH,
516
+ 'WEB_SEARCH_ENGINE': request.app.state.config.WEB_SEARCH_ENGINE,
517
+ 'WEB_SEARCH_TRUST_ENV': request.app.state.config.WEB_SEARCH_TRUST_ENV,
518
+ 'WEB_SEARCH_RESULT_COUNT': request.app.state.config.WEB_SEARCH_RESULT_COUNT,
519
+ 'WEB_SEARCH_CONCURRENT_REQUESTS': request.app.state.config.WEB_SEARCH_CONCURRENT_REQUESTS,
520
+ 'WEB_FETCH_MAX_CONTENT_LENGTH': request.app.state.config.WEB_FETCH_MAX_CONTENT_LENGTH,
521
+ 'WEB_LOADER_CONCURRENT_REQUESTS': request.app.state.config.WEB_LOADER_CONCURRENT_REQUESTS,
522
+ 'WEB_SEARCH_DOMAIN_FILTER_LIST': request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
523
+ 'BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL': request.app.state.config.BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL,
524
+ 'BYPASS_WEB_SEARCH_WEB_LOADER': request.app.state.config.BYPASS_WEB_SEARCH_WEB_LOADER,
525
+ 'OLLAMA_CLOUD_WEB_SEARCH_API_KEY': request.app.state.config.OLLAMA_CLOUD_WEB_SEARCH_API_KEY,
526
+ 'SEARXNG_QUERY_URL': request.app.state.config.SEARXNG_QUERY_URL,
527
+ 'SEARXNG_LANGUAGE': request.app.state.config.SEARXNG_LANGUAGE,
528
+ 'YACY_QUERY_URL': request.app.state.config.YACY_QUERY_URL,
529
+ 'YACY_USERNAME': request.app.state.config.YACY_USERNAME,
530
+ 'YACY_PASSWORD': request.app.state.config.YACY_PASSWORD,
531
+ 'GOOGLE_PSE_API_KEY': request.app.state.config.GOOGLE_PSE_API_KEY,
532
+ 'GOOGLE_PSE_ENGINE_ID': request.app.state.config.GOOGLE_PSE_ENGINE_ID,
533
+ 'BRAVE_SEARCH_API_KEY': request.app.state.config.BRAVE_SEARCH_API_KEY,
534
+ 'KAGI_SEARCH_API_KEY': request.app.state.config.KAGI_SEARCH_API_KEY,
535
+ 'MOJEEK_SEARCH_API_KEY': request.app.state.config.MOJEEK_SEARCH_API_KEY,
536
+ 'BOCHA_SEARCH_API_KEY': request.app.state.config.BOCHA_SEARCH_API_KEY,
537
+ 'SERPSTACK_API_KEY': request.app.state.config.SERPSTACK_API_KEY,
538
+ 'SERPSTACK_HTTPS': request.app.state.config.SERPSTACK_HTTPS,
539
+ 'SERPER_API_KEY': request.app.state.config.SERPER_API_KEY,
540
+ 'SERPLY_API_KEY': request.app.state.config.SERPLY_API_KEY,
541
+ 'DDGS_BACKEND': request.app.state.config.DDGS_BACKEND,
542
+ 'TAVILY_API_KEY': request.app.state.config.TAVILY_API_KEY,
543
+ 'SEARCHAPI_API_KEY': request.app.state.config.SEARCHAPI_API_KEY,
544
+ 'SEARCHAPI_ENGINE': request.app.state.config.SEARCHAPI_ENGINE,
545
+ 'SERPAPI_API_KEY': request.app.state.config.SERPAPI_API_KEY,
546
+ 'SERPAPI_ENGINE': request.app.state.config.SERPAPI_ENGINE,
547
+ 'JINA_API_KEY': request.app.state.config.JINA_API_KEY,
548
+ 'JINA_API_BASE_URL': request.app.state.config.JINA_API_BASE_URL,
549
+ 'BING_SEARCH_V7_ENDPOINT': request.app.state.config.BING_SEARCH_V7_ENDPOINT,
550
+ 'BING_SEARCH_V7_SUBSCRIPTION_KEY': request.app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY,
551
+ 'EXA_API_KEY': request.app.state.config.EXA_API_KEY,
552
+ 'PERPLEXITY_API_KEY': request.app.state.config.PERPLEXITY_API_KEY,
553
+ 'PERPLEXITY_MODEL': request.app.state.config.PERPLEXITY_MODEL,
554
+ 'PERPLEXITY_SEARCH_CONTEXT_USAGE': request.app.state.config.PERPLEXITY_SEARCH_CONTEXT_USAGE,
555
+ 'PERPLEXITY_SEARCH_API_URL': request.app.state.config.PERPLEXITY_SEARCH_API_URL,
556
+ 'SOUGOU_API_SID': request.app.state.config.SOUGOU_API_SID,
557
+ 'SOUGOU_API_SK': request.app.state.config.SOUGOU_API_SK,
558
+ 'WEB_LOADER_ENGINE': request.app.state.config.WEB_LOADER_ENGINE,
559
+ 'WEB_LOADER_TIMEOUT': request.app.state.config.WEB_LOADER_TIMEOUT,
560
+ 'ENABLE_WEB_LOADER_SSL_VERIFICATION': request.app.state.config.ENABLE_WEB_LOADER_SSL_VERIFICATION,
561
+ 'PLAYWRIGHT_WS_URL': request.app.state.config.PLAYWRIGHT_WS_URL,
562
+ 'PLAYWRIGHT_TIMEOUT': request.app.state.config.PLAYWRIGHT_TIMEOUT,
563
+ 'FIRECRAWL_API_KEY': request.app.state.config.FIRECRAWL_API_KEY,
564
+ 'FIRECRAWL_API_BASE_URL': request.app.state.config.FIRECRAWL_API_BASE_URL,
565
+ 'FIRECRAWL_TIMEOUT': request.app.state.config.FIRECRAWL_TIMEOUT,
566
+ 'TAVILY_EXTRACT_DEPTH': request.app.state.config.TAVILY_EXTRACT_DEPTH,
567
+ 'EXTERNAL_WEB_SEARCH_URL': request.app.state.config.EXTERNAL_WEB_SEARCH_URL,
568
+ 'EXTERNAL_WEB_SEARCH_API_KEY': request.app.state.config.EXTERNAL_WEB_SEARCH_API_KEY,
569
+ 'EXTERNAL_WEB_LOADER_URL': request.app.state.config.EXTERNAL_WEB_LOADER_URL,
570
+ 'EXTERNAL_WEB_LOADER_API_KEY': request.app.state.config.EXTERNAL_WEB_LOADER_API_KEY,
571
+ 'YOUTUBE_LOADER_LANGUAGE': request.app.state.config.YOUTUBE_LOADER_LANGUAGE,
572
+ 'YOUTUBE_LOADER_PROXY_URL': request.app.state.config.YOUTUBE_LOADER_PROXY_URL,
573
+ 'YOUTUBE_LOADER_TRANSLATION': request.app.state.YOUTUBE_LOADER_TRANSLATION,
574
+ 'YANDEX_WEB_SEARCH_URL': request.app.state.config.YANDEX_WEB_SEARCH_URL,
575
+ 'YANDEX_WEB_SEARCH_API_KEY': request.app.state.config.YANDEX_WEB_SEARCH_API_KEY,
576
+ 'YANDEX_WEB_SEARCH_CONFIG': request.app.state.config.YANDEX_WEB_SEARCH_CONFIG,
577
+ 'YOUCOM_API_KEY': request.app.state.config.YOUCOM_API_KEY,
578
+ },
579
+ }
580
+
581
+
582
+ class WebConfig(BaseModel):
583
+ ENABLE_WEB_SEARCH: Optional[bool] = None
584
+ WEB_SEARCH_ENGINE: Optional[str] = None
585
+ WEB_SEARCH_TRUST_ENV: Optional[bool] = None
586
+ WEB_SEARCH_RESULT_COUNT: Optional[int] = None
587
+ WEB_SEARCH_CONCURRENT_REQUESTS: Optional[int] = None
588
+ WEB_SEARCH_DOMAIN_FILTER_LIST: Optional[List[str]] = []
589
+ WEB_FETCH_MAX_CONTENT_LENGTH: Optional[int] = None
590
+ WEB_LOADER_CONCURRENT_REQUESTS: Optional[int] = None
591
+ BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL: Optional[bool] = None
592
+ BYPASS_WEB_SEARCH_WEB_LOADER: Optional[bool] = None
593
+ OLLAMA_CLOUD_WEB_SEARCH_API_KEY: Optional[str] = None
594
+ SEARXNG_QUERY_URL: Optional[str] = None
595
+ SEARXNG_LANGUAGE: Optional[str] = None
596
+ YACY_QUERY_URL: Optional[str] = None
597
+ YACY_USERNAME: Optional[str] = None
598
+ YACY_PASSWORD: Optional[str] = None
599
+ GOOGLE_PSE_API_KEY: Optional[str] = None
600
+ GOOGLE_PSE_ENGINE_ID: Optional[str] = None
601
+ BRAVE_SEARCH_API_KEY: Optional[str] = None
602
+ KAGI_SEARCH_API_KEY: Optional[str] = None
603
+ MOJEEK_SEARCH_API_KEY: Optional[str] = None
604
+ BOCHA_SEARCH_API_KEY: Optional[str] = None
605
+ SERPSTACK_API_KEY: Optional[str] = None
606
+ SERPSTACK_HTTPS: Optional[bool] = None
607
+ SERPER_API_KEY: Optional[str] = None
608
+ SERPLY_API_KEY: Optional[str] = None
609
+ DDGS_BACKEND: Optional[str] = None
610
+ TAVILY_API_KEY: Optional[str] = None
611
+ SEARCHAPI_API_KEY: Optional[str] = None
612
+ SEARCHAPI_ENGINE: Optional[str] = None
613
+ SERPAPI_API_KEY: Optional[str] = None
614
+ SERPAPI_ENGINE: Optional[str] = None
615
+ JINA_API_KEY: Optional[str] = None
616
+ JINA_API_BASE_URL: Optional[str] = None
617
+ BING_SEARCH_V7_ENDPOINT: Optional[str] = None
618
+ BING_SEARCH_V7_SUBSCRIPTION_KEY: Optional[str] = None
619
+ EXA_API_KEY: Optional[str] = None
620
+ PERPLEXITY_API_KEY: Optional[str] = None
621
+ PERPLEXITY_MODEL: Optional[str] = None
622
+ PERPLEXITY_SEARCH_CONTEXT_USAGE: Optional[str] = None
623
+ PERPLEXITY_SEARCH_API_URL: Optional[str] = None
624
+ SOUGOU_API_SID: Optional[str] = None
625
+ SOUGOU_API_SK: Optional[str] = None
626
+ WEB_LOADER_ENGINE: Optional[str] = None
627
+ WEB_LOADER_TIMEOUT: Optional[str] = None
628
+ ENABLE_WEB_LOADER_SSL_VERIFICATION: Optional[bool] = None
629
+ PLAYWRIGHT_WS_URL: Optional[str] = None
630
+ PLAYWRIGHT_TIMEOUT: Optional[int] = None
631
+ FIRECRAWL_API_KEY: Optional[str] = None
632
+ FIRECRAWL_API_BASE_URL: Optional[str] = None
633
+ FIRECRAWL_TIMEOUT: Optional[str] = None
634
+ TAVILY_EXTRACT_DEPTH: Optional[str] = None
635
+ EXTERNAL_WEB_SEARCH_URL: Optional[str] = None
636
+ EXTERNAL_WEB_SEARCH_API_KEY: Optional[str] = None
637
+ EXTERNAL_WEB_LOADER_URL: Optional[str] = None
638
+ EXTERNAL_WEB_LOADER_API_KEY: Optional[str] = None
639
+ YOUTUBE_LOADER_LANGUAGE: Optional[List[str]] = None
640
+ YOUTUBE_LOADER_PROXY_URL: Optional[str] = None
641
+ YOUTUBE_LOADER_TRANSLATION: Optional[str] = None
642
+ YANDEX_WEB_SEARCH_URL: Optional[str] = None
643
+ YANDEX_WEB_SEARCH_API_KEY: Optional[str] = None
644
+ YANDEX_WEB_SEARCH_CONFIG: Optional[str] = None
645
+ YOUCOM_API_KEY: Optional[str] = None
646
+
647
+
648
+ class ConfigForm(BaseModel):
649
+ # RAG settings
650
+ RAG_TEMPLATE: Optional[str] = None
651
+ TOP_K: Optional[int] = None
652
+ BYPASS_EMBEDDING_AND_RETRIEVAL: Optional[bool] = None
653
+ RAG_FULL_CONTEXT: Optional[bool] = None
654
+
655
+ # Hybrid search settings
656
+ ENABLE_RAG_HYBRID_SEARCH: Optional[bool] = None
657
+ ENABLE_RAG_HYBRID_SEARCH_ENRICHED_TEXTS: Optional[bool] = None
658
+ TOP_K_RERANKER: Optional[int] = None
659
+ RELEVANCE_THRESHOLD: Optional[float] = None
660
+ HYBRID_BM25_WEIGHT: Optional[float] = None
661
+
662
+ # Content extraction settings
663
+ CONTENT_EXTRACTION_ENGINE: Optional[str] = None
664
+ PDF_EXTRACT_IMAGES: Optional[bool] = None
665
+ PDF_LOADER_MODE: Optional[str] = None
666
+
667
+ DATALAB_MARKER_API_KEY: Optional[str] = None
668
+ DATALAB_MARKER_API_BASE_URL: Optional[str] = None
669
+ DATALAB_MARKER_ADDITIONAL_CONFIG: Optional[str] = None
670
+ DATALAB_MARKER_SKIP_CACHE: Optional[bool] = None
671
+ DATALAB_MARKER_FORCE_OCR: Optional[bool] = None
672
+ DATALAB_MARKER_PAGINATE: Optional[bool] = None
673
+ DATALAB_MARKER_STRIP_EXISTING_OCR: Optional[bool] = None
674
+ DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION: Optional[bool] = None
675
+ DATALAB_MARKER_FORMAT_LINES: Optional[bool] = None
676
+ DATALAB_MARKER_USE_LLM: Optional[bool] = None
677
+ DATALAB_MARKER_OUTPUT_FORMAT: Optional[str] = None
678
+
679
+ EXTERNAL_DOCUMENT_LOADER_URL: Optional[str] = None
680
+ EXTERNAL_DOCUMENT_LOADER_API_KEY: Optional[str] = None
681
+
682
+ TIKA_SERVER_URL: Optional[str] = None
683
+ DOCLING_SERVER_URL: Optional[str] = None
684
+ DOCLING_API_KEY: Optional[str] = None
685
+ DOCLING_PARAMS: Optional[dict] = None
686
+ DOCUMENT_INTELLIGENCE_ENDPOINT: Optional[str] = None
687
+ DOCUMENT_INTELLIGENCE_KEY: Optional[str] = None
688
+ DOCUMENT_INTELLIGENCE_MODEL: Optional[str] = None
689
+ MISTRAL_OCR_API_BASE_URL: Optional[str] = None
690
+ MISTRAL_OCR_API_KEY: Optional[str] = None
691
+ PADDLEOCR_VL_BASE_URL: Optional[str] = None
692
+ PADDLEOCR_VL_TOKEN: Optional[str] = None
693
+
694
+ # MinerU settings
695
+ MINERU_API_MODE: Optional[str] = None
696
+ MINERU_API_URL: Optional[str] = None
697
+ MINERU_API_KEY: Optional[str] = None
698
+ MINERU_API_TIMEOUT: Optional[str] = None
699
+ MINERU_PARAMS: Optional[dict] = None
700
+
701
+ # Reranking settings
702
+ RAG_RERANKING_MODEL: Optional[str] = None
703
+ RAG_RERANKING_ENGINE: Optional[str] = None
704
+ RAG_RERANKING_BATCH_SIZE: Optional[int] = None
705
+ RAG_EXTERNAL_RERANKER_URL: Optional[str] = None
706
+ RAG_EXTERNAL_RERANKER_API_KEY: Optional[str] = None
707
+ RAG_EXTERNAL_RERANKER_TIMEOUT: Optional[str] = None
708
+
709
+ # Chunking settings
710
+ TEXT_SPLITTER: Optional[str] = None
711
+ ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER: Optional[bool] = None
712
+ CHUNK_SIZE: Optional[int] = None
713
+ CHUNK_MIN_SIZE_TARGET: Optional[int] = None
714
+ CHUNK_OVERLAP: Optional[int] = None
715
+
716
+ # File upload settings
717
+ FILE_MAX_SIZE: Optional[Union[int, str]] = None
718
+ FILE_MAX_COUNT: Optional[Union[int, str]] = None
719
+ FILE_IMAGE_COMPRESSION_WIDTH: Optional[Union[int, str]] = None
720
+ FILE_IMAGE_COMPRESSION_HEIGHT: Optional[Union[int, str]] = None
721
+ ALLOWED_FILE_EXTENSIONS: Optional[List[str]] = None
722
+
723
+ # Integration settings
724
+ ENABLE_GOOGLE_DRIVE_INTEGRATION: Optional[bool] = None
725
+ ENABLE_ONEDRIVE_INTEGRATION: Optional[bool] = None
726
+
727
+ # Web search settings
728
+ web: Optional[WebConfig] = None
729
+
730
+
731
+ @router.post('/config/update')
732
+ async def update_rag_config(request: Request, form_data: ConfigForm, user=Depends(get_admin_user)):
733
+ # RAG settings
734
+ request.app.state.config.RAG_TEMPLATE = (
735
+ form_data.RAG_TEMPLATE if form_data.RAG_TEMPLATE is not None else request.app.state.config.RAG_TEMPLATE
736
+ )
737
+ request.app.state.config.TOP_K = form_data.TOP_K if form_data.TOP_K is not None else request.app.state.config.TOP_K
738
+ request.app.state.config.BYPASS_EMBEDDING_AND_RETRIEVAL = (
739
+ form_data.BYPASS_EMBEDDING_AND_RETRIEVAL
740
+ if form_data.BYPASS_EMBEDDING_AND_RETRIEVAL is not None
741
+ else request.app.state.config.BYPASS_EMBEDDING_AND_RETRIEVAL
742
+ )
743
+ request.app.state.config.RAG_FULL_CONTEXT = (
744
+ form_data.RAG_FULL_CONTEXT
745
+ if form_data.RAG_FULL_CONTEXT is not None
746
+ else request.app.state.config.RAG_FULL_CONTEXT
747
+ )
748
+
749
+ # Hybrid search settings
750
+ request.app.state.config.ENABLE_RAG_HYBRID_SEARCH = (
751
+ form_data.ENABLE_RAG_HYBRID_SEARCH
752
+ if form_data.ENABLE_RAG_HYBRID_SEARCH is not None
753
+ else request.app.state.config.ENABLE_RAG_HYBRID_SEARCH
754
+ )
755
+ request.app.state.config.ENABLE_RAG_HYBRID_SEARCH_ENRICHED_TEXTS = (
756
+ form_data.ENABLE_RAG_HYBRID_SEARCH_ENRICHED_TEXTS
757
+ if form_data.ENABLE_RAG_HYBRID_SEARCH_ENRICHED_TEXTS is not None
758
+ else request.app.state.config.ENABLE_RAG_HYBRID_SEARCH_ENRICHED_TEXTS
759
+ )
760
+
761
+ request.app.state.config.TOP_K_RERANKER = (
762
+ form_data.TOP_K_RERANKER if form_data.TOP_K_RERANKER is not None else request.app.state.config.TOP_K_RERANKER
763
+ )
764
+ request.app.state.config.RELEVANCE_THRESHOLD = (
765
+ form_data.RELEVANCE_THRESHOLD
766
+ if form_data.RELEVANCE_THRESHOLD is not None
767
+ else request.app.state.config.RELEVANCE_THRESHOLD
768
+ )
769
+ request.app.state.config.HYBRID_BM25_WEIGHT = (
770
+ form_data.HYBRID_BM25_WEIGHT
771
+ if form_data.HYBRID_BM25_WEIGHT is not None
772
+ else request.app.state.config.HYBRID_BM25_WEIGHT
773
+ )
774
+
775
+ # Content extraction settings
776
+ request.app.state.config.CONTENT_EXTRACTION_ENGINE = (
777
+ form_data.CONTENT_EXTRACTION_ENGINE
778
+ if form_data.CONTENT_EXTRACTION_ENGINE is not None
779
+ else request.app.state.config.CONTENT_EXTRACTION_ENGINE
780
+ )
781
+ request.app.state.config.PDF_EXTRACT_IMAGES = (
782
+ form_data.PDF_EXTRACT_IMAGES
783
+ if form_data.PDF_EXTRACT_IMAGES is not None
784
+ else request.app.state.config.PDF_EXTRACT_IMAGES
785
+ )
786
+ request.app.state.config.PDF_LOADER_MODE = (
787
+ form_data.PDF_LOADER_MODE if form_data.PDF_LOADER_MODE is not None else request.app.state.config.PDF_LOADER_MODE
788
+ )
789
+ request.app.state.config.DATALAB_MARKER_API_KEY = (
790
+ form_data.DATALAB_MARKER_API_KEY
791
+ if form_data.DATALAB_MARKER_API_KEY is not None
792
+ else request.app.state.config.DATALAB_MARKER_API_KEY
793
+ )
794
+ request.app.state.config.DATALAB_MARKER_API_BASE_URL = (
795
+ form_data.DATALAB_MARKER_API_BASE_URL
796
+ if form_data.DATALAB_MARKER_API_BASE_URL is not None
797
+ else request.app.state.config.DATALAB_MARKER_API_BASE_URL
798
+ )
799
+ request.app.state.config.DATALAB_MARKER_ADDITIONAL_CONFIG = (
800
+ form_data.DATALAB_MARKER_ADDITIONAL_CONFIG
801
+ if form_data.DATALAB_MARKER_ADDITIONAL_CONFIG is not None
802
+ else request.app.state.config.DATALAB_MARKER_ADDITIONAL_CONFIG
803
+ )
804
+ request.app.state.config.DATALAB_MARKER_SKIP_CACHE = (
805
+ form_data.DATALAB_MARKER_SKIP_CACHE
806
+ if form_data.DATALAB_MARKER_SKIP_CACHE is not None
807
+ else request.app.state.config.DATALAB_MARKER_SKIP_CACHE
808
+ )
809
+ request.app.state.config.DATALAB_MARKER_FORCE_OCR = (
810
+ form_data.DATALAB_MARKER_FORCE_OCR
811
+ if form_data.DATALAB_MARKER_FORCE_OCR is not None
812
+ else request.app.state.config.DATALAB_MARKER_FORCE_OCR
813
+ )
814
+ request.app.state.config.DATALAB_MARKER_PAGINATE = (
815
+ form_data.DATALAB_MARKER_PAGINATE
816
+ if form_data.DATALAB_MARKER_PAGINATE is not None
817
+ else request.app.state.config.DATALAB_MARKER_PAGINATE
818
+ )
819
+ request.app.state.config.DATALAB_MARKER_STRIP_EXISTING_OCR = (
820
+ form_data.DATALAB_MARKER_STRIP_EXISTING_OCR
821
+ if form_data.DATALAB_MARKER_STRIP_EXISTING_OCR is not None
822
+ else request.app.state.config.DATALAB_MARKER_STRIP_EXISTING_OCR
823
+ )
824
+ request.app.state.config.DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION = (
825
+ form_data.DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION
826
+ if form_data.DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION is not None
827
+ else request.app.state.config.DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION
828
+ )
829
+ request.app.state.config.DATALAB_MARKER_FORMAT_LINES = (
830
+ form_data.DATALAB_MARKER_FORMAT_LINES
831
+ if form_data.DATALAB_MARKER_FORMAT_LINES is not None
832
+ else request.app.state.config.DATALAB_MARKER_FORMAT_LINES
833
+ )
834
+ request.app.state.config.DATALAB_MARKER_OUTPUT_FORMAT = (
835
+ form_data.DATALAB_MARKER_OUTPUT_FORMAT
836
+ if form_data.DATALAB_MARKER_OUTPUT_FORMAT is not None
837
+ else request.app.state.config.DATALAB_MARKER_OUTPUT_FORMAT
838
+ )
839
+ request.app.state.config.DATALAB_MARKER_USE_LLM = (
840
+ form_data.DATALAB_MARKER_USE_LLM
841
+ if form_data.DATALAB_MARKER_USE_LLM is not None
842
+ else request.app.state.config.DATALAB_MARKER_USE_LLM
843
+ )
844
+ request.app.state.config.EXTERNAL_DOCUMENT_LOADER_URL = (
845
+ form_data.EXTERNAL_DOCUMENT_LOADER_URL
846
+ if form_data.EXTERNAL_DOCUMENT_LOADER_URL is not None
847
+ else request.app.state.config.EXTERNAL_DOCUMENT_LOADER_URL
848
+ )
849
+ request.app.state.config.EXTERNAL_DOCUMENT_LOADER_API_KEY = (
850
+ form_data.EXTERNAL_DOCUMENT_LOADER_API_KEY
851
+ if form_data.EXTERNAL_DOCUMENT_LOADER_API_KEY is not None
852
+ else request.app.state.config.EXTERNAL_DOCUMENT_LOADER_API_KEY
853
+ )
854
+ request.app.state.config.TIKA_SERVER_URL = (
855
+ form_data.TIKA_SERVER_URL if form_data.TIKA_SERVER_URL is not None else request.app.state.config.TIKA_SERVER_URL
856
+ )
857
+ request.app.state.config.DOCLING_SERVER_URL = (
858
+ form_data.DOCLING_SERVER_URL
859
+ if form_data.DOCLING_SERVER_URL is not None
860
+ else request.app.state.config.DOCLING_SERVER_URL
861
+ )
862
+ request.app.state.config.DOCLING_API_KEY = (
863
+ form_data.DOCLING_API_KEY if form_data.DOCLING_API_KEY is not None else request.app.state.config.DOCLING_API_KEY
864
+ )
865
+ request.app.state.config.DOCLING_PARAMS = (
866
+ form_data.DOCLING_PARAMS if form_data.DOCLING_PARAMS is not None else request.app.state.config.DOCLING_PARAMS
867
+ )
868
+ request.app.state.config.DOCUMENT_INTELLIGENCE_ENDPOINT = (
869
+ form_data.DOCUMENT_INTELLIGENCE_ENDPOINT
870
+ if form_data.DOCUMENT_INTELLIGENCE_ENDPOINT is not None
871
+ else request.app.state.config.DOCUMENT_INTELLIGENCE_ENDPOINT
872
+ )
873
+ request.app.state.config.DOCUMENT_INTELLIGENCE_KEY = (
874
+ form_data.DOCUMENT_INTELLIGENCE_KEY
875
+ if form_data.DOCUMENT_INTELLIGENCE_KEY is not None
876
+ else request.app.state.config.DOCUMENT_INTELLIGENCE_KEY
877
+ )
878
+ request.app.state.config.DOCUMENT_INTELLIGENCE_MODEL = (
879
+ form_data.DOCUMENT_INTELLIGENCE_MODEL
880
+ if form_data.DOCUMENT_INTELLIGENCE_MODEL is not None
881
+ else request.app.state.config.DOCUMENT_INTELLIGENCE_MODEL
882
+ )
883
+
884
+ request.app.state.config.MISTRAL_OCR_API_BASE_URL = (
885
+ form_data.MISTRAL_OCR_API_BASE_URL
886
+ if form_data.MISTRAL_OCR_API_BASE_URL is not None
887
+ else request.app.state.config.MISTRAL_OCR_API_BASE_URL
888
+ )
889
+ request.app.state.config.MISTRAL_OCR_API_KEY = (
890
+ form_data.MISTRAL_OCR_API_KEY
891
+ if form_data.MISTRAL_OCR_API_KEY is not None
892
+ else request.app.state.config.MISTRAL_OCR_API_KEY
893
+ )
894
+ request.app.state.config.PADDLEOCR_VL_BASE_URL = (
895
+ form_data.PADDLEOCR_VL_BASE_URL
896
+ if form_data.PADDLEOCR_VL_BASE_URL is not None
897
+ else request.app.state.config.PADDLEOCR_VL_BASE_URL
898
+ )
899
+ request.app.state.config.PADDLEOCR_VL_TOKEN = (
900
+ form_data.PADDLEOCR_VL_TOKEN
901
+ if form_data.PADDLEOCR_VL_TOKEN is not None
902
+ else request.app.state.config.PADDLEOCR_VL_TOKEN
903
+ )
904
+
905
+ # MinerU settings
906
+ request.app.state.config.MINERU_API_MODE = (
907
+ form_data.MINERU_API_MODE if form_data.MINERU_API_MODE is not None else request.app.state.config.MINERU_API_MODE
908
+ )
909
+ request.app.state.config.MINERU_API_URL = (
910
+ form_data.MINERU_API_URL if form_data.MINERU_API_URL is not None else request.app.state.config.MINERU_API_URL
911
+ )
912
+ request.app.state.config.MINERU_API_KEY = (
913
+ form_data.MINERU_API_KEY if form_data.MINERU_API_KEY is not None else request.app.state.config.MINERU_API_KEY
914
+ )
915
+ request.app.state.config.MINERU_API_TIMEOUT = (
916
+ form_data.MINERU_API_TIMEOUT
917
+ if form_data.MINERU_API_TIMEOUT is not None
918
+ else request.app.state.config.MINERU_API_TIMEOUT
919
+ )
920
+ request.app.state.config.MINERU_PARAMS = (
921
+ form_data.MINERU_PARAMS if form_data.MINERU_PARAMS is not None else request.app.state.config.MINERU_PARAMS
922
+ )
923
+
924
+ # Reranking settings
925
+ if request.app.state.config.RAG_RERANKING_ENGINE == '':
926
+ # Unloading the internal reranker and clear VRAM memory
927
+ request.app.state.rf = None
928
+ request.app.state.RERANKING_FUNCTION = None
929
+ import gc
930
+
931
+ gc.collect()
932
+ if DEVICE_TYPE == 'cuda':
933
+ import torch
934
+
935
+ if torch.cuda.is_available():
936
+ torch.cuda.empty_cache()
937
+ request.app.state.config.RAG_RERANKING_ENGINE = (
938
+ form_data.RAG_RERANKING_ENGINE
939
+ if form_data.RAG_RERANKING_ENGINE is not None
940
+ else request.app.state.config.RAG_RERANKING_ENGINE
941
+ )
942
+
943
+ request.app.state.config.RAG_EXTERNAL_RERANKER_URL = (
944
+ form_data.RAG_EXTERNAL_RERANKER_URL
945
+ if form_data.RAG_EXTERNAL_RERANKER_URL is not None
946
+ else request.app.state.config.RAG_EXTERNAL_RERANKER_URL
947
+ )
948
+
949
+ request.app.state.config.RAG_EXTERNAL_RERANKER_API_KEY = (
950
+ form_data.RAG_EXTERNAL_RERANKER_API_KEY
951
+ if form_data.RAG_EXTERNAL_RERANKER_API_KEY is not None
952
+ else request.app.state.config.RAG_EXTERNAL_RERANKER_API_KEY
953
+ )
954
+
955
+ request.app.state.config.RAG_EXTERNAL_RERANKER_TIMEOUT = (
956
+ form_data.RAG_EXTERNAL_RERANKER_TIMEOUT
957
+ if form_data.RAG_EXTERNAL_RERANKER_TIMEOUT is not None
958
+ else request.app.state.config.RAG_EXTERNAL_RERANKER_TIMEOUT
959
+ )
960
+
961
+ request.app.state.config.RAG_RERANKING_BATCH_SIZE = (
962
+ form_data.RAG_RERANKING_BATCH_SIZE
963
+ if form_data.RAG_RERANKING_BATCH_SIZE is not None
964
+ else request.app.state.config.RAG_RERANKING_BATCH_SIZE
965
+ )
966
+
967
+ log.info(
968
+ f'Updating reranking model: {request.app.state.config.RAG_RERANKING_MODEL} to {form_data.RAG_RERANKING_MODEL}'
969
+ )
970
+ try:
971
+ request.app.state.config.RAG_RERANKING_MODEL = (
972
+ form_data.RAG_RERANKING_MODEL
973
+ if form_data.RAG_RERANKING_MODEL is not None
974
+ else request.app.state.config.RAG_RERANKING_MODEL
975
+ )
976
+
977
+ try:
978
+ if (
979
+ request.app.state.config.ENABLE_RAG_HYBRID_SEARCH
980
+ and not request.app.state.config.BYPASS_EMBEDDING_AND_RETRIEVAL
981
+ ):
982
+ request.app.state.rf = get_rf(
983
+ request.app.state.config.RAG_RERANKING_ENGINE,
984
+ request.app.state.config.RAG_RERANKING_MODEL,
985
+ request.app.state.config.RAG_EXTERNAL_RERANKER_URL,
986
+ request.app.state.config.RAG_EXTERNAL_RERANKER_API_KEY,
987
+ request.app.state.config.RAG_EXTERNAL_RERANKER_TIMEOUT,
988
+ )
989
+
990
+ request.app.state.RERANKING_FUNCTION = get_reranking_function(
991
+ request.app.state.config.RAG_RERANKING_ENGINE,
992
+ request.app.state.config.RAG_RERANKING_MODEL,
993
+ request.app.state.rf,
994
+ reranking_batch_size=request.app.state.config.RAG_RERANKING_BATCH_SIZE,
995
+ )
996
+ except Exception as e:
997
+ log.error(f'Error loading reranking model: {e}')
998
+ request.app.state.config.ENABLE_RAG_HYBRID_SEARCH = False
999
+ except Exception as e:
1000
+ log.exception(f'Problem updating reranking model: {e}')
1001
+ raise HTTPException(
1002
+ status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
1003
+ detail=ERROR_MESSAGES.DEFAULT(e),
1004
+ )
1005
+
1006
+ # Chunking settings
1007
+ request.app.state.config.TEXT_SPLITTER = (
1008
+ form_data.TEXT_SPLITTER if form_data.TEXT_SPLITTER is not None else request.app.state.config.TEXT_SPLITTER
1009
+ )
1010
+ request.app.state.config.ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER = (
1011
+ form_data.ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER
1012
+ if form_data.ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER is not None
1013
+ else request.app.state.config.ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER
1014
+ )
1015
+ request.app.state.config.CHUNK_SIZE = (
1016
+ form_data.CHUNK_SIZE if form_data.CHUNK_SIZE is not None else request.app.state.config.CHUNK_SIZE
1017
+ )
1018
+ request.app.state.config.CHUNK_MIN_SIZE_TARGET = (
1019
+ form_data.CHUNK_MIN_SIZE_TARGET
1020
+ if form_data.CHUNK_MIN_SIZE_TARGET is not None
1021
+ else request.app.state.config.CHUNK_MIN_SIZE_TARGET
1022
+ )
1023
+ request.app.state.config.CHUNK_OVERLAP = (
1024
+ form_data.CHUNK_OVERLAP if form_data.CHUNK_OVERLAP is not None else request.app.state.config.CHUNK_OVERLAP
1025
+ )
1026
+
1027
+ # File upload settings
1028
+ # Empty string means "clear to None" (unlimited/no compression),
1029
+ # None means "don't change", int means "set to this value"
1030
+ if form_data.FILE_MAX_SIZE is not None:
1031
+ request.app.state.config.FILE_MAX_SIZE = None if form_data.FILE_MAX_SIZE == '' else form_data.FILE_MAX_SIZE
1032
+ if form_data.FILE_MAX_COUNT is not None:
1033
+ request.app.state.config.FILE_MAX_COUNT = None if form_data.FILE_MAX_COUNT == '' else form_data.FILE_MAX_COUNT
1034
+ if form_data.FILE_IMAGE_COMPRESSION_WIDTH is not None:
1035
+ request.app.state.config.FILE_IMAGE_COMPRESSION_WIDTH = (
1036
+ None if form_data.FILE_IMAGE_COMPRESSION_WIDTH == '' else form_data.FILE_IMAGE_COMPRESSION_WIDTH
1037
+ )
1038
+ if form_data.FILE_IMAGE_COMPRESSION_HEIGHT is not None:
1039
+ request.app.state.config.FILE_IMAGE_COMPRESSION_HEIGHT = (
1040
+ None if form_data.FILE_IMAGE_COMPRESSION_HEIGHT == '' else form_data.FILE_IMAGE_COMPRESSION_HEIGHT
1041
+ )
1042
+
1043
+ request.app.state.config.ALLOWED_FILE_EXTENSIONS = (
1044
+ form_data.ALLOWED_FILE_EXTENSIONS
1045
+ if form_data.ALLOWED_FILE_EXTENSIONS is not None
1046
+ else request.app.state.config.ALLOWED_FILE_EXTENSIONS
1047
+ )
1048
+
1049
+ # Integration settings
1050
+ request.app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION = (
1051
+ form_data.ENABLE_GOOGLE_DRIVE_INTEGRATION
1052
+ if form_data.ENABLE_GOOGLE_DRIVE_INTEGRATION is not None
1053
+ else request.app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION
1054
+ )
1055
+ request.app.state.config.ENABLE_ONEDRIVE_INTEGRATION = (
1056
+ form_data.ENABLE_ONEDRIVE_INTEGRATION
1057
+ if form_data.ENABLE_ONEDRIVE_INTEGRATION is not None
1058
+ else request.app.state.config.ENABLE_ONEDRIVE_INTEGRATION
1059
+ )
1060
+
1061
+ if form_data.web is not None:
1062
+ # Web search settings
1063
+ request.app.state.config.ENABLE_WEB_SEARCH = form_data.web.ENABLE_WEB_SEARCH
1064
+ request.app.state.config.WEB_SEARCH_ENGINE = form_data.web.WEB_SEARCH_ENGINE
1065
+ request.app.state.config.WEB_SEARCH_TRUST_ENV = form_data.web.WEB_SEARCH_TRUST_ENV
1066
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT = form_data.web.WEB_SEARCH_RESULT_COUNT
1067
+ request.app.state.config.WEB_SEARCH_CONCURRENT_REQUESTS = form_data.web.WEB_SEARCH_CONCURRENT_REQUESTS
1068
+ request.app.state.config.WEB_FETCH_MAX_CONTENT_LENGTH = form_data.web.WEB_FETCH_MAX_CONTENT_LENGTH
1069
+ request.app.state.config.WEB_LOADER_CONCURRENT_REQUESTS = form_data.web.WEB_LOADER_CONCURRENT_REQUESTS
1070
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST = form_data.web.WEB_SEARCH_DOMAIN_FILTER_LIST
1071
+ request.app.state.config.BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL = (
1072
+ form_data.web.BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL
1073
+ )
1074
+ request.app.state.config.BYPASS_WEB_SEARCH_WEB_LOADER = form_data.web.BYPASS_WEB_SEARCH_WEB_LOADER
1075
+ request.app.state.config.OLLAMA_CLOUD_WEB_SEARCH_API_KEY = form_data.web.OLLAMA_CLOUD_WEB_SEARCH_API_KEY
1076
+ request.app.state.config.SEARXNG_QUERY_URL = form_data.web.SEARXNG_QUERY_URL
1077
+ request.app.state.config.SEARXNG_LANGUAGE = form_data.web.SEARXNG_LANGUAGE
1078
+ request.app.state.config.YACY_QUERY_URL = form_data.web.YACY_QUERY_URL
1079
+ request.app.state.config.YACY_USERNAME = form_data.web.YACY_USERNAME
1080
+ request.app.state.config.YACY_PASSWORD = form_data.web.YACY_PASSWORD
1081
+ request.app.state.config.GOOGLE_PSE_API_KEY = form_data.web.GOOGLE_PSE_API_KEY
1082
+ request.app.state.config.GOOGLE_PSE_ENGINE_ID = form_data.web.GOOGLE_PSE_ENGINE_ID
1083
+ request.app.state.config.BRAVE_SEARCH_API_KEY = form_data.web.BRAVE_SEARCH_API_KEY
1084
+ request.app.state.config.KAGI_SEARCH_API_KEY = form_data.web.KAGI_SEARCH_API_KEY
1085
+ request.app.state.config.MOJEEK_SEARCH_API_KEY = form_data.web.MOJEEK_SEARCH_API_KEY
1086
+ request.app.state.config.BOCHA_SEARCH_API_KEY = form_data.web.BOCHA_SEARCH_API_KEY
1087
+ request.app.state.config.SERPSTACK_API_KEY = form_data.web.SERPSTACK_API_KEY
1088
+ request.app.state.config.SERPSTACK_HTTPS = form_data.web.SERPSTACK_HTTPS
1089
+ request.app.state.config.SERPER_API_KEY = form_data.web.SERPER_API_KEY
1090
+ request.app.state.config.SERPLY_API_KEY = form_data.web.SERPLY_API_KEY
1091
+ request.app.state.config.DDGS_BACKEND = form_data.web.DDGS_BACKEND
1092
+ request.app.state.config.TAVILY_API_KEY = form_data.web.TAVILY_API_KEY
1093
+ request.app.state.config.SEARCHAPI_API_KEY = form_data.web.SEARCHAPI_API_KEY
1094
+ request.app.state.config.SEARCHAPI_ENGINE = form_data.web.SEARCHAPI_ENGINE
1095
+ request.app.state.config.SERPAPI_API_KEY = form_data.web.SERPAPI_API_KEY
1096
+ request.app.state.config.SERPAPI_ENGINE = form_data.web.SERPAPI_ENGINE
1097
+ request.app.state.config.JINA_API_KEY = form_data.web.JINA_API_KEY
1098
+ request.app.state.config.JINA_API_BASE_URL = form_data.web.JINA_API_BASE_URL
1099
+ request.app.state.config.BING_SEARCH_V7_ENDPOINT = form_data.web.BING_SEARCH_V7_ENDPOINT
1100
+ request.app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = form_data.web.BING_SEARCH_V7_SUBSCRIPTION_KEY
1101
+ request.app.state.config.EXA_API_KEY = form_data.web.EXA_API_KEY
1102
+ request.app.state.config.PERPLEXITY_API_KEY = form_data.web.PERPLEXITY_API_KEY
1103
+ request.app.state.config.PERPLEXITY_MODEL = form_data.web.PERPLEXITY_MODEL
1104
+ request.app.state.config.PERPLEXITY_SEARCH_CONTEXT_USAGE = form_data.web.PERPLEXITY_SEARCH_CONTEXT_USAGE
1105
+ request.app.state.config.PERPLEXITY_SEARCH_API_URL = form_data.web.PERPLEXITY_SEARCH_API_URL
1106
+ request.app.state.config.SOUGOU_API_SID = form_data.web.SOUGOU_API_SID
1107
+ request.app.state.config.SOUGOU_API_SK = form_data.web.SOUGOU_API_SK
1108
+
1109
+ # Web loader settings
1110
+ request.app.state.config.WEB_LOADER_ENGINE = form_data.web.WEB_LOADER_ENGINE
1111
+ request.app.state.config.WEB_LOADER_TIMEOUT = form_data.web.WEB_LOADER_TIMEOUT
1112
+
1113
+ request.app.state.config.ENABLE_WEB_LOADER_SSL_VERIFICATION = form_data.web.ENABLE_WEB_LOADER_SSL_VERIFICATION
1114
+ request.app.state.config.PLAYWRIGHT_WS_URL = form_data.web.PLAYWRIGHT_WS_URL
1115
+ request.app.state.config.PLAYWRIGHT_TIMEOUT = form_data.web.PLAYWRIGHT_TIMEOUT
1116
+ request.app.state.config.FIRECRAWL_API_KEY = form_data.web.FIRECRAWL_API_KEY
1117
+ request.app.state.config.FIRECRAWL_API_BASE_URL = form_data.web.FIRECRAWL_API_BASE_URL
1118
+ request.app.state.config.FIRECRAWL_TIMEOUT = form_data.web.FIRECRAWL_TIMEOUT
1119
+ request.app.state.config.EXTERNAL_WEB_SEARCH_URL = form_data.web.EXTERNAL_WEB_SEARCH_URL
1120
+ request.app.state.config.EXTERNAL_WEB_SEARCH_API_KEY = form_data.web.EXTERNAL_WEB_SEARCH_API_KEY
1121
+ request.app.state.config.EXTERNAL_WEB_LOADER_URL = form_data.web.EXTERNAL_WEB_LOADER_URL
1122
+ request.app.state.config.EXTERNAL_WEB_LOADER_API_KEY = form_data.web.EXTERNAL_WEB_LOADER_API_KEY
1123
+ request.app.state.config.TAVILY_EXTRACT_DEPTH = form_data.web.TAVILY_EXTRACT_DEPTH
1124
+ request.app.state.config.YOUTUBE_LOADER_LANGUAGE = form_data.web.YOUTUBE_LOADER_LANGUAGE
1125
+ request.app.state.config.YOUTUBE_LOADER_PROXY_URL = form_data.web.YOUTUBE_LOADER_PROXY_URL
1126
+ request.app.state.YOUTUBE_LOADER_TRANSLATION = form_data.web.YOUTUBE_LOADER_TRANSLATION
1127
+ request.app.state.config.YANDEX_WEB_SEARCH_URL = form_data.web.YANDEX_WEB_SEARCH_URL
1128
+ request.app.state.config.YANDEX_WEB_SEARCH_API_KEY = form_data.web.YANDEX_WEB_SEARCH_API_KEY
1129
+ request.app.state.config.YANDEX_WEB_SEARCH_CONFIG = form_data.web.YANDEX_WEB_SEARCH_CONFIG
1130
+ request.app.state.config.YOUCOM_API_KEY = form_data.web.YOUCOM_API_KEY
1131
+
1132
+ return {
1133
+ 'status': True,
1134
+ # RAG settings
1135
+ 'RAG_TEMPLATE': request.app.state.config.RAG_TEMPLATE,
1136
+ 'TOP_K': request.app.state.config.TOP_K,
1137
+ 'BYPASS_EMBEDDING_AND_RETRIEVAL': request.app.state.config.BYPASS_EMBEDDING_AND_RETRIEVAL,
1138
+ 'RAG_FULL_CONTEXT': request.app.state.config.RAG_FULL_CONTEXT,
1139
+ # Hybrid search settings
1140
+ 'ENABLE_RAG_HYBRID_SEARCH': request.app.state.config.ENABLE_RAG_HYBRID_SEARCH,
1141
+ 'TOP_K_RERANKER': request.app.state.config.TOP_K_RERANKER,
1142
+ 'RELEVANCE_THRESHOLD': request.app.state.config.RELEVANCE_THRESHOLD,
1143
+ 'HYBRID_BM25_WEIGHT': request.app.state.config.HYBRID_BM25_WEIGHT,
1144
+ # Content extraction settings
1145
+ 'CONTENT_EXTRACTION_ENGINE': request.app.state.config.CONTENT_EXTRACTION_ENGINE,
1146
+ 'PDF_EXTRACT_IMAGES': request.app.state.config.PDF_EXTRACT_IMAGES,
1147
+ 'PDF_LOADER_MODE': request.app.state.config.PDF_LOADER_MODE,
1148
+ 'DATALAB_MARKER_API_KEY': request.app.state.config.DATALAB_MARKER_API_KEY,
1149
+ 'DATALAB_MARKER_API_BASE_URL': request.app.state.config.DATALAB_MARKER_API_BASE_URL,
1150
+ 'DATALAB_MARKER_ADDITIONAL_CONFIG': request.app.state.config.DATALAB_MARKER_ADDITIONAL_CONFIG,
1151
+ 'DATALAB_MARKER_SKIP_CACHE': request.app.state.config.DATALAB_MARKER_SKIP_CACHE,
1152
+ 'DATALAB_MARKER_FORCE_OCR': request.app.state.config.DATALAB_MARKER_FORCE_OCR,
1153
+ 'DATALAB_MARKER_PAGINATE': request.app.state.config.DATALAB_MARKER_PAGINATE,
1154
+ 'DATALAB_MARKER_STRIP_EXISTING_OCR': request.app.state.config.DATALAB_MARKER_STRIP_EXISTING_OCR,
1155
+ 'DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION': request.app.state.config.DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION,
1156
+ 'DATALAB_MARKER_USE_LLM': request.app.state.config.DATALAB_MARKER_USE_LLM,
1157
+ 'DATALAB_MARKER_OUTPUT_FORMAT': request.app.state.config.DATALAB_MARKER_OUTPUT_FORMAT,
1158
+ 'EXTERNAL_DOCUMENT_LOADER_URL': request.app.state.config.EXTERNAL_DOCUMENT_LOADER_URL,
1159
+ 'EXTERNAL_DOCUMENT_LOADER_API_KEY': request.app.state.config.EXTERNAL_DOCUMENT_LOADER_API_KEY,
1160
+ 'TIKA_SERVER_URL': request.app.state.config.TIKA_SERVER_URL,
1161
+ 'DOCLING_SERVER_URL': request.app.state.config.DOCLING_SERVER_URL,
1162
+ 'DOCLING_API_KEY': request.app.state.config.DOCLING_API_KEY,
1163
+ 'DOCLING_PARAMS': request.app.state.config.DOCLING_PARAMS,
1164
+ 'DOCUMENT_INTELLIGENCE_ENDPOINT': request.app.state.config.DOCUMENT_INTELLIGENCE_ENDPOINT,
1165
+ 'DOCUMENT_INTELLIGENCE_KEY': request.app.state.config.DOCUMENT_INTELLIGENCE_KEY,
1166
+ 'DOCUMENT_INTELLIGENCE_MODEL': request.app.state.config.DOCUMENT_INTELLIGENCE_MODEL,
1167
+ 'MISTRAL_OCR_API_BASE_URL': request.app.state.config.MISTRAL_OCR_API_BASE_URL,
1168
+ 'MISTRAL_OCR_API_KEY': request.app.state.config.MISTRAL_OCR_API_KEY,
1169
+ 'PADDLEOCR_VL_BASE_URL': request.app.state.config.PADDLEOCR_VL_BASE_URL,
1170
+ 'PADDLEOCR_VL_TOKEN': request.app.state.config.PADDLEOCR_VL_TOKEN,
1171
+ # MinerU settings
1172
+ 'MINERU_API_MODE': request.app.state.config.MINERU_API_MODE,
1173
+ 'MINERU_API_URL': request.app.state.config.MINERU_API_URL,
1174
+ 'MINERU_API_KEY': request.app.state.config.MINERU_API_KEY,
1175
+ 'MINERU_API_TIMEOUT': request.app.state.config.MINERU_API_TIMEOUT,
1176
+ 'MINERU_PARAMS': request.app.state.config.MINERU_PARAMS,
1177
+ # Reranking settings
1178
+ 'RAG_RERANKING_MODEL': request.app.state.config.RAG_RERANKING_MODEL,
1179
+ 'RAG_RERANKING_ENGINE': request.app.state.config.RAG_RERANKING_ENGINE,
1180
+ 'RAG_EXTERNAL_RERANKER_URL': request.app.state.config.RAG_EXTERNAL_RERANKER_URL,
1181
+ 'RAG_EXTERNAL_RERANKER_API_KEY': request.app.state.config.RAG_EXTERNAL_RERANKER_API_KEY,
1182
+ 'RAG_EXTERNAL_RERANKER_TIMEOUT': request.app.state.config.RAG_EXTERNAL_RERANKER_TIMEOUT,
1183
+ # Chunking settings
1184
+ 'TEXT_SPLITTER': request.app.state.config.TEXT_SPLITTER,
1185
+ 'CHUNK_SIZE': request.app.state.config.CHUNK_SIZE,
1186
+ 'CHUNK_MIN_SIZE_TARGET': request.app.state.config.CHUNK_MIN_SIZE_TARGET,
1187
+ 'ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER': request.app.state.config.ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER,
1188
+ 'CHUNK_OVERLAP': request.app.state.config.CHUNK_OVERLAP,
1189
+ # File upload settings
1190
+ 'FILE_MAX_SIZE': request.app.state.config.FILE_MAX_SIZE,
1191
+ 'FILE_MAX_COUNT': request.app.state.config.FILE_MAX_COUNT,
1192
+ 'FILE_IMAGE_COMPRESSION_WIDTH': request.app.state.config.FILE_IMAGE_COMPRESSION_WIDTH,
1193
+ 'FILE_IMAGE_COMPRESSION_HEIGHT': request.app.state.config.FILE_IMAGE_COMPRESSION_HEIGHT,
1194
+ 'ALLOWED_FILE_EXTENSIONS': request.app.state.config.ALLOWED_FILE_EXTENSIONS,
1195
+ # Integration settings
1196
+ 'ENABLE_GOOGLE_DRIVE_INTEGRATION': request.app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION,
1197
+ 'ENABLE_ONEDRIVE_INTEGRATION': request.app.state.config.ENABLE_ONEDRIVE_INTEGRATION,
1198
+ # Web search settings
1199
+ 'web': {
1200
+ 'ENABLE_WEB_SEARCH': request.app.state.config.ENABLE_WEB_SEARCH,
1201
+ 'WEB_SEARCH_ENGINE': request.app.state.config.WEB_SEARCH_ENGINE,
1202
+ 'WEB_SEARCH_TRUST_ENV': request.app.state.config.WEB_SEARCH_TRUST_ENV,
1203
+ 'WEB_SEARCH_RESULT_COUNT': request.app.state.config.WEB_SEARCH_RESULT_COUNT,
1204
+ 'WEB_SEARCH_CONCURRENT_REQUESTS': request.app.state.config.WEB_SEARCH_CONCURRENT_REQUESTS,
1205
+ 'WEB_FETCH_MAX_CONTENT_LENGTH': request.app.state.config.WEB_FETCH_MAX_CONTENT_LENGTH,
1206
+ 'WEB_LOADER_CONCURRENT_REQUESTS': request.app.state.config.WEB_LOADER_CONCURRENT_REQUESTS,
1207
+ 'WEB_SEARCH_DOMAIN_FILTER_LIST': request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
1208
+ 'BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL': request.app.state.config.BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL,
1209
+ 'BYPASS_WEB_SEARCH_WEB_LOADER': request.app.state.config.BYPASS_WEB_SEARCH_WEB_LOADER,
1210
+ 'OLLAMA_CLOUD_WEB_SEARCH_API_KEY': request.app.state.config.OLLAMA_CLOUD_WEB_SEARCH_API_KEY,
1211
+ 'SEARXNG_QUERY_URL': request.app.state.config.SEARXNG_QUERY_URL,
1212
+ 'SEARXNG_LANGUAGE': request.app.state.config.SEARXNG_LANGUAGE,
1213
+ 'YACY_QUERY_URL': request.app.state.config.YACY_QUERY_URL,
1214
+ 'YACY_USERNAME': request.app.state.config.YACY_USERNAME,
1215
+ 'YACY_PASSWORD': request.app.state.config.YACY_PASSWORD,
1216
+ 'GOOGLE_PSE_API_KEY': request.app.state.config.GOOGLE_PSE_API_KEY,
1217
+ 'GOOGLE_PSE_ENGINE_ID': request.app.state.config.GOOGLE_PSE_ENGINE_ID,
1218
+ 'BRAVE_SEARCH_API_KEY': request.app.state.config.BRAVE_SEARCH_API_KEY,
1219
+ 'KAGI_SEARCH_API_KEY': request.app.state.config.KAGI_SEARCH_API_KEY,
1220
+ 'MOJEEK_SEARCH_API_KEY': request.app.state.config.MOJEEK_SEARCH_API_KEY,
1221
+ 'BOCHA_SEARCH_API_KEY': request.app.state.config.BOCHA_SEARCH_API_KEY,
1222
+ 'SERPSTACK_API_KEY': request.app.state.config.SERPSTACK_API_KEY,
1223
+ 'SERPSTACK_HTTPS': request.app.state.config.SERPSTACK_HTTPS,
1224
+ 'SERPER_API_KEY': request.app.state.config.SERPER_API_KEY,
1225
+ 'SERPLY_API_KEY': request.app.state.config.SERPLY_API_KEY,
1226
+ 'TAVILY_API_KEY': request.app.state.config.TAVILY_API_KEY,
1227
+ 'SEARCHAPI_API_KEY': request.app.state.config.SEARCHAPI_API_KEY,
1228
+ 'SEARCHAPI_ENGINE': request.app.state.config.SEARCHAPI_ENGINE,
1229
+ 'SERPAPI_API_KEY': request.app.state.config.SERPAPI_API_KEY,
1230
+ 'SERPAPI_ENGINE': request.app.state.config.SERPAPI_ENGINE,
1231
+ 'JINA_API_KEY': request.app.state.config.JINA_API_KEY,
1232
+ 'JINA_API_BASE_URL': request.app.state.config.JINA_API_BASE_URL,
1233
+ 'BING_SEARCH_V7_ENDPOINT': request.app.state.config.BING_SEARCH_V7_ENDPOINT,
1234
+ 'BING_SEARCH_V7_SUBSCRIPTION_KEY': request.app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY,
1235
+ 'EXA_API_KEY': request.app.state.config.EXA_API_KEY,
1236
+ 'PERPLEXITY_API_KEY': request.app.state.config.PERPLEXITY_API_KEY,
1237
+ 'PERPLEXITY_MODEL': request.app.state.config.PERPLEXITY_MODEL,
1238
+ 'PERPLEXITY_SEARCH_CONTEXT_USAGE': request.app.state.config.PERPLEXITY_SEARCH_CONTEXT_USAGE,
1239
+ 'PERPLEXITY_SEARCH_API_URL': request.app.state.config.PERPLEXITY_SEARCH_API_URL,
1240
+ 'SOUGOU_API_SID': request.app.state.config.SOUGOU_API_SID,
1241
+ 'SOUGOU_API_SK': request.app.state.config.SOUGOU_API_SK,
1242
+ 'WEB_LOADER_ENGINE': request.app.state.config.WEB_LOADER_ENGINE,
1243
+ 'WEB_LOADER_TIMEOUT': request.app.state.config.WEB_LOADER_TIMEOUT,
1244
+ 'ENABLE_WEB_LOADER_SSL_VERIFICATION': request.app.state.config.ENABLE_WEB_LOADER_SSL_VERIFICATION,
1245
+ 'PLAYWRIGHT_WS_URL': request.app.state.config.PLAYWRIGHT_WS_URL,
1246
+ 'PLAYWRIGHT_TIMEOUT': request.app.state.config.PLAYWRIGHT_TIMEOUT,
1247
+ 'FIRECRAWL_API_KEY': request.app.state.config.FIRECRAWL_API_KEY,
1248
+ 'FIRECRAWL_API_BASE_URL': request.app.state.config.FIRECRAWL_API_BASE_URL,
1249
+ 'FIRECRAWL_TIMEOUT': request.app.state.config.FIRECRAWL_TIMEOUT,
1250
+ 'TAVILY_EXTRACT_DEPTH': request.app.state.config.TAVILY_EXTRACT_DEPTH,
1251
+ 'EXTERNAL_WEB_SEARCH_URL': request.app.state.config.EXTERNAL_WEB_SEARCH_URL,
1252
+ 'EXTERNAL_WEB_SEARCH_API_KEY': request.app.state.config.EXTERNAL_WEB_SEARCH_API_KEY,
1253
+ 'EXTERNAL_WEB_LOADER_URL': request.app.state.config.EXTERNAL_WEB_LOADER_URL,
1254
+ 'EXTERNAL_WEB_LOADER_API_KEY': request.app.state.config.EXTERNAL_WEB_LOADER_API_KEY,
1255
+ 'YOUTUBE_LOADER_LANGUAGE': request.app.state.config.YOUTUBE_LOADER_LANGUAGE,
1256
+ 'YOUTUBE_LOADER_PROXY_URL': request.app.state.config.YOUTUBE_LOADER_PROXY_URL,
1257
+ 'YOUTUBE_LOADER_TRANSLATION': request.app.state.YOUTUBE_LOADER_TRANSLATION,
1258
+ 'YANDEX_WEB_SEARCH_URL': request.app.state.config.YANDEX_WEB_SEARCH_URL,
1259
+ 'YANDEX_WEB_SEARCH_API_KEY': request.app.state.config.YANDEX_WEB_SEARCH_API_KEY,
1260
+ 'YANDEX_WEB_SEARCH_CONFIG': request.app.state.config.YANDEX_WEB_SEARCH_CONFIG,
1261
+ 'YOUCOM_API_KEY': request.app.state.config.YOUCOM_API_KEY,
1262
+ },
1263
+ }
1264
+
1265
+
1266
+ ####################################
1267
+ #
1268
+ # Document process and retrieval
1269
+ #
1270
+ ####################################
1271
+
1272
+
1273
+ def can_merge_chunks(a: Document, b: Document) -> bool:
1274
+ if a.metadata.get('source') != b.metadata.get('source'):
1275
+ return False
1276
+
1277
+ a_file_id = a.metadata.get('file_id')
1278
+ b_file_id = b.metadata.get('file_id')
1279
+
1280
+ if a_file_id is not None and b_file_id is not None:
1281
+ return a_file_id == b_file_id
1282
+
1283
+ return True
1284
+
1285
+
1286
+ def merge_docs_to_target_size(
1287
+ request: Request,
1288
+ chunks: list[Document],
1289
+ ) -> list[Document]:
1290
+ """
1291
+ Best-effort normalization of chunk sizes.
1292
+
1293
+ Attempts to grow small chunks up to a desired minimum size,
1294
+ without exceeding the maximum size or crossing source/file
1295
+ boundaries.
1296
+ """
1297
+ min_chunk_size_target = request.app.state.config.CHUNK_MIN_SIZE_TARGET
1298
+ max_chunk_size = request.app.state.config.CHUNK_SIZE
1299
+
1300
+ if min_chunk_size_target <= 0:
1301
+ return chunks
1302
+
1303
+ measure_chunk_size = len
1304
+ if request.app.state.config.TEXT_SPLITTER == 'token':
1305
+ encoding = tiktoken.get_encoding(str(request.app.state.config.TIKTOKEN_ENCODING_NAME))
1306
+ measure_chunk_size = lambda text: len(encoding.encode(text))
1307
+
1308
+ processed_chunks: list[Document] = []
1309
+
1310
+ current_chunk: Document | None = None
1311
+ current_content: str = ''
1312
+
1313
+ for next_chunk in chunks:
1314
+ if current_chunk is None:
1315
+ current_chunk = next_chunk
1316
+ current_content = next_chunk.page_content
1317
+ continue # First chunk initialization
1318
+
1319
+ proposed_content = f'{current_content}\n\n{next_chunk.page_content}'
1320
+
1321
+ can_merge = (
1322
+ can_merge_chunks(current_chunk, next_chunk)
1323
+ and measure_chunk_size(current_content) < min_chunk_size_target
1324
+ and measure_chunk_size(proposed_content) <= max_chunk_size
1325
+ )
1326
+
1327
+ if can_merge:
1328
+ current_content = proposed_content
1329
+ else:
1330
+ processed_chunks.append(
1331
+ Document(
1332
+ page_content=current_content,
1333
+ metadata={**current_chunk.metadata},
1334
+ )
1335
+ )
1336
+ current_chunk = next_chunk
1337
+ current_content = next_chunk.page_content
1338
+
1339
+ if current_chunk is not None:
1340
+ processed_chunks.append(
1341
+ Document(
1342
+ page_content=current_content,
1343
+ metadata={**current_chunk.metadata},
1344
+ )
1345
+ )
1346
+
1347
+ return processed_chunks
1348
+
1349
+
1350
+ def save_docs_to_vector_db(
1351
+ request: Request,
1352
+ docs,
1353
+ collection_name,
1354
+ metadata: Optional[dict] = None,
1355
+ overwrite: bool = False,
1356
+ split: bool = True,
1357
+ add: bool = False,
1358
+ user=None,
1359
+ ) -> bool:
1360
+ def _get_docs_info(docs: list[Document]) -> str:
1361
+ docs_info = set()
1362
+
1363
+ # Trying to select relevant metadata identifying the document.
1364
+ for doc in docs:
1365
+ metadata = getattr(doc, 'metadata', {})
1366
+ doc_name = metadata.get('name', '')
1367
+ if not doc_name:
1368
+ doc_name = metadata.get('title', '')
1369
+ if not doc_name:
1370
+ doc_name = metadata.get('source', '')
1371
+ if doc_name:
1372
+ docs_info.add(doc_name)
1373
+
1374
+ return ', '.join(docs_info)
1375
+
1376
+ log.debug(f'save_docs_to_vector_db: document {_get_docs_info(docs)} {collection_name}')
1377
+
1378
+ # Check if entries with the same hash (metadata.hash) already exist
1379
+ if metadata and 'hash' in metadata:
1380
+ result = VECTOR_DB_CLIENT.query(
1381
+ collection_name=collection_name,
1382
+ filter={'hash': metadata['hash']},
1383
+ )
1384
+
1385
+ if result is not None and result.ids and len(result.ids) > 0:
1386
+ existing_doc_ids = result.ids[0]
1387
+ if existing_doc_ids:
1388
+ # Check if the existing document belongs to the same file
1389
+ # If same file_id, this is a re-add/reindex - allow it
1390
+ # If different file_id, this is a duplicate - block it
1391
+ existing_file_id = None
1392
+ if result.metadatas and result.metadatas[0]:
1393
+ existing_file_id = result.metadatas[0][0].get('file_id')
1394
+
1395
+ if existing_file_id != metadata.get('file_id'):
1396
+ log.info(f'Document with hash {metadata["hash"]} already exists')
1397
+ raise ValueError(ERROR_MESSAGES.DUPLICATE_CONTENT)
1398
+
1399
+ if split:
1400
+ if request.app.state.config.ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER:
1401
+ log.info('Using markdown header text splitter')
1402
+ # Define headers to split on - covering most common markdown header levels
1403
+ markdown_splitter = MarkdownHeaderTextSplitter(
1404
+ headers_to_split_on=[
1405
+ ('#', 'Header 1'),
1406
+ ('##', 'Header 2'),
1407
+ ('###', 'Header 3'),
1408
+ ('####', 'Header 4'),
1409
+ ('#####', 'Header 5'),
1410
+ ('######', 'Header 6'),
1411
+ ],
1412
+ strip_headers=False, # Keep headers in content for context
1413
+ )
1414
+
1415
+ split_docs = []
1416
+ for doc in docs:
1417
+ split_docs.extend(
1418
+ [
1419
+ Document(
1420
+ page_content=split_chunk.page_content,
1421
+ metadata={**doc.metadata},
1422
+ )
1423
+ for split_chunk in markdown_splitter.split_text(doc.page_content)
1424
+ ]
1425
+ )
1426
+
1427
+ docs = split_docs
1428
+ if request.app.state.config.CHUNK_MIN_SIZE_TARGET > 0:
1429
+ docs = merge_docs_to_target_size(request, docs)
1430
+
1431
+ if request.app.state.config.TEXT_SPLITTER in ['', 'character']:
1432
+ text_splitter = RecursiveCharacterTextSplitter(
1433
+ chunk_size=request.app.state.config.CHUNK_SIZE,
1434
+ chunk_overlap=request.app.state.config.CHUNK_OVERLAP,
1435
+ add_start_index=True,
1436
+ )
1437
+ docs = text_splitter.split_documents(docs)
1438
+ elif request.app.state.config.TEXT_SPLITTER == 'token':
1439
+ log.info(f'Using token text splitter: {request.app.state.config.TIKTOKEN_ENCODING_NAME}')
1440
+
1441
+ tiktoken.get_encoding(str(request.app.state.config.TIKTOKEN_ENCODING_NAME))
1442
+ text_splitter = TokenTextSplitter(
1443
+ encoding_name=str(request.app.state.config.TIKTOKEN_ENCODING_NAME),
1444
+ chunk_size=request.app.state.config.CHUNK_SIZE,
1445
+ chunk_overlap=request.app.state.config.CHUNK_OVERLAP,
1446
+ add_start_index=True,
1447
+ )
1448
+ docs = text_splitter.split_documents(docs)
1449
+ else:
1450
+ raise ValueError(ERROR_MESSAGES.DEFAULT('Invalid text splitter'))
1451
+
1452
+ if len(docs) == 0:
1453
+ raise ValueError(ERROR_MESSAGES.EMPTY_CONTENT)
1454
+
1455
+ texts = [sanitize_text_for_db(doc.page_content) for doc in docs]
1456
+ metadatas = [
1457
+ {
1458
+ **doc.metadata,
1459
+ **(metadata if metadata else {}),
1460
+ 'embedding_config': {
1461
+ 'engine': request.app.state.config.RAG_EMBEDDING_ENGINE,
1462
+ 'model': request.app.state.config.RAG_EMBEDDING_MODEL,
1463
+ },
1464
+ }
1465
+ for doc in docs
1466
+ ]
1467
+
1468
+ try:
1469
+ if VECTOR_DB_CLIENT.has_collection(collection_name=collection_name):
1470
+ log.info(f'collection {collection_name} already exists')
1471
+
1472
+ if overwrite:
1473
+ VECTOR_DB_CLIENT.delete_collection(collection_name=collection_name)
1474
+ log.info(f'deleting existing collection {collection_name}')
1475
+ elif add is False:
1476
+ log.info(f'collection {collection_name} already exists, overwrite is False and add is False')
1477
+ return True
1478
+
1479
+ log.info(f'generating embeddings for {collection_name}')
1480
+ embedding_function = get_embedding_function(
1481
+ request.app.state.config.RAG_EMBEDDING_ENGINE,
1482
+ request.app.state.config.RAG_EMBEDDING_MODEL,
1483
+ request.app.state.ef,
1484
+ (
1485
+ request.app.state.config.RAG_OPENAI_API_BASE_URL
1486
+ if request.app.state.config.RAG_EMBEDDING_ENGINE == 'openai'
1487
+ else (
1488
+ request.app.state.config.RAG_OLLAMA_BASE_URL
1489
+ if request.app.state.config.RAG_EMBEDDING_ENGINE == 'ollama'
1490
+ else request.app.state.config.RAG_AZURE_OPENAI_BASE_URL
1491
+ )
1492
+ ),
1493
+ (
1494
+ request.app.state.config.RAG_OPENAI_API_KEY
1495
+ if request.app.state.config.RAG_EMBEDDING_ENGINE == 'openai'
1496
+ else (
1497
+ request.app.state.config.RAG_OLLAMA_API_KEY
1498
+ if request.app.state.config.RAG_EMBEDDING_ENGINE == 'ollama'
1499
+ else request.app.state.config.RAG_AZURE_OPENAI_API_KEY
1500
+ )
1501
+ ),
1502
+ request.app.state.config.RAG_EMBEDDING_BATCH_SIZE,
1503
+ azure_api_version=(
1504
+ request.app.state.config.RAG_AZURE_OPENAI_API_VERSION
1505
+ if request.app.state.config.RAG_EMBEDDING_ENGINE == 'azure_openai'
1506
+ else None
1507
+ ),
1508
+ enable_async=request.app.state.config.ENABLE_ASYNC_EMBEDDING,
1509
+ concurrent_requests=request.app.state.config.RAG_EMBEDDING_CONCURRENT_REQUESTS,
1510
+ )
1511
+
1512
+ # Run async embedding in sync context using the main event loop
1513
+ # This allows the main loop to stay responsive to health checks during long operations
1514
+ embedding_timeout = RAG_EMBEDDING_TIMEOUT
1515
+
1516
+ future = asyncio.run_coroutine_threadsafe(
1517
+ embedding_function(
1518
+ list(map(lambda x: x.replace('\n', ' '), texts)),
1519
+ prefix=RAG_EMBEDDING_CONTENT_PREFIX,
1520
+ user=user,
1521
+ ),
1522
+ request.app.state.main_loop,
1523
+ )
1524
+ embeddings = future.result(timeout=embedding_timeout)
1525
+ log.info(f'embeddings generated {len(embeddings)} for {len(texts)} items')
1526
+
1527
+ items = [
1528
+ {
1529
+ 'id': str(uuid.uuid4()),
1530
+ 'text': text,
1531
+ 'vector': embeddings[idx],
1532
+ 'metadata': metadatas[idx],
1533
+ }
1534
+ for idx, text in enumerate(texts)
1535
+ ]
1536
+
1537
+ log.info(f'adding to collection {collection_name}')
1538
+ VECTOR_DB_CLIENT.insert(
1539
+ collection_name=collection_name,
1540
+ items=items,
1541
+ )
1542
+
1543
+ log.info(f'added {len(items)} items to collection {collection_name}')
1544
+ return True
1545
+ except Exception as e:
1546
+ log.exception(e)
1547
+ raise e
1548
+
1549
+
1550
+ class ProcessFileForm(BaseModel):
1551
+ file_id: str
1552
+ content: Optional[str] = None
1553
+ collection_name: Optional[str] = None
1554
+
1555
+
1556
+ @router.post('/process/file')
1557
+ async def process_file(
1558
+ request: Request,
1559
+ form_data: ProcessFileForm,
1560
+ user=Depends(get_verified_user),
1561
+ db: AsyncSession = Depends(get_async_session),
1562
+ ):
1563
+ """
1564
+ Process a file and save its content to the vector database.
1565
+ Process a file and save its content to the vector database.
1566
+ Note: granular session management is used to prevent connection pool exhaustion.
1567
+ The session is committed before external API calls, and updates use a fresh session.
1568
+ """
1569
+ if user.role == 'admin':
1570
+ file = await Files.get_file_by_id(form_data.file_id, db=db)
1571
+ else:
1572
+ file = await Files.get_file_by_id_and_user_id(form_data.file_id, user.id, db=db)
1573
+
1574
+ if file:
1575
+ try:
1576
+ collection_name = form_data.collection_name
1577
+
1578
+ if collection_name is None:
1579
+ collection_name = f'file-{file.id}'
1580
+
1581
+ if form_data.content:
1582
+ # Update the content in the file
1583
+ # Usage: /files/{file_id}/data/content/update, /files/ (audio file upload pipeline)
1584
+
1585
+ try:
1586
+ # /files/{file_id}/data/content/update
1587
+ await ASYNC_VECTOR_DB_CLIENT.delete_collection(collection_name=f'file-{file.id}')
1588
+ except Exception:
1589
+ # Audio file upload pipeline
1590
+ pass
1591
+
1592
+ docs = [
1593
+ Document(
1594
+ page_content=form_data.content.replace('<br/>', '\n'),
1595
+ metadata={
1596
+ **file.meta,
1597
+ 'name': file.filename,
1598
+ 'created_by': file.user_id,
1599
+ 'file_id': file.id,
1600
+ 'source': file.filename,
1601
+ },
1602
+ )
1603
+ ]
1604
+
1605
+ text_content = form_data.content
1606
+ elif form_data.collection_name:
1607
+ # Check if the file has already been processed and save the content
1608
+ # Usage: /knowledge/{id}/file/add, /knowledge/{id}/file/update
1609
+
1610
+ result = await ASYNC_VECTOR_DB_CLIENT.query(
1611
+ collection_name=f'file-{file.id}', filter={'file_id': file.id}
1612
+ )
1613
+
1614
+ if result is not None and len(result.ids[0]) > 0:
1615
+ docs = [
1616
+ Document(
1617
+ page_content=result.documents[0][idx],
1618
+ metadata=result.metadatas[0][idx],
1619
+ )
1620
+ for idx, id in enumerate(result.ids[0])
1621
+ ]
1622
+ else:
1623
+ docs = [
1624
+ Document(
1625
+ page_content=file.data.get('content', ''),
1626
+ metadata={
1627
+ **file.meta,
1628
+ 'name': file.filename,
1629
+ 'created_by': file.user_id,
1630
+ 'file_id': file.id,
1631
+ 'source': file.filename,
1632
+ },
1633
+ )
1634
+ ]
1635
+
1636
+ text_content = file.data.get('content', '')
1637
+ else:
1638
+ # Process the file and save the content
1639
+ # Usage: /files/
1640
+ file_path = file.path
1641
+ if file_path:
1642
+ file_path = await asyncio.to_thread(Storage.get_file, file_path)
1643
+ loader = build_loader_from_config(request)
1644
+ loader.user = user
1645
+ docs = await loader.aload(file.filename, file.meta.get('content_type'), file_path)
1646
+
1647
+ docs = [
1648
+ Document(
1649
+ page_content=doc.page_content,
1650
+ metadata={
1651
+ **filter_metadata(doc.metadata),
1652
+ 'name': file.filename,
1653
+ 'created_by': file.user_id,
1654
+ 'file_id': file.id,
1655
+ 'source': file.filename,
1656
+ },
1657
+ )
1658
+ for doc in docs
1659
+ ]
1660
+ else:
1661
+ docs = [
1662
+ Document(
1663
+ page_content=file.data.get('content', ''),
1664
+ metadata={
1665
+ **file.meta,
1666
+ 'name': file.filename,
1667
+ 'created_by': file.user_id,
1668
+ 'file_id': file.id,
1669
+ 'source': file.filename,
1670
+ },
1671
+ )
1672
+ ]
1673
+ text_content = ' '.join([doc.page_content for doc in docs])
1674
+
1675
+ log.debug(f'text_content: {text_content}')
1676
+ await Files.update_file_data_by_id(
1677
+ file.id,
1678
+ {'content': text_content},
1679
+ db=db,
1680
+ )
1681
+ hash = calculate_sha256_string(text_content)
1682
+
1683
+ if request.app.state.config.BYPASS_EMBEDDING_AND_RETRIEVAL:
1684
+ await Files.update_file_data_by_id(file.id, {'status': 'completed'}, db=db)
1685
+ await Files.update_file_hash_by_id(file.id, hash, db=db)
1686
+ return {
1687
+ 'status': True,
1688
+ 'collection_name': None,
1689
+ 'filename': file.filename,
1690
+ 'content': text_content,
1691
+ }
1692
+ else:
1693
+ try:
1694
+ # Commit any pending changes before the slow embedding step.
1695
+ # Note: file is already a Pydantic model (not ORM), so no expunge needed.
1696
+ await db.commit()
1697
+
1698
+ # External embedding API takes time (5-60s+).
1699
+ # Subsequent updates use fresh async sessions.
1700
+ # NOTE: save_docs_to_vector_db is a sync function that
1701
+ # calls asyncio.run_coroutine_threadsafe(..., main_loop).result()
1702
+ # which blocks the calling thread. We MUST run it in a
1703
+ # worker thread to avoid deadlocking the event loop.
1704
+ result = await run_in_threadpool(
1705
+ save_docs_to_vector_db,
1706
+ request,
1707
+ docs=docs,
1708
+ collection_name=collection_name,
1709
+ metadata={
1710
+ 'file_id': file.id,
1711
+ 'name': file.filename,
1712
+ 'hash': hash,
1713
+ },
1714
+ add=(True if form_data.collection_name else False),
1715
+ user=user,
1716
+ )
1717
+ log.info(f'added {len(docs)} items to collection {collection_name}')
1718
+
1719
+ if result:
1720
+ # Fresh session for the final update.
1721
+ async with get_async_db() as session:
1722
+ await Files.update_file_metadata_by_id(
1723
+ file.id,
1724
+ {
1725
+ 'collection_name': collection_name,
1726
+ },
1727
+ db=session,
1728
+ )
1729
+
1730
+ await Files.update_file_data_by_id(
1731
+ file.id,
1732
+ {'status': 'completed'},
1733
+ db=session,
1734
+ )
1735
+ await Files.update_file_hash_by_id(file.id, hash, db=session)
1736
+
1737
+ return {
1738
+ 'status': True,
1739
+ 'collection_name': collection_name,
1740
+ 'filename': file.filename,
1741
+ 'content': text_content,
1742
+ }
1743
+ else:
1744
+ raise Exception('Error saving document to vector database')
1745
+ except Exception as e:
1746
+ raise e
1747
+
1748
+ except Exception as e:
1749
+ log.exception(e)
1750
+ # Fresh session for error status update.
1751
+ async with get_async_db() as session:
1752
+ await Files.update_file_data_by_id(
1753
+ file.id,
1754
+ {'status': 'failed'},
1755
+ db=session,
1756
+ )
1757
+ # Clear the hash so the file can be re-uploaded after fixing the issue
1758
+ await Files.update_file_hash_by_id(file.id, None, db=session)
1759
+
1760
+ if 'No pandoc was found' in str(e):
1761
+ raise HTTPException(
1762
+ status_code=status.HTTP_400_BAD_REQUEST,
1763
+ detail=ERROR_MESSAGES.PANDOC_NOT_INSTALLED,
1764
+ )
1765
+ else:
1766
+ raise HTTPException(
1767
+ status_code=status.HTTP_400_BAD_REQUEST,
1768
+ detail=str(e),
1769
+ )
1770
+
1771
+ else:
1772
+ raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=ERROR_MESSAGES.NOT_FOUND)
1773
+
1774
+
1775
+ class ProcessTextForm(BaseModel):
1776
+ name: str
1777
+ content: str
1778
+ collection_name: Optional[str] = None
1779
+
1780
+
1781
+ @router.post('/process/text')
1782
+ async def process_text(
1783
+ request: Request,
1784
+ form_data: ProcessTextForm,
1785
+ user=Depends(get_verified_user),
1786
+ ):
1787
+ collection_name = form_data.collection_name
1788
+ if collection_name is None:
1789
+ collection_name = calculate_sha256_string(form_data.content)
1790
+ else:
1791
+ await _validate_collection_access([collection_name], user, access_type='write')
1792
+
1793
+ docs = [
1794
+ Document(
1795
+ page_content=form_data.content,
1796
+ metadata={'name': form_data.name, 'created_by': user.id},
1797
+ )
1798
+ ]
1799
+ text_content = form_data.content
1800
+ log.debug(f'text_content: {text_content}')
1801
+
1802
+ result = await run_in_threadpool(save_docs_to_vector_db, request, docs, collection_name, user=user)
1803
+ if result:
1804
+ return {
1805
+ 'status': True,
1806
+ 'collection_name': collection_name,
1807
+ 'content': text_content,
1808
+ }
1809
+ else:
1810
+ raise HTTPException(
1811
+ status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
1812
+ detail=ERROR_MESSAGES.DEFAULT(),
1813
+ )
1814
+
1815
+
1816
+ @router.post('/process/youtube')
1817
+ @router.post('/process/web')
1818
+ async def process_web(
1819
+ request: Request,
1820
+ form_data: ProcessUrlForm,
1821
+ process: bool = Query(True, description='Whether to process and save the content'),
1822
+ overwrite: bool = Query(True, description='Whether to overwrite existing collection'),
1823
+ user=Depends(get_verified_user),
1824
+ ):
1825
+ try:
1826
+ content, docs = await run_in_threadpool(get_content_from_url, request, form_data.url)
1827
+ log.debug(f'text_content: {content}')
1828
+
1829
+ if process:
1830
+ collection_name = form_data.collection_name
1831
+ if not collection_name:
1832
+ collection_name = calculate_sha256_string(form_data.url)[:63]
1833
+ else:
1834
+ await _validate_collection_access([collection_name], user, access_type='write')
1835
+
1836
+ if not request.app.state.config.BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL:
1837
+ await run_in_threadpool(
1838
+ save_docs_to_vector_db,
1839
+ request,
1840
+ docs,
1841
+ collection_name,
1842
+ overwrite=overwrite,
1843
+ add=(not overwrite),
1844
+ user=user,
1845
+ )
1846
+ else:
1847
+ collection_name = None
1848
+
1849
+ return {
1850
+ 'status': True,
1851
+ 'collection_name': collection_name,
1852
+ 'filename': form_data.url,
1853
+ 'file': {
1854
+ 'data': {
1855
+ 'content': content,
1856
+ },
1857
+ 'meta': {
1858
+ 'name': form_data.url,
1859
+ 'source': form_data.url,
1860
+ },
1861
+ },
1862
+ }
1863
+ else:
1864
+ return {
1865
+ 'status': True,
1866
+ 'content': content,
1867
+ }
1868
+ except Exception as e:
1869
+ log.exception(e)
1870
+ raise HTTPException(
1871
+ status_code=status.HTTP_400_BAD_REQUEST,
1872
+ detail=ERROR_MESSAGES.DEFAULT(e),
1873
+ )
1874
+
1875
+
1876
+ def search_web(request: Request, engine: str, query: str, user=None) -> list[SearchResult]:
1877
+ """Search the web using a search engine and return the results as a list of SearchResult objects.
1878
+ Will look for a search engine API key in environment variables in the following order:
1879
+ - SEARXNG_QUERY_URL
1880
+ - YACY_QUERY_URL + YACY_USERNAME + YACY_PASSWORD
1881
+ - GOOGLE_PSE_API_KEY + GOOGLE_PSE_ENGINE_ID
1882
+ - BRAVE_SEARCH_API_KEY
1883
+ - KAGI_SEARCH_API_KEY
1884
+ - MOJEEK_SEARCH_API_KEY
1885
+ - BOCHA_SEARCH_API_KEY
1886
+ - SERPSTACK_API_KEY
1887
+ - SERPER_API_KEY
1888
+ - SERPLY_API_KEY
1889
+ - TAVILY_API_KEY
1890
+ - EXA_API_KEY
1891
+ - PERPLEXITY_API_KEY
1892
+ - SOUGOU_API_SID + SOUGOU_API_SK
1893
+ - SEARCHAPI_API_KEY + SEARCHAPI_ENGINE (by default `google`)
1894
+ - SERPAPI_API_KEY + SERPAPI_ENGINE (by default `google`)
1895
+ Args:
1896
+ query (str): The query to search for
1897
+ """
1898
+
1899
+ # TODO: add playwright to search the web
1900
+ if engine == 'ollama_cloud':
1901
+ return search_ollama_cloud(
1902
+ 'https://ollama.com',
1903
+ request.app.state.config.OLLAMA_CLOUD_WEB_SEARCH_API_KEY,
1904
+ query,
1905
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
1906
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
1907
+ )
1908
+ elif engine == 'perplexity_search':
1909
+ if request.app.state.config.PERPLEXITY_API_KEY:
1910
+ return search_perplexity_search(
1911
+ request.app.state.config.PERPLEXITY_API_KEY,
1912
+ query,
1913
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
1914
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
1915
+ request.app.state.config.PERPLEXITY_SEARCH_API_URL,
1916
+ user,
1917
+ )
1918
+ else:
1919
+ raise Exception('No PERPLEXITY_API_KEY found in environment variables')
1920
+ elif engine == 'searxng':
1921
+ if request.app.state.config.SEARXNG_QUERY_URL:
1922
+ searxng_kwargs = {'language': request.app.state.config.SEARXNG_LANGUAGE}
1923
+ return search_searxng(
1924
+ request.app.state.config.SEARXNG_QUERY_URL,
1925
+ query,
1926
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
1927
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
1928
+ **searxng_kwargs,
1929
+ )
1930
+ else:
1931
+ raise Exception('No SEARXNG_QUERY_URL found in environment variables')
1932
+ elif engine == 'yacy':
1933
+ if request.app.state.config.YACY_QUERY_URL:
1934
+ return search_yacy(
1935
+ request.app.state.config.YACY_QUERY_URL,
1936
+ request.app.state.config.YACY_USERNAME,
1937
+ request.app.state.config.YACY_PASSWORD,
1938
+ query,
1939
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
1940
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
1941
+ )
1942
+ else:
1943
+ raise Exception('No YACY_QUERY_URL found in environment variables')
1944
+ elif engine == 'google_pse':
1945
+ if request.app.state.config.GOOGLE_PSE_API_KEY and request.app.state.config.GOOGLE_PSE_ENGINE_ID:
1946
+ return search_google_pse(
1947
+ request.app.state.config.GOOGLE_PSE_API_KEY,
1948
+ request.app.state.config.GOOGLE_PSE_ENGINE_ID,
1949
+ query,
1950
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
1951
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
1952
+ referer=request.app.state.config.WEBUI_URL,
1953
+ )
1954
+ else:
1955
+ raise Exception('No GOOGLE_PSE_API_KEY or GOOGLE_PSE_ENGINE_ID found in environment variables')
1956
+ elif engine == 'brave':
1957
+ if request.app.state.config.BRAVE_SEARCH_API_KEY:
1958
+ return search_brave(
1959
+ request.app.state.config.BRAVE_SEARCH_API_KEY,
1960
+ query,
1961
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
1962
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
1963
+ )
1964
+ else:
1965
+ raise Exception('No BRAVE_SEARCH_API_KEY found in environment variables')
1966
+ elif engine == 'kagi':
1967
+ if request.app.state.config.KAGI_SEARCH_API_KEY:
1968
+ return search_kagi(
1969
+ request.app.state.config.KAGI_SEARCH_API_KEY,
1970
+ query,
1971
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
1972
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
1973
+ )
1974
+ else:
1975
+ raise Exception('No KAGI_SEARCH_API_KEY found in environment variables')
1976
+ elif engine == 'mojeek':
1977
+ if request.app.state.config.MOJEEK_SEARCH_API_KEY:
1978
+ return search_mojeek(
1979
+ request.app.state.config.MOJEEK_SEARCH_API_KEY,
1980
+ query,
1981
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
1982
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
1983
+ )
1984
+ else:
1985
+ raise Exception('No MOJEEK_SEARCH_API_KEY found in environment variables')
1986
+ elif engine == 'bocha':
1987
+ if request.app.state.config.BOCHA_SEARCH_API_KEY:
1988
+ return search_bocha(
1989
+ request.app.state.config.BOCHA_SEARCH_API_KEY,
1990
+ query,
1991
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
1992
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
1993
+ )
1994
+ else:
1995
+ raise Exception('No BOCHA_SEARCH_API_KEY found in environment variables')
1996
+ elif engine == 'serpstack':
1997
+ if request.app.state.config.SERPSTACK_API_KEY:
1998
+ return search_serpstack(
1999
+ request.app.state.config.SERPSTACK_API_KEY,
2000
+ query,
2001
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2002
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2003
+ https_enabled=request.app.state.config.SERPSTACK_HTTPS,
2004
+ )
2005
+ else:
2006
+ raise Exception('No SERPSTACK_API_KEY found in environment variables')
2007
+ elif engine == 'serper':
2008
+ if request.app.state.config.SERPER_API_KEY:
2009
+ return search_serper(
2010
+ request.app.state.config.SERPER_API_KEY,
2011
+ query,
2012
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2013
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2014
+ )
2015
+ else:
2016
+ raise Exception('No SERPER_API_KEY found in environment variables')
2017
+ elif engine == 'serply':
2018
+ if request.app.state.config.SERPLY_API_KEY:
2019
+ return search_serply(
2020
+ request.app.state.config.SERPLY_API_KEY,
2021
+ query,
2022
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2023
+ filter_list=request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2024
+ )
2025
+ else:
2026
+ raise Exception('No SERPLY_API_KEY found in environment variables')
2027
+ elif engine == 'duckduckgo':
2028
+ return search_duckduckgo(
2029
+ query,
2030
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2031
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2032
+ concurrent_requests=request.app.state.config.WEB_SEARCH_CONCURRENT_REQUESTS,
2033
+ backend=request.app.state.config.DDGS_BACKEND,
2034
+ )
2035
+ elif engine == 'tavily':
2036
+ if request.app.state.config.TAVILY_API_KEY:
2037
+ return search_tavily(
2038
+ request.app.state.config.TAVILY_API_KEY,
2039
+ query,
2040
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2041
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2042
+ )
2043
+ else:
2044
+ raise Exception('No TAVILY_API_KEY found in environment variables')
2045
+ elif engine == 'exa':
2046
+ if request.app.state.config.EXA_API_KEY:
2047
+ return search_exa(
2048
+ request.app.state.config.EXA_API_KEY,
2049
+ query,
2050
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2051
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2052
+ )
2053
+ else:
2054
+ raise Exception('No EXA_API_KEY found in environment variables')
2055
+ elif engine == 'searchapi':
2056
+ if request.app.state.config.SEARCHAPI_API_KEY:
2057
+ return search_searchapi(
2058
+ request.app.state.config.SEARCHAPI_API_KEY,
2059
+ request.app.state.config.SEARCHAPI_ENGINE,
2060
+ query,
2061
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2062
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2063
+ )
2064
+ else:
2065
+ raise Exception('No SEARCHAPI_API_KEY found in environment variables')
2066
+ elif engine == 'serpapi':
2067
+ if request.app.state.config.SERPAPI_API_KEY:
2068
+ return search_serpapi(
2069
+ request.app.state.config.SERPAPI_API_KEY,
2070
+ request.app.state.config.SERPAPI_ENGINE,
2071
+ query,
2072
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2073
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2074
+ )
2075
+ else:
2076
+ raise Exception('No SERPAPI_API_KEY found in environment variables')
2077
+ elif engine == 'jina':
2078
+ return search_jina(
2079
+ request.app.state.config.JINA_API_KEY,
2080
+ query,
2081
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2082
+ request.app.state.config.JINA_API_BASE_URL,
2083
+ )
2084
+ elif engine == 'bing':
2085
+ return search_bing(
2086
+ request.app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY,
2087
+ request.app.state.config.BING_SEARCH_V7_ENDPOINT,
2088
+ str(DEFAULT_LOCALE),
2089
+ query,
2090
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2091
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2092
+ )
2093
+ elif engine == 'azure':
2094
+ if (
2095
+ request.app.state.config.AZURE_AI_SEARCH_API_KEY
2096
+ and request.app.state.config.AZURE_AI_SEARCH_ENDPOINT
2097
+ and request.app.state.config.AZURE_AI_SEARCH_INDEX_NAME
2098
+ ):
2099
+ return search_azure(
2100
+ request.app.state.config.AZURE_AI_SEARCH_API_KEY,
2101
+ request.app.state.config.AZURE_AI_SEARCH_ENDPOINT,
2102
+ request.app.state.config.AZURE_AI_SEARCH_INDEX_NAME,
2103
+ query,
2104
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2105
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2106
+ )
2107
+ else:
2108
+ raise Exception(
2109
+ 'AZURE_AI_SEARCH_API_KEY, AZURE_AI_SEARCH_ENDPOINT, and AZURE_AI_SEARCH_INDEX_NAME are required for Azure AI Search'
2110
+ )
2111
+ elif engine == 'exa':
2112
+ return search_exa(
2113
+ request.app.state.config.EXA_API_KEY,
2114
+ query,
2115
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2116
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2117
+ )
2118
+ elif engine == 'perplexity':
2119
+ return search_perplexity(
2120
+ request.app.state.config.PERPLEXITY_API_KEY,
2121
+ query,
2122
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2123
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2124
+ model=request.app.state.config.PERPLEXITY_MODEL,
2125
+ search_context_usage=request.app.state.config.PERPLEXITY_SEARCH_CONTEXT_USAGE,
2126
+ )
2127
+ elif engine == 'sougou':
2128
+ if request.app.state.config.SOUGOU_API_SID and request.app.state.config.SOUGOU_API_SK:
2129
+ return search_sougou(
2130
+ request.app.state.config.SOUGOU_API_SID,
2131
+ request.app.state.config.SOUGOU_API_SK,
2132
+ query,
2133
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2134
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2135
+ )
2136
+ else:
2137
+ raise Exception('No SOUGOU_API_SID or SOUGOU_API_SK found in environment variables')
2138
+ elif engine == 'firecrawl':
2139
+ return search_firecrawl(
2140
+ request.app.state.config.FIRECRAWL_API_BASE_URL,
2141
+ request.app.state.config.FIRECRAWL_API_KEY,
2142
+ query,
2143
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2144
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2145
+ )
2146
+ elif engine == 'external':
2147
+ return search_external(
2148
+ request,
2149
+ request.app.state.config.EXTERNAL_WEB_SEARCH_URL,
2150
+ request.app.state.config.EXTERNAL_WEB_SEARCH_API_KEY,
2151
+ query,
2152
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2153
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2154
+ user=user,
2155
+ )
2156
+ elif engine == 'yandex':
2157
+ return search_yandex(
2158
+ request,
2159
+ request.app.state.config.YANDEX_WEB_SEARCH_URL,
2160
+ request.app.state.config.YANDEX_WEB_SEARCH_API_KEY,
2161
+ request.app.state.config.YANDEX_WEB_SEARCH_CONFIG,
2162
+ query,
2163
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2164
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2165
+ user=user,
2166
+ )
2167
+ elif engine == 'youcom':
2168
+ return search_youcom(
2169
+ request.app.state.config.YOUCOM_API_KEY,
2170
+ query,
2171
+ request.app.state.config.WEB_SEARCH_RESULT_COUNT,
2172
+ request.app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST,
2173
+ )
2174
+ else:
2175
+ raise Exception('No search engine API key found in environment variables')
2176
+
2177
+
2178
+ @router.post('/process/web/search')
2179
+ async def process_web_search(request: Request, form_data: SearchForm, user=Depends(get_verified_user)):
2180
+ if not request.app.state.config.ENABLE_WEB_SEARCH:
2181
+ raise HTTPException(
2182
+ status_code=status.HTTP_403_FORBIDDEN,
2183
+ detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
2184
+ )
2185
+
2186
+ if user.role != 'admin' and not await has_permission(
2187
+ user.id, 'features.web_search', request.app.state.config.USER_PERMISSIONS
2188
+ ):
2189
+ raise HTTPException(
2190
+ status_code=status.HTTP_403_FORBIDDEN,
2191
+ detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
2192
+ )
2193
+
2194
+ urls = []
2195
+ result_items = []
2196
+
2197
+ try:
2198
+ logging.debug(f'trying to web search with {request.app.state.config.WEB_SEARCH_ENGINE, form_data.queries}')
2199
+
2200
+ # Use semaphore to limit concurrent requests based on WEB_SEARCH_CONCURRENT_REQUESTS
2201
+ # 0 or None = unlimited (previous behavior), positive number = limited concurrency
2202
+ # Set to 1 for sequential execution (rate-limited APIs like Brave free tier)
2203
+ concurrent_limit = request.app.state.config.WEB_SEARCH_CONCURRENT_REQUESTS
2204
+
2205
+ if concurrent_limit:
2206
+ # Limited concurrency with semaphore
2207
+ semaphore = asyncio.Semaphore(concurrent_limit)
2208
+
2209
+ async def search_query_with_semaphore(query):
2210
+ async with semaphore:
2211
+ return await run_in_threadpool(
2212
+ search_web,
2213
+ request,
2214
+ request.app.state.config.WEB_SEARCH_ENGINE,
2215
+ query,
2216
+ user,
2217
+ )
2218
+
2219
+ search_tasks = [search_query_with_semaphore(query) for query in form_data.queries]
2220
+ else:
2221
+ # Unlimited parallel execution (previous behavior)
2222
+ search_tasks = [
2223
+ run_in_threadpool(
2224
+ search_web,
2225
+ request,
2226
+ request.app.state.config.WEB_SEARCH_ENGINE,
2227
+ query,
2228
+ user,
2229
+ )
2230
+ for query in form_data.queries
2231
+ ]
2232
+
2233
+ search_results = await asyncio.gather(*search_tasks)
2234
+
2235
+ for result in search_results:
2236
+ if result:
2237
+ for item in result:
2238
+ if item and item.link:
2239
+ result_items.append(item)
2240
+ urls.append(item.link)
2241
+
2242
+ urls = list(dict.fromkeys(urls))
2243
+ log.debug(f'urls: {urls}')
2244
+
2245
+ except Exception as e:
2246
+ log.exception(e)
2247
+
2248
+ raise HTTPException(
2249
+ status_code=status.HTTP_400_BAD_REQUEST,
2250
+ detail=ERROR_MESSAGES.WEB_SEARCH_ERROR(e),
2251
+ )
2252
+
2253
+ if len(urls) == 0:
2254
+ raise HTTPException(
2255
+ status_code=status.HTTP_404_NOT_FOUND,
2256
+ detail=ERROR_MESSAGES.DEFAULT('No results found from web search'),
2257
+ )
2258
+
2259
+ try:
2260
+ if request.app.state.config.BYPASS_WEB_SEARCH_WEB_LOADER:
2261
+ search_results = [item for result in search_results for item in result if result]
2262
+
2263
+ docs = [
2264
+ Document(
2265
+ page_content=result.snippet,
2266
+ metadata={
2267
+ 'source': result.link,
2268
+ 'title': result.title,
2269
+ 'snippet': result.snippet,
2270
+ 'link': result.link,
2271
+ },
2272
+ )
2273
+ for result in search_results
2274
+ if hasattr(result, 'snippet') and result.snippet is not None
2275
+ ]
2276
+ else:
2277
+ loader = get_web_loader(
2278
+ urls,
2279
+ verify_ssl=request.app.state.config.ENABLE_WEB_LOADER_SSL_VERIFICATION,
2280
+ requests_per_second=request.app.state.config.WEB_LOADER_CONCURRENT_REQUESTS,
2281
+ trust_env=request.app.state.config.WEB_SEARCH_TRUST_ENV,
2282
+ )
2283
+ docs = await loader.aload()
2284
+
2285
+ urls = [
2286
+ doc.metadata.get('source') for doc in docs if doc.metadata.get('source')
2287
+ ] # only keep the urls returned by the loader
2288
+ result_items = [
2289
+ dict(item) for item in result_items if item.link in urls
2290
+ ] # only keep the search results that have been loaded
2291
+
2292
+ if request.app.state.config.BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL:
2293
+ return {
2294
+ 'status': True,
2295
+ 'collection_name': None,
2296
+ 'filenames': urls,
2297
+ 'items': result_items,
2298
+ 'docs': [
2299
+ {
2300
+ 'content': doc.page_content,
2301
+ 'metadata': doc.metadata,
2302
+ }
2303
+ for doc in docs
2304
+ ],
2305
+ 'loaded_count': len(docs),
2306
+ }
2307
+ else:
2308
+ # Create a single collection for all documents
2309
+ collection_name = f'web-search-{calculate_sha256_string("-".join(form_data.queries))}'[:63]
2310
+
2311
+ try:
2312
+ await run_in_threadpool(
2313
+ save_docs_to_vector_db,
2314
+ request,
2315
+ docs,
2316
+ collection_name,
2317
+ overwrite=True,
2318
+ user=user,
2319
+ )
2320
+ except Exception as e:
2321
+ log.debug(f'error saving docs: {e}')
2322
+
2323
+ return {
2324
+ 'status': True,
2325
+ 'collection_names': [collection_name],
2326
+ 'items': result_items,
2327
+ 'filenames': urls,
2328
+ 'loaded_count': len(docs),
2329
+ }
2330
+ except Exception as e:
2331
+ log.exception(e)
2332
+ raise HTTPException(
2333
+ status_code=status.HTTP_400_BAD_REQUEST,
2334
+ detail=ERROR_MESSAGES.DEFAULT(e),
2335
+ )
2336
+
2337
+
2338
+ async def _validate_collection_access(collection_names: list[str], user, access_type: str = 'read') -> None:
2339
+ """
2340
+ Raise 403 if the user lacks access to any of the requested collections.
2341
+ Delegates to the shared filter_accessible_collections utility so the
2342
+ access rules stay in one place.
2343
+ """
2344
+ requested = set(collection_names)
2345
+ allowed = await filter_accessible_collections(requested, user, access_type=access_type)
2346
+ denied = requested - allowed
2347
+ if denied:
2348
+ raise HTTPException(
2349
+ status_code=status.HTTP_403_FORBIDDEN,
2350
+ detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
2351
+ )
2352
+
2353
+
2354
+ class QueryDocForm(BaseModel):
2355
+ collection_name: str
2356
+ query: str
2357
+ k: Optional[int] = None
2358
+ k_reranker: Optional[int] = None
2359
+ r: Optional[float] = None
2360
+ hybrid: Optional[bool] = None
2361
+
2362
+
2363
+ @router.post('/query/doc')
2364
+ async def query_doc_handler(
2365
+ request: Request,
2366
+ form_data: QueryDocForm,
2367
+ user=Depends(get_verified_user),
2368
+ ):
2369
+ await _validate_collection_access([form_data.collection_name], user)
2370
+
2371
+ try:
2372
+ if request.app.state.config.ENABLE_RAG_HYBRID_SEARCH and (form_data.hybrid is None or form_data.hybrid):
2373
+ collection_results = {}
2374
+ collection_results[form_data.collection_name] = await ASYNC_VECTOR_DB_CLIENT.get(
2375
+ collection_name=form_data.collection_name
2376
+ )
2377
+ return await query_doc_with_hybrid_search(
2378
+ collection_name=form_data.collection_name,
2379
+ collection_result=collection_results[form_data.collection_name],
2380
+ query=form_data.query,
2381
+ embedding_function=lambda query, prefix: request.app.state.EMBEDDING_FUNCTION(
2382
+ query, prefix=prefix, user=user
2383
+ ),
2384
+ k=form_data.k if form_data.k else request.app.state.config.TOP_K,
2385
+ reranking_function=(
2386
+ (lambda query, documents: request.app.state.RERANKING_FUNCTION(query, documents, user=user))
2387
+ if request.app.state.RERANKING_FUNCTION
2388
+ else None
2389
+ ),
2390
+ k_reranker=form_data.k_reranker or request.app.state.config.TOP_K_RERANKER,
2391
+ r=(form_data.r if form_data.r else request.app.state.config.RELEVANCE_THRESHOLD),
2392
+ hybrid_bm25_weight=(
2393
+ form_data.hybrid_bm25_weight
2394
+ if form_data.hybrid_bm25_weight
2395
+ else request.app.state.config.HYBRID_BM25_WEIGHT
2396
+ ),
2397
+ user=user,
2398
+ )
2399
+ else:
2400
+ query_embedding = await request.app.state.EMBEDDING_FUNCTION(
2401
+ form_data.query, prefix=RAG_EMBEDDING_QUERY_PREFIX, user=user
2402
+ )
2403
+ # query_doc wraps a blocking VECTOR_DB_CLIENT.search call;
2404
+ # offload so the request's event loop stays responsive.
2405
+ return await asyncio.to_thread(
2406
+ query_doc,
2407
+ collection_name=form_data.collection_name,
2408
+ query_embedding=query_embedding,
2409
+ k=form_data.k if form_data.k else request.app.state.config.TOP_K,
2410
+ user=user,
2411
+ )
2412
+ except Exception as e:
2413
+ log.exception(e)
2414
+ raise HTTPException(
2415
+ status_code=status.HTTP_400_BAD_REQUEST,
2416
+ detail=ERROR_MESSAGES.DEFAULT(e),
2417
+ )
2418
+
2419
+
2420
+ class QueryCollectionsForm(BaseModel):
2421
+ collection_names: list[str]
2422
+ query: str
2423
+ k: Optional[int] = None
2424
+ k_reranker: Optional[int] = None
2425
+ r: Optional[float] = None
2426
+ hybrid: Optional[bool] = None
2427
+ hybrid_bm25_weight: Optional[float] = None
2428
+ enable_enriched_texts: Optional[bool] = None
2429
+
2430
+
2431
+ @router.post('/query/collection')
2432
+ async def query_collection_handler(
2433
+ request: Request,
2434
+ form_data: QueryCollectionsForm,
2435
+ user=Depends(get_verified_user),
2436
+ ):
2437
+ await _validate_collection_access(form_data.collection_names, user)
2438
+
2439
+ try:
2440
+ if request.app.state.config.ENABLE_RAG_HYBRID_SEARCH and (form_data.hybrid is None or form_data.hybrid):
2441
+ return await query_collection_with_hybrid_search(
2442
+ collection_names=form_data.collection_names,
2443
+ queries=[form_data.query],
2444
+ embedding_function=lambda query, prefix: request.app.state.EMBEDDING_FUNCTION(
2445
+ query, prefix=prefix, user=user
2446
+ ),
2447
+ k=form_data.k if form_data.k else request.app.state.config.TOP_K,
2448
+ reranking_function=(
2449
+ (lambda query, documents: request.app.state.RERANKING_FUNCTION(query, documents, user=user))
2450
+ if request.app.state.RERANKING_FUNCTION
2451
+ else None
2452
+ ),
2453
+ k_reranker=form_data.k_reranker or request.app.state.config.TOP_K_RERANKER,
2454
+ r=(form_data.r if form_data.r else request.app.state.config.RELEVANCE_THRESHOLD),
2455
+ hybrid_bm25_weight=(
2456
+ form_data.hybrid_bm25_weight
2457
+ if form_data.hybrid_bm25_weight
2458
+ else request.app.state.config.HYBRID_BM25_WEIGHT
2459
+ ),
2460
+ enable_enriched_texts=(
2461
+ form_data.enable_enriched_texts
2462
+ if form_data.enable_enriched_texts is not None
2463
+ else request.app.state.config.ENABLE_RAG_HYBRID_SEARCH_ENRICHED_TEXTS
2464
+ ),
2465
+ )
2466
+ else:
2467
+ return await query_collection(
2468
+ request,
2469
+ collection_names=form_data.collection_names,
2470
+ queries=[form_data.query],
2471
+ embedding_function=lambda query, prefix: request.app.state.EMBEDDING_FUNCTION(
2472
+ query, prefix=prefix, user=user
2473
+ ),
2474
+ k=form_data.k if form_data.k else request.app.state.config.TOP_K,
2475
+ )
2476
+
2477
+ except Exception as e:
2478
+ log.exception(e)
2479
+ raise HTTPException(
2480
+ status_code=status.HTTP_400_BAD_REQUEST,
2481
+ detail=ERROR_MESSAGES.DEFAULT(e),
2482
+ )
2483
+
2484
+
2485
+ ####################################
2486
+ #
2487
+ # Vector DB operations
2488
+ #
2489
+ ####################################
2490
+
2491
+
2492
+ class DeleteForm(BaseModel):
2493
+ collection_name: str
2494
+ file_id: str
2495
+
2496
+
2497
+ @router.post('/delete')
2498
+ async def delete_entries_from_collection(
2499
+ form_data: DeleteForm,
2500
+ user=Depends(get_admin_user),
2501
+ db: AsyncSession = Depends(get_async_session),
2502
+ ):
2503
+ try:
2504
+ if await ASYNC_VECTOR_DB_CLIENT.has_collection(collection_name=form_data.collection_name):
2505
+ file = await Files.get_file_by_id(form_data.file_id, db=db)
2506
+ if not file:
2507
+ raise HTTPException(
2508
+ status_code=status.HTTP_404_NOT_FOUND,
2509
+ detail=ERROR_MESSAGES.NOT_FOUND,
2510
+ )
2511
+ hash = file.hash
2512
+
2513
+ # Refuse to issue a `filter={'hash': None}` query — the
2514
+ # match semantics of a null filter value are
2515
+ # backend-dependent (some backends ignore the key, some
2516
+ # match every row whose metadata lacks `hash`) and risk
2517
+ # deleting unrelated entries. Files without a hash are
2518
+ # typically unprocessed / failed / legacy records that
2519
+ # can't be targeted by hash anyway.
2520
+ if hash is None:
2521
+ raise HTTPException(
2522
+ status_code=status.HTTP_400_BAD_REQUEST,
2523
+ detail=ERROR_MESSAGES.DEFAULT('File has no hash; cannot delete vector entries by hash.'),
2524
+ )
2525
+
2526
+ # Pre-existing bug: this used `metadata=` which is not a
2527
+ # parameter on `VectorDBBase.delete` nor on any backend
2528
+ # implementation, so the call always raised TypeError that
2529
+ # was silently swallowed by the surrounding `except
2530
+ # Exception` and the endpoint reported `{'status': False}`
2531
+ # for every request. Use `filter` to actually do what the
2532
+ # endpoint name promises.
2533
+ await ASYNC_VECTOR_DB_CLIENT.delete(
2534
+ collection_name=form_data.collection_name,
2535
+ filter={'hash': hash},
2536
+ )
2537
+ return {'status': True}
2538
+ else:
2539
+ return {'status': False}
2540
+ except HTTPException:
2541
+ # Caller-meaningful errors (404/400 above) must not be
2542
+ # swallowed and re-shaped as `{'status': False}`.
2543
+ raise
2544
+ except Exception as e:
2545
+ log.exception(e)
2546
+ return {'status': False}
2547
+
2548
+
2549
+ @router.post('/reset/db')
2550
+ async def reset_vector_db(user=Depends(get_admin_user), db: AsyncSession = Depends(get_async_session)):
2551
+ await ASYNC_VECTOR_DB_CLIENT.reset()
2552
+ await Knowledges.delete_all_knowledge(db=db)
2553
+
2554
+
2555
+ @router.post('/reset/uploads')
2556
+ async def reset_upload_dir(user=Depends(get_admin_user)) -> bool:
2557
+ folder = f'{UPLOAD_DIR}'
2558
+ try:
2559
+ # Check if the directory exists
2560
+ if os.path.exists(folder):
2561
+ # Iterate over all the files and directories in the specified directory
2562
+ for filename in os.listdir(folder):
2563
+ file_path = os.path.join(folder, filename)
2564
+ try:
2565
+ if os.path.isfile(file_path) or os.path.islink(file_path):
2566
+ os.unlink(file_path) # Remove the file or link
2567
+ elif os.path.isdir(file_path):
2568
+ shutil.rmtree(file_path) # Remove the directory
2569
+ except Exception as e:
2570
+ log.exception(f'Failed to delete {file_path}. Reason: {e}')
2571
+ else:
2572
+ log.warning(f'The directory {folder} does not exist')
2573
+ except Exception as e:
2574
+ log.exception(f'Failed to process the directory {folder}. Reason: {e}')
2575
+ return True
2576
+
2577
+
2578
+ if ENV == 'dev':
2579
+
2580
+ @router.get('/ef/{text}')
2581
+ async def get_embeddings(request: Request, text: Optional[str] = 'Hello World!'):
2582
+ return {'result': await request.app.state.EMBEDDING_FUNCTION(text, prefix=RAG_EMBEDDING_QUERY_PREFIX)}
2583
+
2584
+
2585
+ class BatchProcessFilesForm(BaseModel):
2586
+ files: List[FileModel]
2587
+ collection_name: str
2588
+
2589
+
2590
+ class BatchProcessFilesResult(BaseModel):
2591
+ file_id: str
2592
+ status: str
2593
+ error: Optional[str] = None
2594
+
2595
+
2596
+ class BatchProcessFilesResponse(BaseModel):
2597
+ results: List[BatchProcessFilesResult]
2598
+ errors: List[BatchProcessFilesResult]
2599
+
2600
+
2601
+ @router.post('/process/files/batch')
2602
+ async def process_files_batch(
2603
+ request: Request,
2604
+ form_data: BatchProcessFilesForm,
2605
+ user=Depends(get_verified_user),
2606
+ db=None,
2607
+ ) -> BatchProcessFilesResponse:
2608
+ """
2609
+ Process a batch of files and save them to the vector database.
2610
+
2611
+ NOTE: We intentionally do NOT use Depends(get_async_session) here.
2612
+ The save_docs_to_vector_db() call makes external embedding API calls which
2613
+ can take 5-60+ seconds for batch operations. Database operations after
2614
+ embedding (Files.update_file_by_id) manage their own short-lived sessions.
2615
+ """
2616
+
2617
+ collection_name = form_data.collection_name
2618
+
2619
+ file_results: List[BatchProcessFilesResult] = []
2620
+ file_errors: List[BatchProcessFilesResult] = []
2621
+ file_updates: List[FileUpdateForm] = []
2622
+
2623
+ # Prepare all documents first
2624
+ all_docs: List[Document] = []
2625
+
2626
+ for file in form_data.files:
2627
+ try:
2628
+ # Ownership check: verify the requesting user owns the file or is an admin
2629
+ db_file = await Files.get_file_by_id(file.id, db=db)
2630
+ if not db_file:
2631
+ file_errors.append(
2632
+ BatchProcessFilesResult(
2633
+ file_id=file.id,
2634
+ status='failed',
2635
+ error='File not found',
2636
+ )
2637
+ )
2638
+ continue
2639
+ if db_file.user_id != user.id and user.role != 'admin':
2640
+ file_errors.append(
2641
+ BatchProcessFilesResult(
2642
+ file_id=file.id,
2643
+ status='failed',
2644
+ error='Permission denied: not file owner',
2645
+ )
2646
+ )
2647
+ continue
2648
+
2649
+ text_content = file.data.get('content', '')
2650
+ docs: List[Document] = [
2651
+ Document(
2652
+ page_content=text_content.replace('<br/>', '\n'),
2653
+ metadata={
2654
+ **file.meta,
2655
+ 'name': file.filename,
2656
+ 'created_by': file.user_id,
2657
+ 'file_id': file.id,
2658
+ 'source': file.filename,
2659
+ },
2660
+ )
2661
+ ]
2662
+
2663
+ all_docs.extend(docs)
2664
+
2665
+ file_updates.append(
2666
+ FileUpdateForm(
2667
+ hash=calculate_sha256_string(text_content),
2668
+ data={'content': text_content},
2669
+ )
2670
+ )
2671
+ file_results.append(BatchProcessFilesResult(file_id=file.id, status='prepared'))
2672
+
2673
+ except Exception as e:
2674
+ log.error(f'process_files_batch: Error processing file {file.id}: {str(e)}')
2675
+ file_errors.append(BatchProcessFilesResult(file_id=file.id, status='failed', error=str(e)))
2676
+
2677
+ # Save all documents in one batch
2678
+ if all_docs:
2679
+ try:
2680
+ await run_in_threadpool(
2681
+ save_docs_to_vector_db,
2682
+ request,
2683
+ all_docs,
2684
+ collection_name,
2685
+ add=True,
2686
+ user=user,
2687
+ )
2688
+
2689
+ # Update all files with collection name
2690
+ for file_update, file_result in zip(file_updates, file_results):
2691
+ await Files.update_file_by_id(id=file_result.file_id, form_data=file_update, db=db)
2692
+ file_result.status = 'completed'
2693
+
2694
+ except Exception as e:
2695
+ log.error(f'process_files_batch: Error saving documents to vector DB: {str(e)}')
2696
+ for file_result in file_results:
2697
+ file_result.status = 'failed'
2698
+ file_errors.append(BatchProcessFilesResult(file_id=file_result.file_id, status='failed', error=str(e)))
2699
+
2700
+ return BatchProcessFilesResponse(results=file_results, errors=file_errors)