@nocobase/plugin-ai 2.1.6 → 2.1.8

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 (583) hide show
  1. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/dev/external-knowledge-base.md +318 -0
  2. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/documents.md +76 -0
  3. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/hit-tests.md +66 -0
  4. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/index.md +73 -0
  5. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/segments.md +93 -0
  6. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/settings.md +77 -0
  7. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/rag.md +1 -1
  8. package/dist/ai/docs/nocobase/ai-employees/workflow/nodes/knowledge/create-document.md +79 -0
  9. package/dist/ai/docs/nocobase/ai-employees/workflow/nodes/knowledge/delete-document.md +71 -0
  10. package/dist/ai/docs/nocobase/ai-employees/workflow/nodes/knowledge/index.md +84 -0
  11. package/dist/ai/docs/nocobase/ai-employees/workflow/nodes/knowledge/retrieve-document.md +87 -0
  12. package/dist/ai/docs/nocobase/ai-employees/workflow/nodes/knowledge/update-document.md +70 -0
  13. package/dist/ai/docs/nocobase/development/index.md +3 -0
  14. package/dist/ai/docs/nocobase/get-started/deployment/how-to-deploy-nocobase-faster.mdx +2 -2
  15. package/dist/ai/docs/nocobase/ops-management/backup-manager/index.mdx +9 -7
  16. package/dist/ai/docs/nocobase/ops-management/migration-manager/built-in-tables.md +423 -0
  17. package/dist/ai/docs/nocobase/ops-management/migration-manager/index.md +12 -9
  18. package/dist/ai/docs/nocobase/ops-management/release-management/index.md +111 -24
  19. package/dist/client/ai-employees/ProfileCard.d.ts +1 -0
  20. package/dist/client/ai-employees/chatbox/hooks/useChatMessageActions.d.ts +2 -3
  21. package/dist/client/ai-employees/form-filler/tools/index.d.ts +8 -0
  22. package/dist/client/index.js +3 -3
  23. package/dist/externalVersion.js +21 -21
  24. package/dist/node_modules/@langchain/xai/dist/chat_models/completions.cjs +25 -34
  25. package/dist/node_modules/@langchain/xai/dist/chat_models/completions.d.cts +10 -22
  26. package/dist/node_modules/@langchain/xai/dist/chat_models/completions.d.ts +10 -22
  27. package/dist/node_modules/@langchain/xai/dist/chat_models/completions.js +17 -25
  28. package/dist/node_modules/@langchain/xai/dist/chat_models/index.cjs +2 -2
  29. package/dist/node_modules/@langchain/xai/dist/chat_models/index.d.cts +3 -0
  30. package/dist/node_modules/@langchain/xai/dist/chat_models/index.js +3 -2
  31. package/dist/node_modules/@langchain/xai/dist/chat_models/responses-types.d.cts +5 -12
  32. package/dist/node_modules/@langchain/xai/dist/chat_models/responses-types.d.ts +5 -12
  33. package/dist/node_modules/@langchain/xai/dist/chat_models/responses.cjs +18 -19
  34. package/dist/node_modules/@langchain/xai/dist/chat_models/responses.d.cts +1 -1
  35. package/dist/node_modules/@langchain/xai/dist/chat_models/responses.d.ts +1 -1
  36. package/dist/node_modules/@langchain/xai/dist/chat_models/responses.js +13 -13
  37. package/dist/node_modules/@langchain/xai/dist/converters/responses.cjs +16 -22
  38. package/dist/node_modules/@langchain/xai/dist/converters/responses.js +7 -12
  39. package/dist/node_modules/@langchain/xai/dist/index.cjs +2 -2
  40. package/dist/node_modules/@langchain/xai/dist/index.d.ts +0 -1
  41. package/dist/node_modules/@langchain/xai/dist/index.js +1 -2
  42. package/dist/node_modules/@langchain/xai/dist/live_search.cjs +4 -5
  43. package/dist/node_modules/@langchain/xai/dist/live_search.js +4 -4
  44. package/dist/node_modules/@langchain/xai/dist/profiles.cjs +81 -97
  45. package/dist/node_modules/@langchain/xai/dist/profiles.js +81 -96
  46. package/dist/node_modules/@langchain/xai/dist/tools/code_execution.cjs +1 -2
  47. package/dist/node_modules/@langchain/xai/dist/tools/code_execution.js +1 -1
  48. package/dist/node_modules/@langchain/xai/dist/tools/collections_search.cjs +1 -2
  49. package/dist/node_modules/@langchain/xai/dist/tools/collections_search.js +1 -1
  50. package/dist/node_modules/@langchain/xai/dist/tools/index.cjs +6 -7
  51. package/dist/node_modules/@langchain/xai/dist/tools/index.d.cts +1 -2
  52. package/dist/node_modules/@langchain/xai/dist/tools/index.d.ts +1 -2
  53. package/dist/node_modules/@langchain/xai/dist/tools/index.js +6 -7
  54. package/dist/node_modules/@langchain/xai/dist/tools/live_search.cjs +3 -7
  55. package/dist/node_modules/@langchain/xai/dist/tools/live_search.d.cts +1 -2
  56. package/dist/node_modules/@langchain/xai/dist/tools/live_search.d.ts +1 -2
  57. package/dist/node_modules/@langchain/xai/dist/tools/live_search.js +3 -6
  58. package/dist/node_modules/@langchain/xai/dist/tools/web_search.cjs +1 -2
  59. package/dist/node_modules/@langchain/xai/dist/tools/web_search.js +1 -1
  60. package/dist/node_modules/@langchain/xai/dist/tools/x_search.cjs +1 -2
  61. package/dist/node_modules/@langchain/xai/dist/tools/x_search.js +1 -1
  62. package/dist/node_modules/@langchain/xai/package.json +1 -1
  63. package/dist/node_modules/fs-extra/package.json +1 -1
  64. package/dist/node_modules/jsonrepair/package.json +1 -1
  65. package/dist/node_modules/just-bash/package.json +1 -1
  66. package/dist/node_modules/nodejs-snowflake/package.json +1 -1
  67. package/dist/node_modules/openai/_vendor/zod-to-json-schema/parsers/branded.d.mts +1 -1
  68. package/dist/node_modules/openai/_vendor/zod-to-json-schema/parsers/branded.d.ts +1 -1
  69. package/dist/node_modules/openai/_vendor/zod-to-json-schema/parsers/catch.d.mts +1 -1
  70. package/dist/node_modules/openai/_vendor/zod-to-json-schema/parsers/catch.d.ts +1 -1
  71. package/dist/node_modules/openai/_vendor/zod-to-json-schema/parsers/readonly.d.mts +1 -1
  72. package/dist/node_modules/openai/_vendor/zod-to-json-schema/parsers/readonly.d.ts +1 -1
  73. package/dist/node_modules/openai/api-promise.d.mts +1 -0
  74. package/dist/node_modules/openai/api-promise.d.ts +1 -0
  75. package/dist/node_modules/openai/auth/index.d.mts +4 -0
  76. package/dist/node_modules/openai/auth/index.d.ts +4 -0
  77. package/dist/node_modules/openai/auth/index.js +11 -0
  78. package/dist/node_modules/openai/auth/subject-token-providers.d.mts +20 -0
  79. package/dist/node_modules/openai/auth/subject-token-providers.d.ts +20 -0
  80. package/dist/node_modules/openai/auth/subject-token-providers.js +127 -0
  81. package/dist/node_modules/openai/auth/types.d.mts +23 -0
  82. package/dist/node_modules/openai/auth/types.d.ts +23 -0
  83. package/dist/node_modules/openai/auth/types.js +3 -0
  84. package/dist/node_modules/openai/auth/workload-identity-auth.d.mts +16 -0
  85. package/dist/node_modules/openai/auth/workload-identity-auth.d.ts +16 -0
  86. package/dist/node_modules/openai/auth/workload-identity-auth.js +95 -0
  87. package/dist/node_modules/openai/azure.d.mts +6 -2
  88. package/dist/node_modules/openai/azure.d.ts +6 -2
  89. package/dist/node_modules/openai/azure.js +4 -3
  90. package/dist/node_modules/openai/beta/realtime/websocket.js +7 -2
  91. package/dist/node_modules/openai/beta/realtime/ws.js +5 -1
  92. package/dist/node_modules/openai/bin/migration-config.json +1120 -0
  93. package/dist/node_modules/openai/client.d.mts +72 -10
  94. package/dist/node_modules/openai/client.d.ts +72 -10
  95. package/dist/node_modules/openai/client.js +207 -28
  96. package/dist/node_modules/openai/core/EventEmitter.d.mts +56 -0
  97. package/dist/node_modules/openai/core/EventEmitter.d.ts +56 -0
  98. package/dist/node_modules/openai/core/EventEmitter.js +93 -0
  99. package/dist/node_modules/openai/core/error.d.mts +15 -0
  100. package/dist/node_modules/openai/core/error.d.ts +15 -0
  101. package/dist/node_modules/openai/core/error.js +34 -1
  102. package/dist/node_modules/openai/core/pagination.d.mts +18 -0
  103. package/dist/node_modules/openai/core/pagination.d.ts +18 -0
  104. package/dist/node_modules/openai/core/pagination.js +32 -1
  105. package/dist/node_modules/openai/core/streaming.d.mts +1 -1
  106. package/dist/node_modules/openai/core/streaming.d.ts +1 -1
  107. package/dist/node_modules/openai/core/streaming.js +2 -2
  108. package/dist/node_modules/openai/error.d.mts +1 -0
  109. package/dist/node_modules/openai/error.d.ts +1 -0
  110. package/dist/node_modules/openai/index.d.mts +1 -1
  111. package/dist/node_modules/openai/index.d.ts +1 -1
  112. package/dist/node_modules/openai/index.js +1 -1
  113. package/dist/node_modules/openai/internal/parse.js +2 -2
  114. package/dist/node_modules/openai/internal/qs/index.d.mts +2 -2
  115. package/dist/node_modules/openai/internal/qs/index.d.ts +2 -2
  116. package/dist/node_modules/openai/internal/request-options.d.mts +5 -0
  117. package/dist/node_modules/openai/internal/request-options.d.ts +5 -0
  118. package/dist/node_modules/openai/internal/shims.d.mts +6 -0
  119. package/dist/node_modules/openai/internal/shims.d.ts +6 -0
  120. package/dist/node_modules/openai/internal/types.d.mts +17 -11
  121. package/dist/node_modules/openai/internal/types.d.ts +17 -11
  122. package/dist/node_modules/openai/internal/utils/env.js +2 -2
  123. package/dist/node_modules/openai/internal/utils/log.js +2 -0
  124. package/dist/node_modules/openai/internal/utils/query.d.mts +2 -0
  125. package/dist/node_modules/openai/internal/utils/query.d.ts +2 -0
  126. package/dist/node_modules/openai/internal/utils/query.js +10 -0
  127. package/dist/node_modules/openai/internal/utils.d.mts +1 -0
  128. package/dist/node_modules/openai/internal/utils.d.ts +1 -0
  129. package/dist/node_modules/openai/internal/utils.js +1 -0
  130. package/dist/node_modules/openai/internal/ws-adapter-browser.d.mts +34 -0
  131. package/dist/node_modules/openai/internal/ws-adapter-browser.d.ts +34 -0
  132. package/dist/node_modules/openai/internal/ws-adapter-browser.js +88 -0
  133. package/dist/node_modules/openai/internal/ws-adapter-node.d.mts +27 -0
  134. package/dist/node_modules/openai/internal/ws-adapter-node.d.ts +27 -0
  135. package/dist/node_modules/openai/internal/ws-adapter-node.js +90 -0
  136. package/dist/node_modules/openai/internal/ws-adapter.d.mts +24 -0
  137. package/dist/node_modules/openai/internal/ws-adapter.d.ts +24 -0
  138. package/dist/node_modules/openai/internal/ws-adapter.js +11 -0
  139. package/dist/node_modules/openai/internal/ws.d.mts +80 -0
  140. package/dist/node_modules/openai/internal/ws.d.ts +80 -0
  141. package/dist/node_modules/openai/internal/ws.js +153 -0
  142. package/dist/node_modules/openai/package.json +1 -1
  143. package/dist/node_modules/openai/pagination.d.mts +1 -0
  144. package/dist/node_modules/openai/pagination.d.ts +1 -0
  145. package/dist/node_modules/openai/realtime/websocket.js +7 -2
  146. package/dist/node_modules/openai/realtime/ws.js +5 -1
  147. package/dist/node_modules/openai/resource.d.mts +1 -0
  148. package/dist/node_modules/openai/resource.d.ts +1 -0
  149. package/dist/node_modules/openai/resources/admin/admin.d.mts +10 -0
  150. package/dist/node_modules/openai/resources/admin/admin.d.ts +10 -0
  151. package/dist/node_modules/openai/resources/admin/admin.js +17 -0
  152. package/dist/node_modules/openai/resources/admin/index.d.mts +3 -0
  153. package/dist/node_modules/openai/resources/admin/index.d.ts +3 -0
  154. package/dist/node_modules/openai/resources/admin/index.js +9 -0
  155. package/dist/node_modules/openai/resources/admin/organization/admin-api-keys.d.mts +140 -0
  156. package/dist/node_modules/openai/resources/admin/organization/admin-api-keys.d.ts +140 -0
  157. package/dist/node_modules/openai/resources/admin/organization/admin-api-keys.js +81 -0
  158. package/dist/node_modules/openai/resources/admin/organization/audit-logs.d.mts +1267 -0
  159. package/dist/node_modules/openai/resources/admin/organization/audit-logs.d.ts +1267 -0
  160. package/dist/node_modules/openai/resources/admin/organization/audit-logs.js +31 -0
  161. package/dist/node_modules/openai/resources/admin/organization/certificates.d.mts +322 -0
  162. package/dist/node_modules/openai/resources/admin/organization/certificates.d.ts +322 -0
  163. package/dist/node_modules/openai/resources/admin/organization/certificates.js +144 -0
  164. package/dist/node_modules/openai/resources/admin/organization/data-retention.d.mts +50 -0
  165. package/dist/node_modules/openai/resources/admin/organization/data-retention.d.ts +50 -0
  166. package/dist/node_modules/openai/resources/admin/organization/data-retention.js +42 -0
  167. package/dist/node_modules/openai/resources/admin/organization/groups/groups.d.mts +160 -0
  168. package/dist/node_modules/openai/resources/admin/organization/groups/groups.d.ts +160 -0
  169. package/dist/node_modules/openai/resources/admin/organization/groups/groups.js +109 -0
  170. package/dist/node_modules/openai/resources/admin/organization/groups/index.d.mts +4 -0
  171. package/dist/node_modules/openai/resources/admin/organization/groups/index.d.ts +4 -0
  172. package/dist/node_modules/openai/resources/admin/organization/groups/index.js +11 -0
  173. package/dist/node_modules/openai/resources/admin/organization/groups/roles.d.mts +275 -0
  174. package/dist/node_modules/openai/resources/admin/organization/groups/roles.d.ts +275 -0
  175. package/dist/node_modules/openai/resources/admin/organization/groups/roles.js +84 -0
  176. package/dist/node_modules/openai/resources/admin/organization/groups/users.d.mts +164 -0
  177. package/dist/node_modules/openai/resources/admin/organization/groups/users.d.ts +164 -0
  178. package/dist/node_modules/openai/resources/admin/organization/groups/users.js +84 -0
  179. package/dist/node_modules/openai/resources/admin/organization/groups.d.mts +2 -0
  180. package/dist/node_modules/openai/resources/admin/organization/groups.d.ts +2 -0
  181. package/dist/node_modules/openai/resources/admin/organization/groups.js +6 -0
  182. package/dist/node_modules/openai/resources/admin/organization/index.d.mts +13 -0
  183. package/dist/node_modules/openai/resources/admin/organization/index.d.ts +13 -0
  184. package/dist/node_modules/openai/resources/admin/organization/index.js +29 -0
  185. package/dist/node_modules/openai/resources/admin/organization/invites.d.mts +153 -0
  186. package/dist/node_modules/openai/resources/admin/organization/invites.d.ts +153 -0
  187. package/dist/node_modules/openai/resources/admin/organization/invites.js +83 -0
  188. package/dist/node_modules/openai/resources/admin/organization/organization.d.mts +50 -0
  189. package/dist/node_modules/openai/resources/admin/organization/organization.d.ts +50 -0
  190. package/dist/node_modules/openai/resources/admin/organization/organization.js +57 -0
  191. package/dist/node_modules/openai/resources/admin/organization/projects/api-keys.d.mts +167 -0
  192. package/dist/node_modules/openai/resources/admin/organization/projects/api-keys.d.ts +167 -0
  193. package/dist/node_modules/openai/resources/admin/organization/projects/api-keys.js +68 -0
  194. package/dist/node_modules/openai/resources/admin/organization/projects/certificates.d.mts +186 -0
  195. package/dist/node_modules/openai/resources/admin/organization/projects/certificates.d.ts +186 -0
  196. package/dist/node_modules/openai/resources/admin/organization/projects/certificates.js +64 -0
  197. package/dist/node_modules/openai/resources/admin/organization/projects/data-retention.d.mts +53 -0
  198. package/dist/node_modules/openai/resources/admin/organization/projects/data-retention.d.ts +53 -0
  199. package/dist/node_modules/openai/resources/admin/organization/projects/data-retention.js +46 -0
  200. package/dist/node_modules/openai/resources/admin/organization/projects/groups/groups.d.mts +142 -0
  201. package/dist/node_modules/openai/resources/admin/organization/projects/groups/groups.d.ts +142 -0
  202. package/dist/node_modules/openai/resources/admin/organization/projects/groups/groups.js +93 -0
  203. package/dist/node_modules/openai/resources/admin/organization/projects/groups/index.d.mts +3 -0
  204. package/dist/node_modules/openai/resources/admin/organization/projects/groups/index.d.ts +3 -0
  205. package/dist/node_modules/openai/resources/admin/organization/projects/groups/index.js +9 -0
  206. package/dist/node_modules/openai/resources/admin/organization/projects/groups/roles.d.mts +292 -0
  207. package/dist/node_modules/openai/resources/admin/organization/projects/groups/roles.d.ts +292 -0
  208. package/dist/node_modules/openai/resources/admin/organization/projects/groups/roles.js +87 -0
  209. package/dist/node_modules/openai/resources/admin/organization/projects/groups.d.mts +2 -0
  210. package/dist/node_modules/openai/resources/admin/organization/projects/groups.d.ts +2 -0
  211. package/dist/node_modules/openai/resources/admin/organization/projects/groups.js +6 -0
  212. package/dist/node_modules/openai/resources/admin/organization/projects/hosted-tool-permissions.d.mts +174 -0
  213. package/dist/node_modules/openai/resources/admin/organization/projects/hosted-tool-permissions.d.ts +174 -0
  214. package/dist/node_modules/openai/resources/admin/organization/projects/hosted-tool-permissions.js +45 -0
  215. package/dist/node_modules/openai/resources/admin/organization/projects/index.d.mts +13 -0
  216. package/dist/node_modules/openai/resources/admin/organization/projects/index.d.ts +13 -0
  217. package/dist/node_modules/openai/resources/admin/organization/projects/index.js +29 -0
  218. package/dist/node_modules/openai/resources/admin/organization/projects/model-permissions.d.mts +86 -0
  219. package/dist/node_modules/openai/resources/admin/organization/projects/model-permissions.d.ts +86 -0
  220. package/dist/node_modules/openai/resources/admin/organization/projects/model-permissions.js +63 -0
  221. package/dist/node_modules/openai/resources/admin/organization/projects/projects.d.mts +188 -0
  222. package/dist/node_modules/openai/resources/admin/organization/projects/projects.d.ts +188 -0
  223. package/dist/node_modules/openai/resources/admin/organization/projects/projects.js +149 -0
  224. package/dist/node_modules/openai/resources/admin/organization/projects/rate-limits.d.mts +120 -0
  225. package/dist/node_modules/openai/resources/admin/organization/projects/rate-limits.d.ts +120 -0
  226. package/dist/node_modules/openai/resources/admin/organization/projects/rate-limits.js +47 -0
  227. package/dist/node_modules/openai/resources/admin/organization/projects/roles.d.mts +146 -0
  228. package/dist/node_modules/openai/resources/admin/organization/projects/roles.d.ts +146 -0
  229. package/dist/node_modules/openai/resources/admin/organization/projects/roles.js +108 -0
  230. package/dist/node_modules/openai/resources/admin/organization/projects/service-accounts.d.mts +168 -0
  231. package/dist/node_modules/openai/resources/admin/organization/projects/service-accounts.d.ts +168 -0
  232. package/dist/node_modules/openai/resources/admin/organization/projects/service-accounts.js +101 -0
  233. package/dist/node_modules/openai/resources/admin/organization/projects/spend-alerts.d.mts +241 -0
  234. package/dist/node_modules/openai/resources/admin/organization/projects/spend-alerts.d.ts +241 -0
  235. package/dist/node_modules/openai/resources/admin/organization/projects/spend-alerts.js +102 -0
  236. package/dist/node_modules/openai/resources/admin/organization/projects/users/index.d.mts +3 -0
  237. package/dist/node_modules/openai/resources/admin/organization/projects/users/index.d.ts +3 -0
  238. package/dist/node_modules/openai/resources/admin/organization/projects/users/index.js +9 -0
  239. package/dist/node_modules/openai/resources/admin/organization/projects/users/roles.d.mts +266 -0
  240. package/dist/node_modules/openai/resources/admin/organization/projects/users/roles.d.ts +266 -0
  241. package/dist/node_modules/openai/resources/admin/organization/projects/users/roles.js +87 -0
  242. package/dist/node_modules/openai/resources/admin/organization/projects/users/users.d.mts +157 -0
  243. package/dist/node_modules/openai/resources/admin/organization/projects/users/users.d.ts +157 -0
  244. package/dist/node_modules/openai/resources/admin/organization/projects/users/users.js +116 -0
  245. package/dist/node_modules/openai/resources/admin/organization/projects/users.d.mts +2 -0
  246. package/dist/node_modules/openai/resources/admin/organization/projects/users.d.ts +2 -0
  247. package/dist/node_modules/openai/resources/admin/organization/projects/users.js +6 -0
  248. package/dist/node_modules/openai/resources/admin/organization/projects.d.mts +2 -0
  249. package/dist/node_modules/openai/resources/admin/organization/projects.d.ts +2 -0
  250. package/dist/node_modules/openai/resources/admin/organization/projects.js +6 -0
  251. package/dist/node_modules/openai/resources/admin/organization/roles.d.mts +153 -0
  252. package/dist/node_modules/openai/resources/admin/organization/roles.d.ts +153 -0
  253. package/dist/node_modules/openai/resources/admin/organization/roles.js +96 -0
  254. package/dist/node_modules/openai/resources/admin/organization/spend-alerts.d.mts +224 -0
  255. package/dist/node_modules/openai/resources/admin/organization/spend-alerts.d.ts +224 -0
  256. package/dist/node_modules/openai/resources/admin/organization/spend-alerts.js +93 -0
  257. package/dist/node_modules/openai/resources/admin/organization/usage.d.mts +5123 -0
  258. package/dist/node_modules/openai/resources/admin/organization/usage.d.ts +5123 -0
  259. package/dist/node_modules/openai/resources/admin/organization/usage.js +207 -0
  260. package/dist/node_modules/openai/resources/admin/organization/users/index.d.mts +3 -0
  261. package/dist/node_modules/openai/resources/admin/organization/users/index.d.ts +3 -0
  262. package/dist/node_modules/openai/resources/admin/organization/users/index.js +9 -0
  263. package/dist/node_modules/openai/resources/admin/organization/users/roles.d.mts +249 -0
  264. package/dist/node_modules/openai/resources/admin/organization/users/roles.d.ts +249 -0
  265. package/dist/node_modules/openai/resources/admin/organization/users/roles.js +84 -0
  266. package/dist/node_modules/openai/resources/admin/organization/users/users.d.mts +185 -0
  267. package/dist/node_modules/openai/resources/admin/organization/users/users.d.ts +185 -0
  268. package/dist/node_modules/openai/resources/admin/organization/users/users.js +84 -0
  269. package/dist/node_modules/openai/resources/admin/organization/users.d.mts +2 -0
  270. package/dist/node_modules/openai/resources/admin/organization/users.d.ts +2 -0
  271. package/dist/node_modules/openai/resources/admin/organization/users.js +6 -0
  272. package/dist/node_modules/openai/resources/admin/organization.d.mts +2 -0
  273. package/dist/node_modules/openai/resources/admin/organization.d.ts +2 -0
  274. package/dist/node_modules/openai/resources/admin/organization.js +6 -0
  275. package/dist/node_modules/openai/resources/admin.d.mts +2 -0
  276. package/dist/node_modules/openai/resources/admin.d.ts +2 -0
  277. package/dist/node_modules/openai/resources/admin.js +6 -0
  278. package/dist/node_modules/openai/resources/audio/speech.d.mts +22 -5
  279. package/dist/node_modules/openai/resources/audio/speech.d.ts +22 -5
  280. package/dist/node_modules/openai/resources/audio/speech.js +8 -2
  281. package/dist/node_modules/openai/resources/audio/transcriptions.d.mts +6 -0
  282. package/dist/node_modules/openai/resources/audio/transcriptions.d.ts +6 -0
  283. package/dist/node_modules/openai/resources/audio/transcriptions.js +4 -0
  284. package/dist/node_modules/openai/resources/audio/translations.d.mts +3 -0
  285. package/dist/node_modules/openai/resources/audio/translations.d.ts +3 -0
  286. package/dist/node_modules/openai/resources/audio/translations.js +4 -1
  287. package/dist/node_modules/openai/resources/batches.d.mts +8 -4
  288. package/dist/node_modules/openai/resources/batches.d.ts +8 -4
  289. package/dist/node_modules/openai/resources/batches.js +14 -4
  290. package/dist/node_modules/openai/resources/beta/assistants.d.mts +6 -2
  291. package/dist/node_modules/openai/resources/beta/assistants.d.ts +6 -2
  292. package/dist/node_modules/openai/resources/beta/assistants.js +8 -0
  293. package/dist/node_modules/openai/resources/beta/chatkit/sessions.d.mts +4 -2
  294. package/dist/node_modules/openai/resources/beta/chatkit/sessions.d.ts +4 -2
  295. package/dist/node_modules/openai/resources/beta/chatkit/sessions.js +6 -2
  296. package/dist/node_modules/openai/resources/beta/chatkit/threads.d.mts +4 -4
  297. package/dist/node_modules/openai/resources/beta/chatkit/threads.d.ts +4 -4
  298. package/dist/node_modules/openai/resources/beta/chatkit/threads.js +13 -5
  299. package/dist/node_modules/openai/resources/beta/realtime/sessions.js +1 -0
  300. package/dist/node_modules/openai/resources/beta/realtime/transcription-sessions.js +1 -0
  301. package/dist/node_modules/openai/resources/beta/threads/messages.d.mts +2 -0
  302. package/dist/node_modules/openai/resources/beta/threads/messages.d.ts +2 -0
  303. package/dist/node_modules/openai/resources/beta/threads/messages.js +7 -0
  304. package/dist/node_modules/openai/resources/beta/threads/runs/runs.d.mts +2 -0
  305. package/dist/node_modules/openai/resources/beta/threads/runs/runs.d.ts +2 -0
  306. package/dist/node_modules/openai/resources/beta/threads/runs/runs.js +10 -0
  307. package/dist/node_modules/openai/resources/beta/threads/runs/steps.d.mts +2 -0
  308. package/dist/node_modules/openai/resources/beta/threads/runs/steps.d.ts +2 -0
  309. package/dist/node_modules/openai/resources/beta/threads/runs/steps.js +4 -0
  310. package/dist/node_modules/openai/resources/beta/threads/threads.d.mts +8 -4
  311. package/dist/node_modules/openai/resources/beta/threads/threads.d.ts +8 -4
  312. package/dist/node_modules/openai/resources/beta/threads/threads.js +8 -0
  313. package/dist/node_modules/openai/resources/chat/completions/completions.d.mts +37 -18
  314. package/dist/node_modules/openai/resources/chat/completions/completions.d.ts +37 -18
  315. package/dist/node_modules/openai/resources/chat/completions/completions.js +27 -5
  316. package/dist/node_modules/openai/resources/chat/completions/messages.d.mts +3 -0
  317. package/dist/node_modules/openai/resources/chat/completions/messages.d.ts +3 -0
  318. package/dist/node_modules/openai/resources/chat/completions/messages.js +4 -1
  319. package/dist/node_modules/openai/resources/completions.d.mts +9 -3
  320. package/dist/node_modules/openai/resources/completions.d.ts +9 -3
  321. package/dist/node_modules/openai/resources/completions.js +9 -1
  322. package/dist/node_modules/openai/resources/containers/containers.js +11 -3
  323. package/dist/node_modules/openai/resources/containers/files/content.js +1 -0
  324. package/dist/node_modules/openai/resources/containers/files/files.js +7 -2
  325. package/dist/node_modules/openai/resources/conversations/conversations.d.mts +15 -0
  326. package/dist/node_modules/openai/resources/conversations/conversations.d.ts +15 -0
  327. package/dist/node_modules/openai/resources/conversations/conversations.js +17 -4
  328. package/dist/node_modules/openai/resources/conversations/items.d.mts +4 -1
  329. package/dist/node_modules/openai/resources/conversations/items.d.ts +4 -1
  330. package/dist/node_modules/openai/resources/conversations/items.js +14 -3
  331. package/dist/node_modules/openai/resources/embeddings.d.mts +3 -0
  332. package/dist/node_modules/openai/resources/embeddings.d.ts +3 -0
  333. package/dist/node_modules/openai/resources/embeddings.js +4 -0
  334. package/dist/node_modules/openai/resources/evals/evals.d.mts +3 -0
  335. package/dist/node_modules/openai/resources/evals/evals.d.ts +3 -0
  336. package/dist/node_modules/openai/resources/evals/evals.js +12 -5
  337. package/dist/node_modules/openai/resources/evals/runs/output-items.d.mts +3 -0
  338. package/dist/node_modules/openai/resources/evals/runs/output-items.d.ts +3 -0
  339. package/dist/node_modules/openai/resources/evals/runs/output-items.js +8 -2
  340. package/dist/node_modules/openai/resources/evals/runs/runs.d.mts +3 -0
  341. package/dist/node_modules/openai/resources/evals/runs/runs.d.ts +3 -0
  342. package/dist/node_modules/openai/resources/evals/runs/runs.js +21 -4
  343. package/dist/node_modules/openai/resources/files.d.mts +11 -1
  344. package/dist/node_modules/openai/resources/files.d.ts +11 -1
  345. package/dist/node_modules/openai/resources/files.js +20 -5
  346. package/dist/node_modules/openai/resources/fine-tuning/alpha/graders.d.mts +3 -0
  347. package/dist/node_modules/openai/resources/fine-tuning/alpha/graders.d.ts +3 -0
  348. package/dist/node_modules/openai/resources/fine-tuning/alpha/graders.js +13 -2
  349. package/dist/node_modules/openai/resources/fine-tuning/checkpoints/checkpoints.d.mts +2 -2
  350. package/dist/node_modules/openai/resources/fine-tuning/checkpoints/checkpoints.d.ts +2 -2
  351. package/dist/node_modules/openai/resources/fine-tuning/checkpoints/index.d.mts +1 -1
  352. package/dist/node_modules/openai/resources/fine-tuning/checkpoints/index.d.ts +1 -1
  353. package/dist/node_modules/openai/resources/fine-tuning/checkpoints/permissions.d.mts +54 -7
  354. package/dist/node_modules/openai/resources/fine-tuning/checkpoints/permissions.d.ts +54 -7
  355. package/dist/node_modules/openai/resources/fine-tuning/checkpoints/permissions.js +26 -9
  356. package/dist/node_modules/openai/resources/fine-tuning/jobs/checkpoints.d.mts +3 -0
  357. package/dist/node_modules/openai/resources/fine-tuning/jobs/checkpoints.d.ts +3 -0
  358. package/dist/node_modules/openai/resources/fine-tuning/jobs/checkpoints.js +4 -1
  359. package/dist/node_modules/openai/resources/fine-tuning/jobs/jobs.d.mts +3 -0
  360. package/dist/node_modules/openai/resources/fine-tuning/jobs/jobs.d.ts +3 -0
  361. package/dist/node_modules/openai/resources/fine-tuning/jobs/jobs.js +26 -7
  362. package/dist/node_modules/openai/resources/images.d.mts +56 -24
  363. package/dist/node_modules/openai/resources/images.d.ts +56 -24
  364. package/dist/node_modules/openai/resources/images.js +11 -3
  365. package/dist/node_modules/openai/resources/index.d.mts +2 -1
  366. package/dist/node_modules/openai/resources/index.d.ts +2 -1
  367. package/dist/node_modules/openai/resources/index.js +3 -1
  368. package/dist/node_modules/openai/resources/models.d.mts +3 -0
  369. package/dist/node_modules/openai/resources/models.d.ts +3 -0
  370. package/dist/node_modules/openai/resources/models.js +6 -3
  371. package/dist/node_modules/openai/resources/moderations.d.mts +3 -0
  372. package/dist/node_modules/openai/resources/moderations.d.ts +3 -0
  373. package/dist/node_modules/openai/resources/moderations.js +4 -1
  374. package/dist/node_modules/openai/resources/realtime/calls.d.mts +13 -3
  375. package/dist/node_modules/openai/resources/realtime/calls.d.ts +13 -3
  376. package/dist/node_modules/openai/resources/realtime/calls.js +4 -0
  377. package/dist/node_modules/openai/resources/realtime/client-secrets.d.mts +45 -39
  378. package/dist/node_modules/openai/resources/realtime/client-secrets.d.ts +45 -39
  379. package/dist/node_modules/openai/resources/realtime/client-secrets.js +19 -1
  380. package/dist/node_modules/openai/resources/realtime/index.d.mts +1 -1
  381. package/dist/node_modules/openai/resources/realtime/index.d.ts +1 -1
  382. package/dist/node_modules/openai/resources/realtime/realtime.d.mts +592 -21
  383. package/dist/node_modules/openai/resources/realtime/realtime.d.ts +592 -21
  384. package/dist/node_modules/openai/resources/responses/index.d.mts +2 -0
  385. package/dist/node_modules/openai/resources/responses/index.d.ts +2 -0
  386. package/dist/node_modules/openai/resources/responses/input-items.js +1 -1
  387. package/dist/node_modules/openai/resources/responses/input-tokens.d.mts +4 -1
  388. package/dist/node_modules/openai/resources/responses/input-tokens.d.ts +4 -1
  389. package/dist/node_modules/openai/resources/responses/input-tokens.js +9 -2
  390. package/dist/node_modules/openai/resources/responses/internal-base.d.mts +71 -0
  391. package/dist/node_modules/openai/resources/responses/internal-base.d.ts +71 -0
  392. package/dist/node_modules/openai/resources/responses/internal-base.js +48 -0
  393. package/dist/node_modules/openai/resources/responses/responses.d.mts +956 -64
  394. package/dist/node_modules/openai/resources/responses/responses.d.ts +956 -64
  395. package/dist/node_modules/openai/resources/responses/responses.js +20 -5
  396. package/dist/node_modules/openai/resources/responses/ws-base.d.mts +106 -0
  397. package/dist/node_modules/openai/resources/responses/ws-base.d.ts +106 -0
  398. package/dist/node_modules/openai/resources/responses/ws-base.js +476 -0
  399. package/dist/node_modules/openai/resources/responses/ws.d.mts +13 -0
  400. package/dist/node_modules/openai/resources/responses/ws.d.ts +13 -0
  401. package/dist/node_modules/openai/resources/responses/ws.js +31 -0
  402. package/dist/node_modules/openai/resources/shared.d.mts +3 -2
  403. package/dist/node_modules/openai/resources/shared.d.ts +3 -2
  404. package/dist/node_modules/openai/resources/skills/content.d.mts +1 -1
  405. package/dist/node_modules/openai/resources/skills/content.d.ts +1 -1
  406. package/dist/node_modules/openai/resources/skills/content.js +2 -1
  407. package/dist/node_modules/openai/resources/skills/skills.d.mts +5 -5
  408. package/dist/node_modules/openai/resources/skills/skills.d.ts +5 -5
  409. package/dist/node_modules/openai/resources/skills/skills.js +18 -10
  410. package/dist/node_modules/openai/resources/skills/versions/content.d.mts +1 -1
  411. package/dist/node_modules/openai/resources/skills/versions/content.d.ts +1 -1
  412. package/dist/node_modules/openai/resources/skills/versions/content.js +2 -1
  413. package/dist/node_modules/openai/resources/skills/versions/versions.d.mts +4 -4
  414. package/dist/node_modules/openai/resources/skills/versions/versions.d.ts +4 -4
  415. package/dist/node_modules/openai/resources/skills/versions/versions.js +14 -7
  416. package/dist/node_modules/openai/resources/uploads/parts.d.mts +3 -0
  417. package/dist/node_modules/openai/resources/uploads/parts.d.ts +3 -0
  418. package/dist/node_modules/openai/resources/uploads/parts.js +4 -1
  419. package/dist/node_modules/openai/resources/uploads/uploads.d.mts +10 -1
  420. package/dist/node_modules/openai/resources/uploads/uploads.d.ts +10 -1
  421. package/dist/node_modules/openai/resources/uploads/uploads.js +20 -4
  422. package/dist/node_modules/openai/resources/vector-stores/file-batches.d.mts +9 -3
  423. package/dist/node_modules/openai/resources/vector-stores/file-batches.d.ts +9 -3
  424. package/dist/node_modules/openai/resources/vector-stores/file-batches.js +9 -1
  425. package/dist/node_modules/openai/resources/vector-stores/files.d.mts +3 -1
  426. package/dist/node_modules/openai/resources/vector-stores/files.d.ts +3 -1
  427. package/dist/node_modules/openai/resources/vector-stores/files.js +10 -1
  428. package/dist/node_modules/openai/resources/vector-stores/vector-stores.js +6 -0
  429. package/dist/node_modules/openai/resources/videos.d.mts +123 -11
  430. package/dist/node_modules/openai/resources/videos.d.ts +123 -11
  431. package/dist/node_modules/openai/resources/videos.js +46 -11
  432. package/dist/node_modules/openai/src/auth/index.ts +9 -0
  433. package/dist/node_modules/openai/src/auth/subject-token-providers.ts +185 -0
  434. package/dist/node_modules/openai/src/auth/types.ts +28 -0
  435. package/dist/node_modules/openai/src/auth/workload-identity-auth.ts +122 -0
  436. package/dist/node_modules/openai/src/azure.ts +9 -4
  437. package/dist/node_modules/openai/src/beta/realtime/websocket.ts +7 -2
  438. package/dist/node_modules/openai/src/beta/realtime/ws.ts +5 -1
  439. package/dist/node_modules/openai/src/client.ts +312 -35
  440. package/dist/node_modules/openai/src/core/EventEmitter.ts +114 -0
  441. package/dist/node_modules/openai/src/core/error.ts +40 -0
  442. package/dist/node_modules/openai/src/core/pagination.ts +62 -0
  443. package/dist/node_modules/openai/src/core/streaming.ts +2 -1
  444. package/dist/node_modules/openai/src/index.ts +2 -0
  445. package/dist/node_modules/openai/src/internal/parse.ts +12 -2
  446. package/dist/node_modules/openai/src/internal/request-options.ts +2 -0
  447. package/dist/node_modules/openai/src/internal/types.ts +14 -8
  448. package/dist/node_modules/openai/src/internal/utils/env.ts +2 -2
  449. package/dist/node_modules/openai/src/internal/utils/log.ts +2 -0
  450. package/dist/node_modules/openai/src/internal/utils/query.ts +7 -0
  451. package/dist/node_modules/openai/src/internal/utils.ts +1 -0
  452. package/dist/node_modules/openai/src/internal/ws-adapter-browser.ts +123 -0
  453. package/dist/node_modules/openai/src/internal/ws-adapter-node.ts +105 -0
  454. package/dist/node_modules/openai/src/internal/ws-adapter.ts +30 -0
  455. package/dist/node_modules/openai/src/internal/ws.ts +193 -0
  456. package/dist/node_modules/openai/src/realtime/websocket.ts +7 -2
  457. package/dist/node_modules/openai/src/realtime/ws.ts +5 -1
  458. package/dist/node_modules/openai/src/resources/admin/admin.ts +15 -0
  459. package/dist/node_modules/openai/src/resources/admin/index.ts +4 -0
  460. package/dist/node_modules/openai/src/resources/admin/organization/admin-api-keys.ts +199 -0
  461. package/dist/node_modules/openai/src/resources/admin/organization/audit-logs.ts +1597 -0
  462. package/dist/node_modules/openai/src/resources/admin/organization/certificates.ts +458 -0
  463. package/dist/node_modules/openai/src/resources/admin/organization/data-retention.ts +79 -0
  464. package/dist/node_modules/openai/src/resources/admin/organization/groups/groups.ts +277 -0
  465. package/dist/node_modules/openai/src/resources/admin/organization/groups/index.ts +36 -0
  466. package/dist/node_modules/openai/src/resources/admin/organization/groups/roles.ts +359 -0
  467. package/dist/node_modules/openai/src/resources/admin/organization/groups/users.ts +232 -0
  468. package/dist/node_modules/openai/src/resources/admin/organization/groups.ts +3 -0
  469. package/dist/node_modules/openai/src/resources/admin/organization/index.ts +117 -0
  470. package/dist/node_modules/openai/src/resources/admin/organization/invites.ts +215 -0
  471. package/dist/node_modules/openai/src/resources/admin/organization/organization.ts +272 -0
  472. package/dist/node_modules/openai/src/resources/admin/organization/projects/api-keys.ts +239 -0
  473. package/dist/node_modules/openai/src/resources/admin/organization/projects/certificates.ts +269 -0
  474. package/dist/node_modules/openai/src/resources/admin/organization/projects/data-retention.ts +91 -0
  475. package/dist/node_modules/openai/src/resources/admin/organization/projects/groups/groups.ts +231 -0
  476. package/dist/node_modules/openai/src/resources/admin/organization/projects/groups/index.ts +24 -0
  477. package/dist/node_modules/openai/src/resources/admin/organization/projects/groups/roles.ts +386 -0
  478. package/dist/node_modules/openai/src/resources/admin/organization/projects/groups.ts +3 -0
  479. package/dist/node_modules/openai/src/resources/admin/organization/projects/hosted-tool-permissions.ts +217 -0
  480. package/dist/node_modules/openai/src/resources/admin/organization/projects/index.ts +102 -0
  481. package/dist/node_modules/openai/src/resources/admin/organization/projects/model-permissions.ts +123 -0
  482. package/dist/node_modules/openai/src/resources/admin/organization/projects/projects.ts +445 -0
  483. package/dist/node_modules/openai/src/resources/admin/organization/projects/rate-limits.ts +173 -0
  484. package/dist/node_modules/openai/src/resources/admin/organization/projects/roles.ts +210 -0
  485. package/dist/node_modules/openai/src/resources/admin/organization/projects/service-accounts.ts +266 -0
  486. package/dist/node_modules/openai/src/resources/admin/organization/projects/spend-alerts.ts +332 -0
  487. package/dist/node_modules/openai/src/resources/admin/organization/projects/users/index.ts +25 -0
  488. package/dist/node_modules/openai/src/resources/admin/organization/projects/users/roles.ts +351 -0
  489. package/dist/node_modules/openai/src/resources/admin/organization/projects/users/users.ts +256 -0
  490. package/dist/node_modules/openai/src/resources/admin/organization/projects/users.ts +3 -0
  491. package/dist/node_modules/openai/src/resources/admin/organization/projects.ts +3 -0
  492. package/dist/node_modules/openai/src/resources/admin/organization/roles.ts +217 -0
  493. package/dist/node_modules/openai/src/resources/admin/organization/spend-alerts.ts +301 -0
  494. package/dist/node_modules/openai/src/resources/admin/organization/usage.ts +6427 -0
  495. package/dist/node_modules/openai/src/resources/admin/organization/users/index.ts +22 -0
  496. package/dist/node_modules/openai/src/resources/admin/organization/users/roles.ts +328 -0
  497. package/dist/node_modules/openai/src/resources/admin/organization/users/users.ts +291 -0
  498. package/dist/node_modules/openai/src/resources/admin/organization/users.ts +3 -0
  499. package/dist/node_modules/openai/src/resources/admin/organization.ts +3 -0
  500. package/dist/node_modules/openai/src/resources/admin.ts +3 -0
  501. package/dist/node_modules/openai/src/resources/audio/speech.ts +26 -6
  502. package/dist/node_modules/openai/src/resources/audio/transcriptions.ts +7 -0
  503. package/dist/node_modules/openai/src/resources/audio/translations.ts +7 -1
  504. package/dist/node_modules/openai/src/resources/batches.ts +20 -8
  505. package/dist/node_modules/openai/src/resources/beta/assistants.ts +11 -2
  506. package/dist/node_modules/openai/src/resources/beta/chatkit/sessions.ts +6 -2
  507. package/dist/node_modules/openai/src/resources/beta/chatkit/threads.ts +13 -5
  508. package/dist/node_modules/openai/src/resources/beta/realtime/sessions.ts +1 -0
  509. package/dist/node_modules/openai/src/resources/beta/realtime/transcription-sessions.ts +1 -0
  510. package/dist/node_modules/openai/src/resources/beta/threads/messages.ts +7 -0
  511. package/dist/node_modules/openai/src/resources/beta/threads/runs/runs.ts +10 -0
  512. package/dist/node_modules/openai/src/resources/beta/threads/runs/steps.ts +4 -0
  513. package/dist/node_modules/openai/src/resources/beta/threads/threads.ts +14 -4
  514. package/dist/node_modules/openai/src/resources/chat/completions/completions.ts +64 -27
  515. package/dist/node_modules/openai/src/resources/chat/completions/messages.ts +4 -1
  516. package/dist/node_modules/openai/src/resources/completions.ts +15 -6
  517. package/dist/node_modules/openai/src/resources/containers/containers.ts +11 -3
  518. package/dist/node_modules/openai/src/resources/containers/files/content.ts +1 -0
  519. package/dist/node_modules/openai/src/resources/containers/files/files.ts +7 -2
  520. package/dist/node_modules/openai/src/resources/conversations/conversations.ts +31 -4
  521. package/dist/node_modules/openai/src/resources/conversations/items.ts +17 -3
  522. package/dist/node_modules/openai/src/resources/embeddings.ts +4 -0
  523. package/dist/node_modules/openai/src/resources/evals/evals.ts +12 -5
  524. package/dist/node_modules/openai/src/resources/evals/runs/output-items.ts +8 -2
  525. package/dist/node_modules/openai/src/resources/evals/runs/runs.ts +21 -4
  526. package/dist/node_modules/openai/src/resources/files.ts +23 -5
  527. package/dist/node_modules/openai/src/resources/fine-tuning/alpha/graders.ts +13 -2
  528. package/dist/node_modules/openai/src/resources/fine-tuning/checkpoints/checkpoints.ts +6 -0
  529. package/dist/node_modules/openai/src/resources/fine-tuning/checkpoints/index.ts +3 -0
  530. package/dist/node_modules/openai/src/resources/fine-tuning/checkpoints/permissions.ts +84 -10
  531. package/dist/node_modules/openai/src/resources/fine-tuning/jobs/checkpoints.ts +4 -1
  532. package/dist/node_modules/openai/src/resources/fine-tuning/jobs/jobs.ts +26 -7
  533. package/dist/node_modules/openai/src/resources/images.ts +74 -27
  534. package/dist/node_modules/openai/src/resources/index.ts +7 -0
  535. package/dist/node_modules/openai/src/resources/models.ts +6 -3
  536. package/dist/node_modules/openai/src/resources/moderations.ts +4 -1
  537. package/dist/node_modules/openai/src/resources/realtime/calls.ts +21 -2
  538. package/dist/node_modules/openai/src/resources/realtime/client-secrets.ts +54 -40
  539. package/dist/node_modules/openai/src/resources/realtime/index.ts +0 -1
  540. package/dist/node_modules/openai/src/resources/realtime/realtime.ts +705 -20
  541. package/dist/node_modules/openai/src/resources/responses/index.ts +2 -0
  542. package/dist/node_modules/openai/src/resources/responses/input-items.ts +1 -1
  543. package/dist/node_modules/openai/src/resources/responses/input-tokens.ts +9 -2
  544. package/dist/node_modules/openai/src/resources/responses/internal-base.ts +113 -0
  545. package/dist/node_modules/openai/src/resources/responses/responses.ts +1314 -143
  546. package/dist/node_modules/openai/src/resources/responses/ws-base.ts +611 -0
  547. package/dist/node_modules/openai/src/resources/responses/ws.ts +38 -0
  548. package/dist/node_modules/openai/src/resources/shared.ts +9 -1
  549. package/dist/node_modules/openai/src/resources/skills/content.ts +2 -1
  550. package/dist/node_modules/openai/src/resources/skills/skills.ts +21 -10
  551. package/dist/node_modules/openai/src/resources/skills/versions/content.ts +2 -1
  552. package/dist/node_modules/openai/src/resources/skills/versions/versions.ts +14 -7
  553. package/dist/node_modules/openai/src/resources/uploads/parts.ts +4 -1
  554. package/dist/node_modules/openai/src/resources/uploads/uploads.ts +20 -4
  555. package/dist/node_modules/openai/src/resources/vector-stores/file-batches.ts +18 -4
  556. package/dist/node_modules/openai/src/resources/vector-stores/files.ts +13 -2
  557. package/dist/node_modules/openai/src/resources/vector-stores/vector-stores.ts +6 -0
  558. package/dist/node_modules/openai/src/resources/videos.ts +186 -16
  559. package/dist/node_modules/openai/src/version.ts +1 -1
  560. package/dist/node_modules/openai/streaming.d.mts +1 -0
  561. package/dist/node_modules/openai/streaming.d.ts +1 -0
  562. package/dist/node_modules/openai/uploads.d.mts +1 -0
  563. package/dist/node_modules/openai/uploads.d.ts +1 -0
  564. package/dist/node_modules/openai/version.d.mts +1 -1
  565. package/dist/node_modules/openai/version.d.ts +1 -1
  566. package/dist/node_modules/openai/version.js +1 -1
  567. package/dist/node_modules/zod/package.json +1 -1
  568. package/dist/server/ai-employees/ai-employee.d.ts +1 -10
  569. package/dist/server/ai-employees/ai-employee.js +0 -84
  570. package/dist/server/ai-employees/ai-knowledge-base.d.ts +0 -4
  571. package/dist/server/ai-employees/ai-knowledge-base.js +25 -89
  572. package/dist/server/collections/lc-checkpoint-blobs.js +1 -1
  573. package/dist/server/collections/lc-checkpoint-writes.js +1 -1
  574. package/dist/server/collections/lc-checkpoints.js +1 -1
  575. package/dist/server/features/index.d.ts +1 -1
  576. package/dist/server/features/knowledge-base.d.ts +2 -1
  577. package/dist/server/features/vector-store-provider.d.ts +1 -9
  578. package/dist/server/plugin.d.ts +1 -0
  579. package/dist/server/plugin.js +31 -0
  580. package/dist/server/types/knowledge-base.type.d.ts +14 -0
  581. package/package.json +13 -13
  582. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base.md +0 -82
  583. package/dist/node_modules/@langchain/xai/dist/_virtual/rolldown_runtime.cjs +0 -25
