knowledge-assistant.tsx 11 KB

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