knowledge-assistant.tsx 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  1. import type { Dispatch, SetStateAction } from 'react';
  2. import {
  3. useCallback, useMemo, useState, useEffect,
  4. } from 'react';
  5. import { useForm, type UseFormReturn } from 'react-hook-form';
  6. import { useTranslation } from 'react-i18next';
  7. import {
  8. UncontrolledTooltip, Dropdown, DropdownToggle, DropdownMenu, DropdownItem,
  9. } from 'reactstrap';
  10. import { apiv3Post } from '~/client/util/apiv3-client';
  11. import {
  12. SseMessageSchema, type SseMessage, SsePreMessageSchema, type SsePreMessage,
  13. } from '~/features/openai/interfaces/knowledge-assistant/sse-schemas';
  14. import { handleIfSuccessfullyParsed } from '~/features/openai/utils/handle-if-successfully-parsed';
  15. import type { MessageLog, MessageWithCustomMetaData } from '../../interfaces/message';
  16. import type { IThreadRelationHasId } from '../../interfaces/thread-relation';
  17. import { ThreadType } from '../../interfaces/thread-relation';
  18. import { AiAssistantChatInitialView } from '../components/AiAssistant/AiAssistantSidebar/AiAssistantChatInitialView';
  19. import { useAiAssistantSidebar } from '../stores/ai-assistant';
  20. import { useSWRMUTxMessages } from '../stores/message';
  21. import { useSWRMUTxThreads } from '../stores/thread';
  22. interface CreateThread {
  23. (aiAssistantId: string, initialUserMessage: string): Promise<IThreadRelationHasId>;
  24. }
  25. interface PostMessage {
  26. (aiAssistantId: string, threadId: string, formData: FormData): Promise<Response>;
  27. }
  28. interface ProcessMessage {
  29. (data: unknown, handler: {
  30. onMessage: (data: SseMessage) => void
  31. onPreMessage: (data: SsePreMessage) => void
  32. }
  33. ): void;
  34. }
  35. export interface FormData {
  36. input: string
  37. summaryMode?: boolean
  38. extendedThinkingMode?: boolean
  39. }
  40. interface GenerateModeSwitchesDropdown {
  41. (isGenerating: boolean): JSX.Element
  42. }
  43. type UseKnowledgeAssistant = () => {
  44. createThread: CreateThread
  45. postMessage: PostMessage
  46. processMessage: ProcessMessage
  47. form: UseFormReturn<FormData>
  48. resetForm: () => void
  49. // Views
  50. initialView: JSX.Element
  51. generateModeSwitchesDropdown: GenerateModeSwitchesDropdown
  52. headerIcon: JSX.Element
  53. headerText: JSX.Element
  54. placeHolder: string
  55. }
  56. export const useKnowledgeAssistant: UseKnowledgeAssistant = () => {
  57. // Hooks
  58. const { data: aiAssistantSidebarData } = useAiAssistantSidebar();
  59. const { aiAssistantData } = aiAssistantSidebarData ?? {};
  60. const { threadData } = aiAssistantSidebarData ?? {};
  61. const { trigger: mutateThreadData } = useSWRMUTxThreads(aiAssistantData?._id);
  62. const { t } = useTranslation();
  63. const form = useForm<FormData>({
  64. defaultValues: {
  65. input: '',
  66. summaryMode: true,
  67. extendedThinkingMode: false,
  68. },
  69. });
  70. // States
  71. const [currentThreadTitle, setCurrentThreadId] = useState(threadData?.title);
  72. // Functions
  73. const resetForm = useCallback(() => {
  74. const summaryMode = form.getValues('summaryMode');
  75. const extendedThinkingMode = form.getValues('extendedThinkingMode');
  76. form.reset({ input: '', summaryMode, extendedThinkingMode });
  77. }, [form]);
  78. const createThread: CreateThread = useCallback(async(aiAssistantId, initialUserMessage) => {
  79. const response = await apiv3Post<IThreadRelationHasId>('/openai/thread', {
  80. type: ThreadType.KNOWLEDGE,
  81. aiAssistantId,
  82. initialUserMessage,
  83. });
  84. const thread = response.data;
  85. setCurrentThreadId(thread.title);
  86. // No need to await because data is not used
  87. mutateThreadData();
  88. return thread;
  89. }, [mutateThreadData]);
  90. const postMessage: PostMessage = useCallback(async(aiAssistantId, threadId, formData) => {
  91. const response = await fetch('/_api/v3/openai/message', {
  92. method: 'POST',
  93. headers: { 'Content-Type': 'application/json' },
  94. body: JSON.stringify({
  95. aiAssistantId,
  96. threadId,
  97. userMessage: formData.input,
  98. summaryMode: form.getValues('summaryMode'),
  99. extendedThinkingMode: form.getValues('extendedThinkingMode'),
  100. }),
  101. });
  102. return response;
  103. }, [form]);
  104. const processMessage: ProcessMessage = useCallback((data, handler) => {
  105. handleIfSuccessfullyParsed(data, SseMessageSchema, (data: SseMessage) => {
  106. handler.onMessage(data);
  107. });
  108. handleIfSuccessfullyParsed(data, SsePreMessageSchema, (data: SsePreMessage) => {
  109. handler.onPreMessage(data);
  110. });
  111. }, []);
  112. // Views
  113. const headerIcon = useMemo(() => {
  114. return <span className="growi-custom-icons growi-ai-chat-icon me-3 fs-4">ai_assistant</span>;
  115. }, []);
  116. const headerText = useMemo(() => {
  117. return <>{currentThreadTitle ?? aiAssistantData?.name}</>;
  118. }, [aiAssistantData?.name, currentThreadTitle]);
  119. const placeHolder = useMemo(() => { return 'sidebar_ai_assistant.knowledge_assistant_placeholder' }, []);
  120. const initialView = useMemo(() => {
  121. if (aiAssistantSidebarData?.aiAssistantData == null) {
  122. return <></>;
  123. }
  124. return (
  125. <AiAssistantChatInitialView
  126. description={aiAssistantSidebarData.aiAssistantData.description}
  127. pagePathPatterns={aiAssistantSidebarData.aiAssistantData.pagePathPatterns}
  128. />
  129. );
  130. }, [aiAssistantSidebarData?.aiAssistantData]);
  131. const [dropdownOpen, setDropdownOpen] = useState(false);
  132. const toggleDropdown = useCallback(() => {
  133. setDropdownOpen(prevState => !prevState);
  134. }, []);
  135. const generateModeSwitchesDropdown: GenerateModeSwitchesDropdown = useCallback((isGenerating) => {
  136. return (
  137. <Dropdown isOpen={dropdownOpen} toggle={toggleDropdown} direction="up">
  138. <DropdownToggle size="sm" outline className="border-0">
  139. <span className="material-symbols-outlined">tune</span>
  140. </DropdownToggle>
  141. <DropdownMenu>
  142. <DropdownItem tag="div" toggle={false}>
  143. <div className="form-check form-switch">
  144. <input
  145. id="swSummaryMode"
  146. type="checkbox"
  147. role="switch"
  148. className="form-check-input"
  149. {...form.register('summaryMode')}
  150. disabled={form.formState.isSubmitting || isGenerating}
  151. />
  152. <label className="form-check-label" htmlFor="swSummaryMode">
  153. {t('sidebar_ai_assistant.summary_mode_label')}
  154. </label>
  155. <a
  156. id="tooltipForHelpOfSummaryMode"
  157. role="button"
  158. className="ms-1"
  159. >
  160. <span className="material-symbols-outlined fs-6" style={{ lineHeight: 'unset' }}>help</span>
  161. </a>
  162. <UncontrolledTooltip
  163. target="tooltipForHelpOfSummaryMode"
  164. >
  165. {t('sidebar_ai_assistant.summary_mode_help')}
  166. </UncontrolledTooltip>
  167. </div>
  168. </DropdownItem>
  169. <DropdownItem tag="div" toggle={false}>
  170. <div className="form-check form-switch">
  171. <input
  172. id="swExtendedThinkingMode"
  173. type="checkbox"
  174. role="switch"
  175. className="form-check-input"
  176. {...form.register('extendedThinkingMode')}
  177. disabled={form.formState.isSubmitting || isGenerating}
  178. />
  179. <label className="form-check-label" htmlFor="swExtendedThinkingMode">
  180. {t('sidebar_ai_assistant.extended_thinking_mode_label')}
  181. </label>
  182. <a
  183. id="tooltipForHelpOfExtendedThinkingMode"
  184. role="button"
  185. className="ms-1"
  186. >
  187. <span className="material-symbols-outlined fs-6" style={{ lineHeight: 'unset' }}>help</span>
  188. </a>
  189. <UncontrolledTooltip
  190. target="tooltipForHelpOfExtendedThinkingMode"
  191. >
  192. {t('sidebar_ai_assistant.extended_thinking_mode_help')}
  193. </UncontrolledTooltip>
  194. </div>
  195. </DropdownItem>
  196. </DropdownMenu>
  197. </Dropdown>
  198. );
  199. }, [dropdownOpen, toggleDropdown, form, t]);
  200. return {
  201. createThread,
  202. postMessage,
  203. processMessage,
  204. form,
  205. resetForm,
  206. // Views
  207. initialView,
  208. // generateMessageCard,
  209. generateModeSwitchesDropdown,
  210. headerIcon,
  211. headerText,
  212. placeHolder,
  213. };
  214. };
  215. // Helper function to transform API message data to MessageLog[]
  216. const transformApiMessagesToLogs = (
  217. apiMessageData: MessageWithCustomMetaData | null | undefined,
  218. ): MessageLog[] => {
  219. if (apiMessageData?.data == null || !Array.isArray(apiMessageData.data)) {
  220. return [];
  221. }
  222. // Define a type for the items in apiMessageData.data for clarity
  223. type ApiMessageItem = (typeof apiMessageData.data)[number];
  224. return apiMessageData.data
  225. .slice() // Create a shallow copy before reversing
  226. .reverse()
  227. .filter((message: ApiMessageItem) => message.metadata?.shouldHideMessage !== 'true')
  228. .map((message: ApiMessageItem): MessageLog => {
  229. // Extract the first text content block, if any
  230. let messageTextContent = '';
  231. const textContentBlock = message.content?.find(contentBlock => contentBlock.type === 'text');
  232. if (textContentBlock != null && textContentBlock.type === 'text') {
  233. messageTextContent = textContentBlock.text.value;
  234. }
  235. return {
  236. id: message.id, // Use the actual message ID from OpenAI
  237. content: messageTextContent,
  238. isUserMessage: message.role === 'user',
  239. };
  240. });
  241. };
  242. export const useFetchAndSetMessageDataEffect = (
  243. setMessageLogs: Dispatch<SetStateAction<MessageLog[]>>,
  244. threadId?: string,
  245. ): void => {
  246. const { data: aiAssistantSidebarData } = useAiAssistantSidebar();
  247. const { trigger: mutateMessageData } = useSWRMUTxMessages(
  248. aiAssistantSidebarData?.aiAssistantData?._id,
  249. threadId,
  250. );
  251. useEffect(() => {
  252. if (aiAssistantSidebarData?.isEditorAssistant) {
  253. return;
  254. }
  255. if (threadId == null) {
  256. setMessageLogs([]);
  257. return; // Early return if no threadId
  258. }
  259. const fetchAndSetLogs = async() => {
  260. try {
  261. // Assuming mutateMessageData() returns a Promise<MessageWithCustomMetaData | null | undefined>
  262. const rawApiMessageData: MessageWithCustomMetaData | null | undefined = await mutateMessageData();
  263. const fetchedLogs = transformApiMessagesToLogs(rawApiMessageData);
  264. setMessageLogs((currentLogs) => {
  265. // Preserve current logs if they represent a single, user-submitted message
  266. // AND the newly fetched logs are empty (common for new threads).
  267. const shouldPreserveCurrentMessage = currentLogs.length === 1
  268. && currentLogs[0].isUserMessage
  269. && fetchedLogs.length === 0;
  270. // Update with fetched logs, or preserve current if applicable
  271. return shouldPreserveCurrentMessage ? currentLogs : fetchedLogs;
  272. });
  273. }
  274. catch (error) {
  275. // console.error('Failed to fetch or process message data:', error); // Optional: for debugging
  276. setMessageLogs([]); // Clear logs on error to avoid inconsistent state
  277. }
  278. };
  279. fetchAndSetLogs();
  280. }, [threadId, mutateMessageData, setMessageLogs, aiAssistantSidebarData?.isEditorAssistant]); // Dependencies
  281. };