openai.ts 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637
  1. import assert from 'node:assert';
  2. import { Readable, Transform } from 'stream';
  3. import { pipeline } from 'stream/promises';
  4. import {
  5. PageGrant, getIdForRef, getIdStringForRef, isPopulated, type IUserHasId,
  6. } from '@growi/core';
  7. import { isGrobPatternPath } from '@growi/core/dist/utils/page-path-utils';
  8. import escapeStringRegexp from 'escape-string-regexp';
  9. import mongoose, { type HydratedDocument, type Types } from 'mongoose';
  10. import { type OpenAI, toFile } from 'openai';
  11. import ExternalUserGroupRelation from '~/features/external-user-group/server/models/external-user-group-relation';
  12. import ThreadRelationModel from '~/features/openai/server/models/thread-relation';
  13. import VectorStoreModel, { type VectorStoreDocument } from '~/features/openai/server/models/vector-store';
  14. import VectorStoreFileRelationModel, {
  15. type VectorStoreFileRelation,
  16. prepareVectorStoreFileRelations,
  17. } from '~/features/openai/server/models/vector-store-file-relation';
  18. import type { PageDocument, PageModel } from '~/server/models/page';
  19. import UserGroupRelation from '~/server/models/user-group-relation';
  20. import { configManager } from '~/server/service/config-manager';
  21. import { createBatchStream } from '~/server/util/batch-stream';
  22. import loggerFactory from '~/utils/logger';
  23. import { OpenaiServiceTypes } from '../../interfaces/ai';
  24. import {
  25. type AccessibleAiAssistants, type AiAssistant, AiAssistantAccessScope, AiAssistantShareScope,
  26. } from '../../interfaces/ai-assistant';
  27. import AiAssistantModel, { type AiAssistantDocument } from '../models/ai-assistant';
  28. import { convertMarkdownToHtml } from '../utils/convert-markdown-to-html';
  29. import { getClient } from './client-delegator';
  30. // import { splitMarkdownIntoChunks } from './markdown-splitter/markdown-token-splitter';
  31. import { openaiApiErrorHandler } from './openai-api-error-handler';
  32. const BATCH_SIZE = 100;
  33. const logger = loggerFactory('growi:service:openai');
  34. // const isVectorStoreForPublicScopeExist = false;
  35. type VectorStoreFileRelationsMap = Map<string, VectorStoreFileRelation>
  36. const convertPathPatternsToRegExp = (pagePathPatterns: string[]): Array<string | RegExp> => {
  37. return pagePathPatterns.map((pagePathPattern) => {
  38. if (isGrobPatternPath(pagePathPattern)) {
  39. const trimedPagePathPattern = pagePathPattern.replace('/*', '');
  40. const escapedPagePathPattern = escapeStringRegexp(trimedPagePathPattern);
  41. return new RegExp(`^${escapedPagePathPattern}`);
  42. }
  43. return pagePathPattern;
  44. });
  45. };
  46. export interface IOpenaiService {
  47. getOrCreateThread(userId: string, vectorStoreId?: string, threadId?: string): Promise<OpenAI.Beta.Threads.Thread | undefined>;
  48. // getOrCreateVectorStoreForPublicScope(): Promise<VectorStoreDocument>;
  49. deleteExpiredThreads(limit: number, apiCallInterval: number): Promise<void>; // for CronJob
  50. deleteObsolatedVectorStoreRelations(): Promise<void> // for CronJob
  51. createVectorStoreFile(vectorStoreRelation: VectorStoreDocument, pages: PageDocument[]): Promise<void>;
  52. deleteVectorStoreFile(vectorStoreRelationId: Types.ObjectId, pageId: Types.ObjectId): Promise<void>;
  53. deleteObsoleteVectorStoreFile(limit: number, apiCallInterval: number): Promise<void>; // for CronJob
  54. // rebuildVectorStoreAll(): Promise<void>;
  55. // rebuildVectorStore(page: HydratedDocument<PageDocument>): Promise<void>;
  56. createAiAssistant(data: Omit<AiAssistant, 'vectorStore'>): Promise<AiAssistantDocument>;
  57. getAccessibleAiAssistants(user: IUserHasId): Promise<AccessibleAiAssistants>
  58. deleteAiAssistant(ownerId: string, aiAssistantId: string): Promise<AiAssistantDocument>
  59. }
  60. class OpenaiService implements IOpenaiService {
  61. private get client() {
  62. const openaiServiceType = configManager.getConfig('openai:serviceType');
  63. return getClient({ openaiServiceType });
  64. }
  65. public async getOrCreateThread(userId: string, vectorStoreId?: string, threadId?: string): Promise<OpenAI.Beta.Threads.Thread> {
  66. if (vectorStoreId != null && threadId == null) {
  67. try {
  68. const thread = await this.client.createThread(vectorStoreId);
  69. await ThreadRelationModel.create({ userId, threadId: thread.id });
  70. return thread;
  71. }
  72. catch (err) {
  73. throw new Error(err);
  74. }
  75. }
  76. const threadRelation = await ThreadRelationModel.findOne({ threadId });
  77. if (threadRelation == null) {
  78. throw new Error('ThreadRelation document is not exists');
  79. }
  80. // Check if a thread entity exists
  81. // If the thread entity does not exist, the thread-relation document is deleted
  82. try {
  83. const thread = await this.client.retrieveThread(threadRelation.threadId);
  84. // Update expiration date if thread entity exists
  85. await threadRelation.updateThreadExpiration();
  86. return thread;
  87. }
  88. catch (err) {
  89. await openaiApiErrorHandler(err, { notFoundError: async() => { await threadRelation.remove() } });
  90. throw new Error(err);
  91. }
  92. }
  93. public async deleteExpiredThreads(limit: number, apiCallInterval: number): Promise<void> {
  94. const expiredThreadRelations = await ThreadRelationModel.getExpiredThreadRelations(limit);
  95. if (expiredThreadRelations == null) {
  96. return;
  97. }
  98. const deletedThreadIds: string[] = [];
  99. for await (const expiredThreadRelation of expiredThreadRelations) {
  100. try {
  101. const deleteThreadResponse = await this.client.deleteThread(expiredThreadRelation.threadId);
  102. logger.debug('Delete thread', deleteThreadResponse);
  103. deletedThreadIds.push(expiredThreadRelation.threadId);
  104. // sleep
  105. await new Promise(resolve => setTimeout(resolve, apiCallInterval));
  106. }
  107. catch (err) {
  108. logger.error(err);
  109. }
  110. }
  111. await ThreadRelationModel.deleteMany({ threadId: { $in: deletedThreadIds } });
  112. }
  113. // TODO: https://redmine.weseek.co.jp/issues/160332
  114. // public async getOrCreateVectorStoreForPublicScope(): Promise<VectorStoreDocument> {
  115. // const vectorStoreDocument: VectorStoreDocument | null = await VectorStoreModel.findOne({ scopeType: VectorStoreScopeType.PUBLIC, isDeleted: false });
  116. // if (vectorStoreDocument != null && isVectorStoreForPublicScopeExist) {
  117. // return vectorStoreDocument;
  118. // }
  119. // if (vectorStoreDocument != null && !isVectorStoreForPublicScopeExist) {
  120. // try {
  121. // // Check if vector store entity exists
  122. // // If the vector store entity does not exist, the vector store document is deleted
  123. // await this.client.retrieveVectorStore(vectorStoreDocument.vectorStoreId);
  124. // isVectorStoreForPublicScopeExist = true;
  125. // return vectorStoreDocument;
  126. // }
  127. // catch (err) {
  128. // await oepnaiApiErrorHandler(err, { notFoundError: vectorStoreDocument.markAsDeleted });
  129. // throw new Error(err);
  130. // }
  131. // }
  132. // const newVectorStore = await this.client.createVectorStore(VectorStoreScopeType.PUBLIC);
  133. // const newVectorStoreDocument = await VectorStoreModel.create({
  134. // vectorStoreId: newVectorStore.id,
  135. // scopeType: VectorStoreScopeType.PUBLIC,
  136. // }) as VectorStoreDocument;
  137. // isVectorStoreForPublicScopeExist = true;
  138. // return newVectorStoreDocument;
  139. // }
  140. private async createVectorStore(name: string): Promise<VectorStoreDocument> {
  141. try {
  142. const newVectorStore = await this.client.createVectorStore(name);
  143. const newVectorStoreDocument = await VectorStoreModel.create({
  144. vectorStoreId: newVectorStore.id,
  145. }) as VectorStoreDocument;
  146. return newVectorStoreDocument;
  147. }
  148. catch (err) {
  149. throw new Error(err);
  150. }
  151. }
  152. // TODO: https://redmine.weseek.co.jp/issues/160332
  153. // TODO: https://redmine.weseek.co.jp/issues/156643
  154. // private async uploadFileByChunks(pageId: Types.ObjectId, body: string, vectorStoreFileRelationsMap: VectorStoreFileRelationsMap) {
  155. // const chunks = await splitMarkdownIntoChunks(body, 'gpt-4o');
  156. // for await (const [index, chunk] of chunks.entries()) {
  157. // try {
  158. // const file = await toFile(Readable.from(chunk), `${pageId}-chunk-${index}.md`);
  159. // const uploadedFile = await this.client.uploadFile(file);
  160. // prepareVectorStoreFileRelations(pageId, uploadedFile.id, vectorStoreFileRelationsMap);
  161. // }
  162. // catch (err) {
  163. // logger.error(err);
  164. // }
  165. // }
  166. // }
  167. private async uploadFile(pageId: Types.ObjectId, pagePath: string, revisionBody: string): Promise<OpenAI.Files.FileObject> {
  168. const convertedHtml = await convertMarkdownToHtml({ pagePath, revisionBody });
  169. const file = await toFile(Readable.from(convertedHtml), `${pageId}.html`);
  170. const uploadedFile = await this.client.uploadFile(file);
  171. return uploadedFile;
  172. }
  173. private async deleteVectorStore(vectorStoreRelationId: string): Promise<void> {
  174. const vectorStoreDocument: VectorStoreDocument | null = await VectorStoreModel.findOne({ _id: vectorStoreRelationId, isDeleted: false });
  175. if (vectorStoreDocument == null) {
  176. return;
  177. }
  178. try {
  179. await this.client.deleteVectorStore(vectorStoreDocument.vectorStoreId);
  180. await vectorStoreDocument.markAsDeleted();
  181. }
  182. catch (err) {
  183. await openaiApiErrorHandler(err, { notFoundError: vectorStoreDocument.markAsDeleted });
  184. throw new Error(err);
  185. }
  186. }
  187. async createVectorStoreFile(vectorStoreRelation: VectorStoreDocument, pages: Array<HydratedDocument<PageDocument>>): Promise<void> {
  188. // const vectorStore = await this.getOrCreateVectorStoreForPublicScope();
  189. const vectorStoreFileRelationsMap: VectorStoreFileRelationsMap = new Map();
  190. const processUploadFile = async(page: HydratedDocument<PageDocument>) => {
  191. if (page._id != null && page.grant === PageGrant.GRANT_PUBLIC && page.revision != null) {
  192. if (isPopulated(page.revision) && page.revision.body.length > 0) {
  193. const uploadedFile = await this.uploadFile(page._id, page.path, page.revision.body);
  194. prepareVectorStoreFileRelations(vectorStoreRelation._id, page._id, uploadedFile.id, vectorStoreFileRelationsMap);
  195. return;
  196. }
  197. const pagePopulatedToShowRevision = await page.populateDataToShowRevision();
  198. if (pagePopulatedToShowRevision.revision != null && pagePopulatedToShowRevision.revision.body.length > 0) {
  199. const uploadedFile = await this.uploadFile(page._id, page.path, pagePopulatedToShowRevision.revision.body);
  200. prepareVectorStoreFileRelations(vectorStoreRelation._id, page._id, uploadedFile.id, vectorStoreFileRelationsMap);
  201. }
  202. }
  203. };
  204. // Start workers to process results
  205. const workers = pages.map(processUploadFile);
  206. // Wait for all processing to complete.
  207. assert(workers.length <= BATCH_SIZE, 'workers.length must be less than or equal to BATCH_SIZE');
  208. const fileUploadResult = await Promise.allSettled(workers);
  209. fileUploadResult.forEach((result) => {
  210. if (result.status === 'rejected') {
  211. logger.error(result.reason);
  212. }
  213. });
  214. const vectorStoreFileRelations = Array.from(vectorStoreFileRelationsMap.values());
  215. const uploadedFileIds = vectorStoreFileRelations.map(data => data.fileIds).flat();
  216. if (uploadedFileIds.length === 0) {
  217. return;
  218. }
  219. const pageIds = pages.map(page => page._id);
  220. try {
  221. // Save vector store file relation
  222. await VectorStoreFileRelationModel.upsertVectorStoreFileRelations(vectorStoreFileRelations);
  223. // Create vector store file
  224. const createVectorStoreFileBatchResponse = await this.client.createVectorStoreFileBatch(vectorStoreRelation.vectorStoreId, uploadedFileIds);
  225. logger.debug('Create vector store file', createVectorStoreFileBatchResponse);
  226. // Set isAttachedToVectorStore: true when the uploaded file is attached to VectorStore
  227. await VectorStoreFileRelationModel.markAsAttachedToVectorStore(pageIds);
  228. }
  229. catch (err) {
  230. logger.error(err);
  231. // Delete all uploaded files if createVectorStoreFileBatch fails
  232. for await (const pageId of pageIds) {
  233. await this.deleteVectorStoreFile(vectorStoreRelation._id, pageId);
  234. }
  235. }
  236. }
  237. // Deletes all VectorStore documents that are marked as deleted (isDeleted: true) and have no associated VectorStoreFileRelation documents
  238. async deleteObsolatedVectorStoreRelations(): Promise<void> {
  239. const deletedVectorStoreRelations = await VectorStoreModel.find({ isDeleted: true });
  240. if (deletedVectorStoreRelations.length === 0) {
  241. return;
  242. }
  243. const currentVectorStoreRelationIds: Types.ObjectId[] = await VectorStoreFileRelationModel.aggregate([
  244. {
  245. $group: {
  246. _id: '$vectorStoreRelationId',
  247. relationCount: { $sum: 1 },
  248. },
  249. },
  250. { $match: { relationCount: { $gt: 0 } } },
  251. { $project: { _id: 1 } },
  252. ]);
  253. if (currentVectorStoreRelationIds.length === 0) {
  254. return;
  255. }
  256. await VectorStoreModel.deleteMany({ _id: { $nin: currentVectorStoreRelationIds }, isDeleted: true });
  257. }
  258. async deleteVectorStoreFile(vectorStoreRelationId: Types.ObjectId, pageId: Types.ObjectId, apiCallInterval?: number): Promise<void> {
  259. // Delete vector store file and delete vector store file relation
  260. const vectorStoreFileRelation = await VectorStoreFileRelationModel.findOne({ vectorStoreRelationId, page: pageId });
  261. if (vectorStoreFileRelation == null) {
  262. return;
  263. }
  264. const deletedFileIds: string[] = [];
  265. for await (const fileId of vectorStoreFileRelation.fileIds) {
  266. try {
  267. const deleteFileResponse = await this.client.deleteFile(fileId);
  268. logger.debug('Delete vector store file', deleteFileResponse);
  269. deletedFileIds.push(fileId);
  270. if (apiCallInterval != null) {
  271. // sleep
  272. await new Promise(resolve => setTimeout(resolve, apiCallInterval));
  273. }
  274. }
  275. catch (err) {
  276. await openaiApiErrorHandler(err, { notFoundError: async() => { deletedFileIds.push(fileId) } });
  277. logger.error(err);
  278. }
  279. }
  280. const undeletedFileIds = vectorStoreFileRelation.fileIds.filter(fileId => !deletedFileIds.includes(fileId));
  281. if (undeletedFileIds.length === 0) {
  282. await vectorStoreFileRelation.remove();
  283. return;
  284. }
  285. vectorStoreFileRelation.fileIds = undeletedFileIds;
  286. await vectorStoreFileRelation.save();
  287. }
  288. async deleteObsoleteVectorStoreFile(limit: number, apiCallInterval: number): Promise<void> {
  289. // Retrieves all VectorStore documents that are marked as deleted
  290. const deletedVectorStoreRelations = await VectorStoreModel.find({ isDeleted: true });
  291. if (deletedVectorStoreRelations.length === 0) {
  292. return;
  293. }
  294. // Retrieves VectorStoreFileRelation documents associated with deleted VectorStore documents
  295. const obsoleteVectorStoreFileRelations = await VectorStoreFileRelationModel.find(
  296. { vectorStoreRelationId: { $in: deletedVectorStoreRelations.map(deletedVectorStoreRelation => deletedVectorStoreRelation._id) } },
  297. ).limit(limit);
  298. if (obsoleteVectorStoreFileRelations.length === 0) {
  299. return;
  300. }
  301. // Delete obsolete VectorStoreFile
  302. for await (const vectorStoreFileRelation of obsoleteVectorStoreFileRelations) {
  303. try {
  304. await this.deleteVectorStoreFile(vectorStoreFileRelation.vectorStoreRelationId, vectorStoreFileRelation.page, apiCallInterval);
  305. }
  306. catch (err) {
  307. logger.error(err);
  308. }
  309. }
  310. }
  311. // TODO: https://redmine.weseek.co.jp/issues/160332
  312. // async rebuildVectorStoreAll() {
  313. // await this.deleteVectorStore(VectorStoreScopeType.PUBLIC);
  314. // // Create all public pages VectorStoreFile
  315. // const Page = mongoose.model<HydratedDocument<PageDocument>, PageModel>('Page');
  316. // const pagesStream = Page.find({ grant: PageGrant.GRANT_PUBLIC }).populate('revision').cursor({ batch_size: BATCH_SIZE });
  317. // const batchStrem = createBatchStream(BATCH_SIZE);
  318. // const createVectorStoreFile = this.createVectorStoreFile.bind(this);
  319. // const createVectorStoreFileStream = new Transform({
  320. // objectMode: true,
  321. // async transform(chunk: HydratedDocument<PageDocument>[], encoding, callback) {
  322. // await createVectorStoreFile(chunk);
  323. // this.push(chunk);
  324. // callback();
  325. // },
  326. // });
  327. // await pipeline(pagesStream, batchStrem, createVectorStoreFileStream);
  328. // }
  329. // async rebuildVectorStore(page: HydratedDocument<PageDocument>) {
  330. // const vectorStore = await this.getOrCreateVectorStoreForPublicScope();
  331. // await this.deleteVectorStoreFile(vectorStore._id, page._id);
  332. // await this.createVectorStoreFile([page]);
  333. // }
  334. private async createVectorStoreFileWithStream(vectorStoreRelation: VectorStoreDocument, conditions: mongoose.FilterQuery<PageDocument>): Promise<void> {
  335. const Page = mongoose.model<HydratedDocument<PageDocument>, PageModel>('Page');
  336. const pagesStream = Page.find({ ...conditions })
  337. .populate('revision')
  338. .cursor({ batchSize: BATCH_SIZE });
  339. const batchStream = createBatchStream(BATCH_SIZE);
  340. const createVectorStoreFile = this.createVectorStoreFile.bind(this);
  341. const createVectorStoreFileStream = new Transform({
  342. objectMode: true,
  343. async transform(chunk: HydratedDocument<PageDocument>[], encoding, callback) {
  344. try {
  345. logger.debug('Search results of page paths', chunk.map(page => page.path));
  346. await createVectorStoreFile(vectorStoreRelation, chunk);
  347. this.push(chunk);
  348. callback();
  349. }
  350. catch (error) {
  351. callback(error);
  352. }
  353. },
  354. });
  355. await pipeline(pagesStream, batchStream, createVectorStoreFileStream);
  356. }
  357. private async createConditionForCreateAiAssistant(
  358. owner: AiAssistant['owner'],
  359. accessScope: AiAssistant['accessScope'],
  360. grantedGroupsForAccessScope: AiAssistant['grantedGroupsForAccessScope'],
  361. pagePathPatterns: AiAssistant['pagePathPatterns'],
  362. ): Promise<mongoose.FilterQuery<PageDocument>> {
  363. const converterdPagePathPatterns = convertPathPatternsToRegExp(pagePathPatterns);
  364. // Include pages in search targets when their paths with 'Anyone with the link' permission are directly specified instead of using glob pattern
  365. const nonGrabPagePathPatterns = pagePathPatterns.filter(pagePathPattern => !isGrobPatternPath(pagePathPattern));
  366. const baseCondition: mongoose.FilterQuery<PageDocument> = {
  367. grant: PageGrant.GRANT_RESTRICTED,
  368. path: { $in: nonGrabPagePathPatterns },
  369. };
  370. if (accessScope === AiAssistantAccessScope.PUBLIC_ONLY) {
  371. return {
  372. $or: [
  373. baseCondition,
  374. {
  375. grant: PageGrant.GRANT_PUBLIC,
  376. path: { $in: converterdPagePathPatterns },
  377. },
  378. ],
  379. };
  380. }
  381. if (accessScope === AiAssistantAccessScope.GROUPS) {
  382. if (grantedGroupsForAccessScope == null || grantedGroupsForAccessScope.length === 0) {
  383. throw new Error('grantedGroups is required when accessScope is GROUPS');
  384. }
  385. const extractedGrantedGroupIdsForAccessScope = grantedGroupsForAccessScope.map(group => getIdForRef(group.item).toString());
  386. return {
  387. $or: [
  388. baseCondition,
  389. {
  390. grant: { $in: [PageGrant.GRANT_PUBLIC, PageGrant.GRANT_USER_GROUP] },
  391. path: { $in: converterdPagePathPatterns },
  392. $or: [
  393. { 'grantedGroups.item': { $in: extractedGrantedGroupIdsForAccessScope } },
  394. { grant: PageGrant.GRANT_PUBLIC },
  395. ],
  396. },
  397. ],
  398. };
  399. }
  400. if (accessScope === AiAssistantAccessScope.OWNER) {
  401. const ownerUserGroups = [
  402. ...(await UserGroupRelation.findAllUserGroupIdsRelatedToUser(owner)),
  403. ...(await ExternalUserGroupRelation.findAllUserGroupIdsRelatedToUser(owner)),
  404. ].map(group => group.toString());
  405. return {
  406. $or: [
  407. baseCondition,
  408. {
  409. grant: { $in: [PageGrant.GRANT_PUBLIC, PageGrant.GRANT_USER_GROUP, PageGrant.GRANT_OWNER] },
  410. path: { $in: converterdPagePathPatterns },
  411. $or: [
  412. { 'grantedGroups.item': { $in: ownerUserGroups } },
  413. { grantedUsers: { $in: [getIdForRef(owner)] } },
  414. { grant: PageGrant.GRANT_PUBLIC },
  415. ],
  416. },
  417. ],
  418. };
  419. }
  420. throw new Error('Invalid accessScope value');
  421. }
  422. private async validateGrantedUserGroupsForCreateAiAssistant(
  423. owner: AiAssistant['owner'],
  424. shareScope: AiAssistant['shareScope'],
  425. accessScope: AiAssistant['accessScope'],
  426. grantedGroupsForShareScope: AiAssistant['grantedGroupsForShareScope'],
  427. grantedGroupsForAccessScope: AiAssistant['grantedGroupsForAccessScope'],
  428. ) {
  429. // Check if grantedGroupsForShareScope is not specified when shareScope is not a “group”
  430. if (shareScope !== AiAssistantShareScope.GROUPS && grantedGroupsForShareScope != null) {
  431. throw new Error('grantedGroupsForShareScope is specified when shareScope is not “groups”.');
  432. }
  433. // Check if grantedGroupsForAccessScope is not specified when accessScope is not a “group”
  434. if (accessScope !== AiAssistantAccessScope.GROUPS && grantedGroupsForAccessScope != null) {
  435. throw new Error('grantedGroupsForAccessScope is specified when accsessScope is not “groups”.');
  436. }
  437. const ownerUserGroupIds = [
  438. ...(await UserGroupRelation.findAllUserGroupIdsRelatedToUser(owner)),
  439. ...(await ExternalUserGroupRelation.findAllUserGroupIdsRelatedToUser(owner)),
  440. ].map(group => group.toString());
  441. // Check if the owner belongs to the group specified in grantedGroupsForShareScope
  442. if (grantedGroupsForShareScope != null && grantedGroupsForShareScope.length > 0) {
  443. const extractedGrantedGroupIdsForShareScope = grantedGroupsForShareScope.map(group => getIdForRef(group.item).toString());
  444. const isValid = extractedGrantedGroupIdsForShareScope.every(groupId => ownerUserGroupIds.includes(groupId));
  445. if (!isValid) {
  446. throw new Error('A userGroup to which the owner does not belong is specified in grantedGroupsForShareScope');
  447. }
  448. }
  449. // Check if the owner belongs to the group specified in grantedGroupsForAccessScope
  450. if (grantedGroupsForAccessScope != null && grantedGroupsForAccessScope.length > 0) {
  451. const extractedGrantedGroupIdsForAccessScope = grantedGroupsForAccessScope.map(group => getIdForRef(group.item).toString());
  452. const isValid = extractedGrantedGroupIdsForAccessScope.every(groupId => ownerUserGroupIds.includes(groupId));
  453. if (!isValid) {
  454. throw new Error('A userGroup to which the owner does not belong is specified in grantedGroupsForAccessScope');
  455. }
  456. }
  457. }
  458. async createAiAssistant(data: Omit<AiAssistant, 'vectorStore'>): Promise<AiAssistantDocument> {
  459. await this.validateGrantedUserGroupsForCreateAiAssistant(
  460. data.owner,
  461. data.shareScope,
  462. data.accessScope,
  463. data.grantedGroupsForShareScope,
  464. data.grantedGroupsForAccessScope,
  465. );
  466. const conditions = await this.createConditionForCreateAiAssistant(
  467. data.owner,
  468. data.accessScope,
  469. data.grantedGroupsForAccessScope,
  470. data.pagePathPatterns,
  471. );
  472. const vectorStoreRelation = await this.createVectorStore(data.name);
  473. const aiAssistant = await AiAssistantModel.create({
  474. ...data, vectorStore: vectorStoreRelation,
  475. });
  476. // VectorStore creation process does not await
  477. this.createVectorStoreFileWithStream(vectorStoreRelation, conditions);
  478. return aiAssistant;
  479. }
  480. async getAccessibleAiAssistants(user: IUserHasId): Promise<AccessibleAiAssistants> {
  481. const userGroupIds = [
  482. ...(await UserGroupRelation.findAllUserGroupIdsRelatedToUser(user)),
  483. ...(await ExternalUserGroupRelation.findAllUserGroupIdsRelatedToUser(user)),
  484. ];
  485. const assistants = await AiAssistantModel.find({
  486. $or: [
  487. // Case 1: Assistants owned by the user
  488. { owner: user },
  489. // Case 2: Public assistants owned by others
  490. {
  491. $and: [
  492. { owner: { $ne: user } },
  493. { shareScope: AiAssistantShareScope.PUBLIC_ONLY },
  494. ],
  495. },
  496. // Case 3: Group-restricted assistants where user is in granted groups
  497. {
  498. $and: [
  499. { owner: { $ne: user } },
  500. { shareScope: AiAssistantShareScope.GROUPS },
  501. { 'grantedGroupsForShareScope.item': { $in: userGroupIds } },
  502. ],
  503. },
  504. ],
  505. });
  506. return {
  507. myAiAssistants: assistants.filter(assistant => assistant.owner.toString() === user._id.toString()) ?? [],
  508. teamAiAssistants: assistants.filter(assistant => assistant.owner.toString() !== user._id.toString()) ?? [],
  509. };
  510. }
  511. async deleteAiAssistant(ownerId: string, aiAssistantId: string): Promise<AiAssistantDocument> {
  512. const aiAssistant = await AiAssistantModel.findOne({ owner: ownerId, _id: aiAssistantId });
  513. if (aiAssistant == null) {
  514. throw new Error('AiAssistant document does not exist');
  515. }
  516. const vectorStoreRelationId = getIdStringForRef(aiAssistant.vectorStore);
  517. await this.deleteVectorStore(vectorStoreRelationId);
  518. const deletedAiAssistant = await aiAssistant.remove();
  519. return deletedAiAssistant;
  520. }
  521. }
  522. let instance: OpenaiService;
  523. export const getOpenaiService = (): IOpenaiService | undefined => {
  524. if (instance != null) {
  525. return instance;
  526. }
  527. const aiEnabled = configManager.getConfig('app:aiEnabled');
  528. const openaiServiceType = configManager.getConfig('openai:serviceType');
  529. if (aiEnabled && openaiServiceType != null && OpenaiServiceTypes.includes(openaiServiceType)) {
  530. instance = new OpenaiService();
  531. return instance;
  532. }
  533. return;
  534. };