@@ -0,0 +1,77 @@
1
+ ---
2
+ pkg: "@nocobase/plugin-ai-knowledge-base"
3
+ title: "Settings"
4
+ description: "Modify basic information, vector store, and default segmentation settings on the Settings page of a knowledge base, and understand the relation between knowledge-base-level and document-level segmentation settings."
5
+ keywords: "knowledge base settings,segmentation settings,Chunk size,Chunk overlap,vector store,NocoBase"
6
+ ---
7
+
8
+ # Settings
9
+
10
+ ## Open the Settings page
11
+
12
+ After opening the knowledge base detail page, click Settings in the left sidebar. This page modifies basic information, file storage, vector store, and default segmentation settings of the current knowledge base.
13
+
14
+ ![](https://static-docs.nocobase.com/20260617005832.png)
15
+
16
+ ## Basic information
17
+
18
+ Local knowledge base settings include:
19
+
20
+ | Setting | Description |
21
+ | --- | --- |
22
+ | Key | Unique identifier of the knowledge base. It cannot be changed after creation |
23
+ | Name | Knowledge base name |
24
+ | File storage | Where documents and segment files are stored. It cannot be changed after creation |
25
+ | Vector store | Vector store used by the current knowledge base |
26
+ | Description | Knowledge base description |
27
+ | Enabled | Whether the current knowledge base is enabled |
28
+
29
+ :::tip Vector store changes
30
+
31
+ After you modify Vector store, NocoBase asks for confirmation when saving. After the vector store changes, existing documents must be vectorized again before vector data can be written to the new vector store. Choose Save and vectorize to save the settings and vectorize immediately, or choose Save only to save the settings and later run Vectorization manually on the Documents page.
32
+
33
+ :::
34
+
35
+ ![](https://static-docs.nocobase.com/20260617005951.png)
36
+
37
+ ## Default segmentation parameters
38
+
39
+ The Settings page includes three segmentation parameters:
40
+
41
+ | Setting | Default | Description |
42
+ | --- | --- | --- |
43
+ | Split document | Enabled | Whether uploaded documents are automatically split into multiple segments |
44
+ | Chunk size | `6000` | Maximum character count of each segment |
45
+ | Chunk overlap | `1200` | Overlapping character count between adjacent segments |
46
+
47
+ Chunk overlap cannot be greater than or equal to Chunk size. If the value is invalid, the backend normalizes it to keep overlap smaller than a single segment.
48
+
49
+ ## Relation to document-level segment settings
50
+
51
+ These settings are knowledge-base-level defaults. They mainly affect documents uploaded or regenerated later.
52
+
53
+ After a document enters the knowledge base, it keeps its own segmentation parameters. On the Documents page, click Segments for a document, then open Segment settings to set Split document, Chunk size, and Chunk overlap for that document and run Resegment.
54
+
55
+ The relation between the two places is:
56
+
57
+ - Segmentation parameters in Settings define the default strategy for the knowledge base and are suitable for controlling new documents consistently
58
+ - Segmentation parameters in the Segments dialog only apply to the current document and are suitable for handling a document that is too long, too short, or structurally special
59
+ - Existing generated segments are not automatically rebuilt after knowledge-base-level defaults change
60
+ - To apply new parameters to an existing document, open its Segment settings and run Resegment
61
+
62
+ :::warning Note
63
+
64
+ Resegment discards manually edited segment content and related questions in that document. Changing knowledge-base-level defaults does not immediately overwrite existing segments; only document-level Resegment rebuilds segments.
65
+
66
+ :::
67
+
68
+ ## When to adjust parameters
69
+
70
+ Default parameters cover most plain text, Markdown, Word, and PDF documents. Adjust them only in these cases:
71
+
72
+ - Segments are too long and matched results include too much unrelated content: reduce Chunk size
73
+ - Segments are too short and context is incomplete: increase Chunk size
74
+ - Sentence breaks are obvious between adjacent segments: increase Chunk overlap
75
+ - You want the whole document to be one retrieval unit: turn off Split document
76
+
77
+ After saving settings, newly uploaded documents use the new default parameters.
@@ -19,7 +19,7 @@ Select the AI employee for which you want to enable RAG, click the `Edit` button
19
19
  In the `Knowledge base` tab, turn on the `Enable` switch.
20
20
 
21
21
  - In `Knowledge Base Prompt`, enter the prompt for referencing the knowledge base. `{knowledgeBaseData}` is a fixed placeholder and should not be modified.
22
- - In `Knowledge Base`, select the configured knowledge base. See: [Knowledge Base](/ai-employees/knowledge-base/knowledge-base).
22
+ - In `Knowledge Base`, select the configured knowledge base. See: [Knowledge Base](./knowledge-base/).
23
23
  - In the `Top K` input box, enter the number of documents to retrieve, the default is 3.
24
24
  - In the `Score` input box, enter the document relevance threshold for retrieval.
25
25
 
@@ -0,0 +1,79 @@
1
+ ---
2
+ pkg: "@nocobase/plugin-ai-knowledge-base"
3
+ title: "Workflow AI knowledge base node - Create document"
4
+ description: "Use a collection event trigger and the AI knowledge base Create document node to synchronize newly added records to the AI knowledge base."
5
+ keywords: "AI knowledge base,workflow,create document,collection event trigger,NocoBase"
6
+ ---
7
+
8
+ # Create document
9
+
10
+ <PluginInfo name="ai-knowledge-base"></PluginInfo>
11
+
12
+ ## Introduction
13
+
14
+ In NocoBase, the **Create document** node writes new documents to an AI knowledge base from a workflow. In this example, it listens for new records in `Answers` and writes the answer body, document name, related questions, and a stable `Key` to the target knowledge base.
15
+
16
+ AI knowledge base nodes are asynchronous nodes, so the workflow must use asynchronous execution. Prepare the target knowledge base and vector store first. See [Overview](./) for the full scenario.
17
+
18
+ ## Workflow structure
19
+
20
+ The example workflow listens for new records in `Answers` and synchronizes each answer as one document in the target knowledge base.
21
+
22
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-create-editable-overview.png)
23
+
24
+ Where:
25
+
26
+ - `Collection event` listens for newly added collection records
27
+ - `Create document` writes record content to the AI knowledge base
28
+
29
+ ## Before you start
30
+
31
+ The example uses the `Answers` / `Questions` collections and target knowledge base described in [Overview](./). Before configuring the workflow, confirm that:
32
+
33
+ - A Local knowledge base has been created, with file storage and vector store configured. See [Knowledge base overview](../../../knowledge-base/knowledge-base) and [Vector store](../../../knowledge-base/vector-store)
34
+ - The `Answers.questions` relation field is ready. To review the collection structure, return to [Overview](./)
35
+ - The workflow uses asynchronous execution. See [Workflow](../../../../workflow) for the basics
36
+
37
+ ## Configure the trigger
38
+
39
+ Create an asynchronous workflow and select `Collection event` as the trigger. In the trigger configuration:
40
+
41
+ - Set `Collection` to the collection to synchronize, such as `Main / Answers`
42
+ - Set `Trigger on` to `After record added`
43
+ - If the document needs fields from related collections, preload relation fields in `Preload associations`
44
+
45
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-create-trigger-config.png)
46
+
47
+ The example preloads the `questions` relation field so related questions can be written to `Related questions`.
48
+
49
+ ## Configure the Create document node
50
+
51
+ Add a `Create document` node after the trigger.
52
+
53
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-create-node-config.png)
54
+
55
+ Key settings:
56
+
57
+ These settings decide the knowledge base document name, body content, splitting behavior, and whether related questions are included.
58
+
59
+ | Setting | Example value | Description |
60
+ | --- | --- | --- |
61
+ | `Knowledge base` | Target knowledge base | Select the same Local knowledge base prepared in the overview. The workflow creates a document in its `Documents` list and then enters splitting and vectorization. |
62
+ | `Split document` | `No` | Controls whether the body is split into multiple segments. In this example, one answer is already a complete response. With splitting disabled, the whole document becomes one segment and works better with `Related questions`. |
63
+ | `Related questions` | `Answers.questions.content` | Only takes effect when `Split document` is disabled. It writes common phrasings into `Related questions` for the current segment. It does not rewrite the body, but participates in retrieval. |
64
+ | `Document type` | `Text` | Creates a knowledge base document from a text field. The example uses a collection field as the answer body, so `Text` is selected. Use `Attachment` if your business collection stores files or file URLs. |
65
+ | `Content` | `Answers.Content` | Select the answer body as the knowledge base document body. The `Content` shown in segment management comes from this field. |
66
+ | `Key` | `Answers.ID` | Sets the unique identifier of the knowledge base document. The example uses the `Answers` record ID so update and delete workflows can find the same document by the same `Key`. |
67
+ | `Name` | `Answers.Title` | Sets the document name. The example uses the answer title, making it easier to identify the document in `Documents`, enter segment management, and run hit tests. |
68
+
69
+ If `Related questions` references relation fields, configure `Preload associations` in the trigger first. Otherwise, the node can only access the current `Answers` record and cannot read the related `questions` data.
70
+
71
+ :::warning Note
72
+
73
+ `Key` is used by the later update and delete workflows. The Create, Update, and Delete workflows must use the same Key rule, usually the business collection record ID.
74
+
75
+ :::
76
+
77
+ ## Next step
78
+
79
+ The Create document workflow is the starting point of the synchronization chain. Continue with [Update document](./update-document) and [Delete document](./delete-document), then return to the "Verify the synchronization chain" section in [Overview](./) to verify add, update, and delete in order.
@@ -0,0 +1,71 @@
1
+ ---
2
+ pkg: "@nocobase/plugin-ai-knowledge-base"
3
+ title: "Workflow AI knowledge base node - Delete document"
4
+ description: "Use a collection event trigger and the AI knowledge base Delete document node to delete knowledge base documents after collection records are deleted."
5
+ keywords: "AI knowledge base,workflow,delete document,collection event trigger,NocoBase"
6
+ ---
7
+
8
+ # Delete document
9
+
10
+ <PluginInfo name="ai-knowledge-base"></PluginInfo>
11
+
12
+ ## Introduction
13
+
14
+ In NocoBase, the **Delete document** node deletes a specified document from an AI knowledge base. In this example, it listens for deletion events in `Answers` and deletes the corresponding document from the target knowledge base by the same `Key` used by Create document, so removed data is no longer retrieved.
15
+
16
+ The Delete document node is asynchronous. It depends on the `Key` written when the document was created, so it must use the same target knowledge base and the same `Key` rule as the Create and Update document nodes.
17
+
18
+ ## Workflow structure
19
+
20
+ The example workflow listens for deletion events in `Answers` and deletes the document with the same `Key` from the target knowledge base.
21
+
22
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-delete-editable-overview.png)
23
+
24
+ Where:
25
+
26
+ - `Collection event` listens for collection deletion
27
+ - `Delete document` deletes the document from the target knowledge base
28
+
29
+ ## Before you start
30
+
31
+ The example uses the target knowledge base and `Key` rule from [Create document](./create-document). Before configuring the workflow, confirm that:
32
+
33
+ - The Create document workflow is enabled and the target knowledge base contains documents with the same `Key`
34
+ - The delete workflow can read this `Key` from trigger data. The example uses the `Answers` record ID
35
+ - If you need to review the full synchronization chain, see the workflow responsibilities in [Overview](./)
36
+
37
+ ## Configure the trigger
38
+
39
+ Select `Collection event` as the trigger. In the trigger configuration:
40
+
41
+ - Set `Collection` to the collection to listen to, such as `Main / Answers`
42
+ - Set `Trigger on` to `After record deleted`
43
+
44
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-delete-trigger-config.png)
45
+
46
+ Deleting a document only needs the document `Key`, so relation fields usually do not need to be preloaded.
47
+
48
+ ## Configure the Delete document node
49
+
50
+ Add a `Delete document` node after the trigger.
51
+
52
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-delete-node-config.png)
53
+
54
+ Key settings:
55
+
56
+ The Delete document node only needs to locate the document to delete. It does not need body content, title, or related questions.
57
+
58
+ | Setting | Example value | Description |
59
+ | --- | --- | --- |
60
+ | `Knowledge base` | Target knowledge base | Select the same knowledge base used by the Create and Update document nodes. |
61
+ | `Key` | `Answers.ID` | Select the exact same field used by the Create document node. The example continues to use the `Answers` record ID so the node deletes the document that corresponds to this answer. |
62
+
63
+ :::warning Note
64
+
65
+ The delete node does not look up documents by title or body content. It only locates documents by `Knowledge base` and `Key`. The Create, Update, and Delete workflows must use the same `Key`.
66
+
67
+ :::
68
+
69
+ ## Next step
70
+
71
+ After configuring the Delete document node, return to the "Verify the synchronization chain" section in [Overview](./) to verify add, update, and delete in order.
@@ -0,0 +1,84 @@
1
+ ---
2
+ pkg: "@nocobase/plugin-ai-knowledge-base"
3
+ title: "Workflow AI knowledge base nodes overview"
4
+ description: "Introduces the workflow AI knowledge base node scenario, collection structure, and how Create, Update, and Delete document nodes synchronize knowledge base content."
5
+ keywords: "AI knowledge base,workflow,collection event trigger,knowledge base synchronization,NocoBase"
6
+ ---
7
+
8
+ # Overview
9
+
10
+ <PluginInfo name="ai-knowledge-base"></PluginInfo>
11
+
12
+ ## Introduction
13
+
14
+ AI knowledge base nodes allow workflows to manage knowledge base documents directly. When business data changes, you can synchronize added, updated, and deleted records to the knowledge base, keeping knowledge base content aligned with your business collections.
15
+
16
+ This documentation uses a Q&A scenario as an example: administrators maintain standard answers and common phrasings for each answer. Workflows synchronize the answer body and related questions to the same target knowledge base, so AI employees or other processes can later use those knowledge base documents.
17
+
18
+ ## Example scenario
19
+
20
+ The example uses two business collections:
21
+
22
+ - `Answers`: stores answer content that can be synchronized to the knowledge base
23
+ - `Questions`: stores common phrasings related to each answer
24
+
25
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-overview-collections.png)
26
+
27
+ `Answers` is the source collection for knowledge base documents. When an answer is added, a document is created. When an answer is changed, the document is updated. When an answer is deleted, the document is removed.
28
+
29
+ `Questions` is not an independent source of knowledge base documents. It is attached to answers through the `Answers.questions` relation field and supplements the different phrasings that can point to the same answer.
30
+
31
+ Before synchronization, prepare a Local knowledge base. You can name it according to your environment. The Create, Update, and Delete workflows only need to select the same knowledge base.
32
+
33
+ ## Answers collection structure
34
+
35
+ `Answers` mainly uses three fields:
36
+
37
+ - `Title`: used as the knowledge base document name
38
+ - `Content`: used as the knowledge base document body
39
+ - `questions`: relation to the `Questions` collection for related questions
40
+
41
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-overview-answers-fields.png)
42
+
43
+ `questions` is a one-to-many relation field. Its source collection is `Answers`, target collection is `Questions`, both source key and target key use `ID`, and the foreign key is stored in `Questions`.
44
+
45
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-overview-answers-questions-relation.png)
46
+
47
+ This relation field is preloaded when creating and updating documents. It writes related questions into `Related questions`, so one answer can be retrieved not only by body text but also by common phrasings.
48
+
49
+ :::tip
50
+
51
+ If your knowledge base documents do not need related questions, you do not need a relation field like `questions`. A stable `Key` field and body content are enough for create, update, and delete synchronization.
52
+
53
+ :::
54
+
55
+ ## Workflow responsibilities
56
+
57
+ The core of this example is three synchronization workflows. They process the same `Answers` data and write to the same target knowledge base:
58
+
59
+ | Scenario | Trigger | Node | Purpose |
60
+ | --- | --- | --- | --- |
61
+ | Add answer | `Answers` collection `After record added` | `Create document` | Write the new answer to the AI knowledge base |
62
+ | Update answer | `Answers` collection `After record updated` | `Update document` | Update the document by the same `Key` |
63
+ | Delete answer | `Answers` collection `After record deleted` | `Delete document` | Delete the document by the same `Key` |
64
+
65
+ `Key` is the most important field in the synchronization chain. Create, update, and delete workflows must use the same `Key` rule. The example directly uses the record ID of the `Answers` collection.
66
+
67
+ ## Operation guides
68
+
69
+ - [Create document](./create-document)
70
+ - [Update document](./update-document)
71
+ - [Delete document](./delete-document)
72
+ - [Retrieve document](./retrieve-document)
73
+
74
+ ## Verify the synchronization chain
75
+
76
+ After configuring the Create, Update, and Delete workflows, use the same `Answers` record to verify the full synchronization chain.
77
+
78
+ After adding an answer, check in this order:
79
+
80
+ 1. Go to `Documents` in the target knowledge base, confirm that the new document appears, and check that `Status` is `Success`. See [knowledge base document management](../../../knowledge-base/knowledge-base/documents) for details.
81
+ 2. Click `Segments` for the document and confirm that `Related questions` includes common phrasings from `Answers.questions`. See [segment management](../../../knowledge-base/knowledge-base/segments) for details.
82
+ 3. Go to `Hit tests`, enter a keyword from the answer body or a related question, and confirm that the synchronized answer can be hit. See [hit tests](../../../knowledge-base/knowledge-base/hit-tests) for details.
83
+
84
+ After the add synchronization is correct, update the same `Answers` record and confirm that the target knowledge base document changes. Finally, delete the record and confirm that the corresponding document is removed from the target knowledge base.
@@ -0,0 +1,87 @@
1
+ ---
2
+ pkg: "@nocobase/plugin-ai-knowledge-base"
3
+ title: "Workflow AI knowledge base node - Retrieve document"
4
+ description: "Use the AI knowledge base Retrieve document node in a workflow to retrieve snippets and provide them as task context for an AI employee node."
5
+ keywords: "AI knowledge base,workflow,retrieve document,AI employee,RAG,NocoBase"
6
+ ---
7
+
8
+ # Retrieve document
9
+
10
+ <PluginInfo name="ai-knowledge-base"></PluginInfo>
11
+
12
+ ## Introduction
13
+
14
+ In NocoBase, the **Retrieve document** node searches an AI knowledge base in a workflow and returns matched document snippets. It is suitable before an AI employee node: retrieve knowledge base snippets with task input first, then pass the results to the AI employee as task context.
15
+
16
+ The Retrieve document node is asynchronous. Before using it, configure the knowledge base and make sure it already contains vectorized documents.
17
+
18
+ ## Workflow structure
19
+
20
+ The example workflow listens for new records in `Questions`, sends matching text to `Retrieve document`, and passes the retrieval result to a downstream `AI employee` node for task processing.
21
+
22
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-retrieve-overview.png)
23
+
24
+ Where:
25
+
26
+ - `Collection event` receives task input
27
+ - `Retrieve document` retrieves snippets from the knowledge base
28
+ - `AI employee` processes the task based on snippets
29
+
30
+ In real business workflows, the result generated by the AI employee usually needs to be saved. You can continue with database operation nodes after it. This guide omits those later saving steps to focus on the Retrieve document node.
31
+
32
+ ## Before you start
33
+
34
+ This example is an independent retrieval workflow. Before configuring it, confirm that:
35
+
36
+ - The knowledge base already contains vectorized documents. For document maintenance, see [Knowledge base overview](../../../knowledge-base/knowledge-base) and [Create document](./create-document)
37
+ - A data source for matching text is ready. The example uses the `Questions` collection
38
+ - A usable downstream AI employee node is ready. See [AI employee node](../employee/configuration)
39
+
40
+ ## Configure the trigger
41
+
42
+ Select `Collection event` as the trigger. In the trigger configuration:
43
+
44
+ - Set `Collection` to the matching-text source collection, such as `Main / Questions`
45
+ - Set `Trigger on` to `After record added`
46
+
47
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-retrieve-trigger-config.png)
48
+
49
+ Each time an input record is added, the workflow automatically enters retrieval and task processing.
50
+
51
+ ## Configure the Retrieve document node
52
+
53
+ Add a `Retrieve document` node after the trigger. It is recommended to change the node key to an easy-to-reference name, such as `retrieve_docs`.
54
+
55
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-retrieve-node-config.png)
56
+
57
+ Key settings:
58
+
59
+ - Select one or more knowledge bases in `Knowledge base`
60
+ - Set `Input matching text` to the matching text field
61
+ - Set `Top K` to the maximum number of snippets to return
62
+ - Set `Score` to the minimum similarity threshold
63
+
64
+ After execution, the node returns an array of document snippets. Each result contains `id`, `content`, `score`, and `metadata`, sorted by `score` from high to low.
65
+
66
+ ## Pass the result to the AI employee node
67
+
68
+ In the `AI employee` node, write the retrieval result into the prompt. The example directly references the Retrieve document node output:
69
+
70
+ ```text
71
+ Task input: {{$context.data.f_b2izf5j4xx0}}
72
+
73
+ Knowledge base snippets:
74
+ {{$jobsMapByNodeKey.retrieve_docs}}
75
+
76
+ Use the snippets as context to complete the task. If the snippets are not enough, explain what information is missing.
77
+ ```
78
+
79
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-retrieve-ai-employee-config.png)
80
+
81
+ `retrieve_docs` is the key of the retrieval node. If your node key is different, replace it with the actual key.
82
+
83
+ :::tip
84
+
85
+ If you only want to pass snippet text, reference the `content` field in the retrieval result through the variable selector. Passing the whole result array also includes `score` and `metadata`, which helps the AI judge source and relevance.
86
+
87
+ :::
@@ -0,0 +1,70 @@
1
+ ---
2
+ pkg: "@nocobase/plugin-ai-knowledge-base"
3
+ title: "Workflow AI knowledge base node - Update document"
4
+ description: "Use a collection event trigger and the AI knowledge base Update document node to synchronize collection updates to the AI knowledge base."
5
+ keywords: "AI knowledge base,workflow,update document,collection event trigger,NocoBase"
6
+ ---
7
+
8
+ # Update document
9
+
10
+ <PluginInfo name="ai-knowledge-base"></PluginInfo>
11
+
12
+ ## Introduction
13
+
14
+ In NocoBase, the **Update document** node updates existing documents in an AI knowledge base from a workflow. In this example, it listens for updated records in `Answers`, finds the document in the target knowledge base by the same `Key` used by Create document, and rewrites it with the latest fields.
15
+
16
+ The Update document node is asynchronous. It is not used as an independent entry point. It should follow the Create document workflow and use the same target knowledge base and the same `Key` rule as Create and Delete document nodes.
17
+
18
+ ## Workflow structure
19
+
20
+ The example workflow listens for updated records in `Answers` and synchronizes the latest answer content to the same document in the target knowledge base.
21
+
22
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-update-editable-overview.png)
23
+
24
+ Where:
25
+
26
+ - `Collection event` listens for collection updates
27
+ - `Update document` updates the document with the same `Key` in the target knowledge base
28
+
29
+ ## Before you start
30
+
31
+ The example uses the target knowledge base and `Key` rule from [Create document](./create-document). Before configuring the workflow, confirm that:
32
+
33
+ - The Create document workflow is enabled and has created at least one knowledge base document
34
+ - `Key` uses a stable and unique business field. The example uses the `Answers` record ID
35
+ - If updates should also synchronize related questions, preload the `questions` relation field in the trigger
36
+
37
+ ## Configure the trigger
38
+
39
+ Select `Collection event` as the trigger. In the trigger configuration:
40
+
41
+ - Set `Collection` to the collection to listen to, such as `Main / Answers`
42
+ - Set `Trigger on` to `After record updated`
43
+ - Use `Changed fields` to limit which field changes trigger the workflow, such as title or body changes
44
+ - If the node needs relation fields, preload them in `Preload associations`
45
+
46
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-update-trigger-config.png)
47
+
48
+ If `Changed fields` is not selected, any field change triggers this workflow.
49
+
50
+ ## Configure the Update document node
51
+
52
+ Add an `Update document` node after the trigger.
53
+
54
+ ![](https://static-docs.nocobase.com/ai-employees/workflow/knowledge/2026-06-12/kb-update-node-config.png)
55
+
56
+ Key settings:
57
+
58
+ Most Update document settings are the same as [Create document](./create-document). Usually, continue using the same target knowledge base, splitting behavior, body field, and title field. If related questions also need to be synchronized, continue using `Answers.questions.content`.
59
+
60
+ The important difference is `Key`: in the Update document node, `Key` is required and must be exactly the same as in the Create document node. The example continues to use `Answers.ID`, so the node can find and overwrite the same knowledge base document.
61
+
62
+ :::warning Note
63
+
64
+ If no document is found for the specified `Key`, the update fails. Before configuring this workflow, make sure the Create document workflow has already created documents with the same `Key`.
65
+
66
+ :::
67
+
68
+ ## Next step
69
+
70
+ After configuring the Update document node, continue with [Delete document](./delete-document). After all three workflows are configured, return to the "Verify the synchronization chain" section in [Overview](./) to verify add, update, and delete in order.
@@ -46,4 +46,7 @@ features:
46
46
  - title: File Preview Extension
47
47
  details: Extend file preview capabilities to support online preview and rendering of more file formats.
48
48
  link: /file-manager/development
49
+ - title: Knowledge Base Extension
50
+ details: Connect external knowledge bases or custom retrieval services to extend RAG retrieval sources for AI employees.
51
+ link: /ai-employees/knowledge-base/dev/external-knowledge-base
49
52
  ---
@@ -116,7 +116,7 @@ When users access NocoBase, requests go directly to your server. An appropriate
116
116
  - Disadvantages: This method is simple but performs poorly when handling high concurrency or static files; suitable for development and testing only.
117
117
  - Recommendation: Please avoid this method if possible.
118
118
 
119
- > Reference "[Installation Documentation](https://v2.docs.nocobase.com/get-started/quickstart)"
119
+ > Reference "[Installation Documentation](https://docs.nocobase.com/get-started/quickstart)"
120
120
 
121
121
  Without a reverse proxy, homepage loading takes about 6.1 seconds
122
122
  ![20250409131357](https://static-docs.nocobase.com/20250409131357.png)
@@ -126,7 +126,7 @@ Without a reverse proxy, homepage loading takes about 6.1 seconds
126
126
  - Advantages: Reverse proxy servers can efficiently handle concurrent connections, serve static files, implement load balancing, and make HTTP/2 configuration simple.
127
127
  - Recommendation: In production environments, after application deployment (source code deployment / create-nocobase-app / Docker image), use Nginx or Caddy as a reverse proxy.
128
128
 
129
- > Reference "[Deployment Documentation](https://v2.docs.nocobase.com/get-started/deployment/production)"
129
+ > Reference "[Deployment Documentation](https://docs.nocobase.com/get-started/deployment/production)"
130
130
 
131
131
  With Nginx proxy, homepage loading takes about 3-4 seconds
132
132
  ![20250409131541](https://static-docs.nocobase.com/20250409131541.png)
@@ -8,18 +8,20 @@ pkg: '@nocobase/plugin-backups'
8
8
 
9
9
  The NocoBase backup manager plugin provides features for fully backing up of the NocoBase database and user uploaded files, including backup's scheduling, downloading, deleting, and restoring operation.
10
10
 
11
- :::warning
12
- The Backup Manager plugin is included in the Professional and Enterprise editions. For Community and Standard edition users, you can directly back up the database; see details at: [`How to Backup and Restore NocoBase`](https://www.nocobase.com/en/blog/nocobase-backup-restore)
13
- :::
14
-
15
11
  ## Install Database Client
16
12
 
17
- The Backup Manager depends on the client for the corresponding database. Before use, please visit the official website to download the client that matches your database version:
13
+ Backup Manager depends on the database client for the primary database. Before use, confirm that the current runtime environment has a client that matches your database version.
14
+
15
+ :::tip
16
+ When installing NocoBase with Docker, use the corresponding `full` image when possible, such as `latest-full`, `beta-full`, or `alpha-full`. These images already include common database clients, so manual installation is usually not required.
17
+ :::
18
+
19
+ If the current environment does not have the required database client, download the client that matches your database version from the official website:
18
20
 
19
21
  - MySQL: https://dev.mysql.com/downloads/
20
22
  - PostgreSQL: https://www.postgresql.org/download/
21
23
 
22
- For Docker versions, you can directly write a script in the `./storage/scripts` directory
24
+ If you need to install it manually in a Docker environment, you can write a script in the `./storage/scripts` directory:
23
25
 
24
26
  ```bash
25
27
  mkdir ./storage/scripts
@@ -188,4 +190,4 @@ Switch to the "Settings" tab, modify the backup settings, and click `Save` to ta
188
190
  - `Backup local storage files`: Whether to include files uploaded by users to the server's local storage (storage/uploads) in the backup.
189
191
  - `Restore password`: If a restore password is set, it must be entered when restoring the backup.
190
192
 
191
- > **Please keep the restore password safe. Forgetting the password will make it impossible to restore the backup file.**
193
+ > **Please keep the restore password safe. Forgetting the password will make it impossible to restore the backup file.**