index.tsx 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  1. 'use client'
  2. import { useState } from 'react'
  3. import { useMount } from 'ahooks'
  4. import { useContext } from 'use-context-selector'
  5. import { BookOpenIcon } from '@heroicons/react/24/outline'
  6. import { useTranslation } from 'react-i18next'
  7. import { useSWRConfig } from 'swr'
  8. import { unstable_serialize } from 'swr/infinite'
  9. import PermissionSelector from '../permission-selector'
  10. import IndexMethodRadio from '../index-method-radio'
  11. import RetrievalSettings from '../../external-knowledge-base/create/RetrievalSettings'
  12. import cn from '@/utils/classnames'
  13. import RetrievalMethodConfig from '@/app/components/datasets/common/retrieval-method-config'
  14. import EconomicalRetrievalMethodConfig from '@/app/components/datasets/common/economical-retrieval-method-config'
  15. import { ToastContext } from '@/app/components/base/toast'
  16. import Button from '@/app/components/base/button'
  17. import Divider from '@/app/components/base/divider'
  18. import { ApiConnectionMod } from '@/app/components/base/icons/src/vender/solid/development'
  19. import { updateDatasetSetting } from '@/service/datasets'
  20. import type { DataSetListResponse } from '@/models/datasets'
  21. import DatasetDetailContext from '@/context/dataset-detail'
  22. import { type RetrievalConfig } from '@/types/app'
  23. import { useAppContext } from '@/context/app-context'
  24. import { ensureRerankModelSelected, isReRankModelSelected } from '@/app/components/datasets/common/check-rerank-model'
  25. import ModelSelector from '@/app/components/header/account-setting/model-provider-page/model-selector'
  26. import {
  27. useModelList,
  28. useModelListAndDefaultModelAndCurrentProviderAndModel,
  29. } from '@/app/components/header/account-setting/model-provider-page/hooks'
  30. import type { DefaultModel } from '@/app/components/header/account-setting/model-provider-page/declarations'
  31. import { ModelTypeEnum } from '@/app/components/header/account-setting/model-provider-page/declarations'
  32. import { fetchMembers } from '@/service/common'
  33. import type { Member } from '@/models/common'
  34. const rowClass = `
  35. flex justify-between py-4 flex-wrap gap-y-2
  36. `
  37. const labelClass = `
  38. flex items-center w-[168px] h-9
  39. `
  40. const inputClass = `
  41. w-full max-w-[480px] px-3 bg-gray-100 text-sm text-gray-800 rounded-lg outline-none appearance-none
  42. `
  43. const getKey = (pageIndex: number, previousPageData: DataSetListResponse) => {
  44. if (!pageIndex || previousPageData.has_more)
  45. return { url: 'datasets', params: { page: pageIndex + 1, limit: 30 } }
  46. return null
  47. }
  48. const Form = () => {
  49. const { t } = useTranslation()
  50. const { notify } = useContext(ToastContext)
  51. const { mutate } = useSWRConfig()
  52. const { isCurrentWorkspaceDatasetOperator } = useAppContext()
  53. const { dataset: currentDataset, mutateDatasetRes: mutateDatasets } = useContext(DatasetDetailContext)
  54. const [loading, setLoading] = useState(false)
  55. const [name, setName] = useState(currentDataset?.name ?? '')
  56. const [description, setDescription] = useState(currentDataset?.description ?? '')
  57. const [permission, setPermission] = useState(currentDataset?.permission)
  58. const [topK, setTopK] = useState(currentDataset?.external_retrieval_model.top_k ?? 2)
  59. const [scoreThreshold, setScoreThreshold] = useState(currentDataset?.external_retrieval_model.score_threshold ?? 0.5)
  60. const [scoreThresholdEnabled, setScoreThresholdEnabled] = useState(currentDataset?.external_retrieval_model.score_threshold_enabled ?? false)
  61. const [selectedMemberIDs, setSelectedMemberIDs] = useState<string[]>(currentDataset?.partial_member_list || [])
  62. const [memberList, setMemberList] = useState<Member[]>([])
  63. const [indexMethod, setIndexMethod] = useState(currentDataset?.indexing_technique)
  64. const [retrievalConfig, setRetrievalConfig] = useState(currentDataset?.retrieval_model_dict as RetrievalConfig)
  65. const [embeddingModel, setEmbeddingModel] = useState<DefaultModel>(
  66. currentDataset?.embedding_model
  67. ? {
  68. provider: currentDataset.embedding_model_provider,
  69. model: currentDataset.embedding_model,
  70. }
  71. : {
  72. provider: '',
  73. model: '',
  74. },
  75. )
  76. const {
  77. modelList: rerankModelList,
  78. defaultModel: rerankDefaultModel,
  79. currentModel: isRerankDefaultModelValid,
  80. } = useModelListAndDefaultModelAndCurrentProviderAndModel(ModelTypeEnum.rerank)
  81. const { data: embeddingModelList } = useModelList(ModelTypeEnum.textEmbedding)
  82. const getMembers = async () => {
  83. const { accounts } = await fetchMembers({ url: '/workspaces/current/members', params: {} })
  84. if (!accounts)
  85. setMemberList([])
  86. else
  87. setMemberList(accounts)
  88. }
  89. const handleSettingsChange = (data: { top_k?: number; score_threshold?: number; score_threshold_enabled?: boolean }) => {
  90. if (data.top_k !== undefined)
  91. setTopK(data.top_k)
  92. if (data.score_threshold !== undefined)
  93. setScoreThreshold(data.score_threshold)
  94. if (data.score_threshold_enabled !== undefined)
  95. setScoreThresholdEnabled(data.score_threshold_enabled)
  96. }
  97. useMount(() => {
  98. getMembers()
  99. })
  100. const handleSave = async () => {
  101. if (loading)
  102. return
  103. if (!name?.trim()) {
  104. notify({ type: 'error', message: t('datasetSettings.form.nameError') })
  105. return
  106. }
  107. if (
  108. !isReRankModelSelected({
  109. rerankDefaultModel,
  110. isRerankDefaultModelValid: !!isRerankDefaultModelValid,
  111. rerankModelList,
  112. retrievalConfig,
  113. indexMethod,
  114. })
  115. ) {
  116. notify({ type: 'error', message: t('appDebug.datasetConfig.rerankModelRequired') })
  117. return
  118. }
  119. const postRetrievalConfig = ensureRerankModelSelected({
  120. rerankDefaultModel: rerankDefaultModel!,
  121. retrievalConfig,
  122. indexMethod,
  123. })
  124. if (postRetrievalConfig.weights) {
  125. postRetrievalConfig.weights.vector_setting.embedding_provider_name = currentDataset?.embedding_model_provider || ''
  126. postRetrievalConfig.weights.vector_setting.embedding_model_name = currentDataset?.embedding_model || ''
  127. }
  128. try {
  129. setLoading(true)
  130. const requestParams = {
  131. datasetId: currentDataset!.id,
  132. body: {
  133. name,
  134. description,
  135. permission,
  136. indexing_technique: indexMethod,
  137. retrieval_model: {
  138. ...postRetrievalConfig,
  139. score_threshold: postRetrievalConfig.score_threshold_enabled ? postRetrievalConfig.score_threshold : 0,
  140. },
  141. embedding_model: embeddingModel.model,
  142. embedding_model_provider: embeddingModel.provider,
  143. ...(currentDataset!.provider === 'external' && {
  144. external_knowledge_id: currentDataset!.external_knowledge_info.external_knowledge_id,
  145. external_knowledge_api_id: currentDataset!.external_knowledge_info.external_knowledge_api_id,
  146. external_retrieval_model: {
  147. top_k: topK,
  148. score_threshold: scoreThreshold,
  149. score_threshold_enabled: scoreThresholdEnabled,
  150. },
  151. }),
  152. },
  153. } as any
  154. if (permission === 'partial_members') {
  155. requestParams.body.partial_member_list = selectedMemberIDs.map((id) => {
  156. return {
  157. user_id: id,
  158. role: memberList.find(member => member.id === id)?.role,
  159. }
  160. })
  161. }
  162. await updateDatasetSetting(requestParams)
  163. notify({ type: 'success', message: t('common.actionMsg.modifiedSuccessfully') })
  164. if (mutateDatasets) {
  165. await mutateDatasets()
  166. mutate(unstable_serialize(getKey))
  167. }
  168. }
  169. catch (e) {
  170. notify({ type: 'error', message: t('common.actionMsg.modifiedUnsuccessfully') })
  171. }
  172. finally {
  173. setLoading(false)
  174. }
  175. }
  176. return (
  177. <div className='w-full sm:w-[800px] p-4 sm:px-16 sm:py-6'>
  178. <div className={rowClass}>
  179. <div className={labelClass}>
  180. <div className='text-text-secondary system-sm-semibold'>{t('datasetSettings.form.name')}</div>
  181. </div>
  182. <div className='w-full max-w-[480px]'>
  183. <input
  184. disabled={!currentDataset?.embedding_available}
  185. className={cn(inputClass, !currentDataset?.embedding_available && 'opacity-60', 'h-9')}
  186. value={name}
  187. onChange={e => setName(e.target.value)}
  188. />
  189. </div>
  190. </div>
  191. <div className={rowClass}>
  192. <div className={labelClass}>
  193. <div className='text-text-secondary system-sm-semibold'>{t('datasetSettings.form.desc')}</div>
  194. </div>
  195. <div className='w-full max-w-[480px]'>
  196. <textarea
  197. disabled={!currentDataset?.embedding_available}
  198. className={cn(`${inputClass} block mb-2 h-[120px] py-2 resize-none`, !currentDataset?.embedding_available && 'opacity-60')}
  199. placeholder={t('datasetSettings.form.descPlaceholder') || ''}
  200. value={description}
  201. onChange={e => setDescription(e.target.value)}
  202. />
  203. <a className='flex items-center h-[18px] px-3 text-xs text-gray-500' href="https://docs.dify.ai/features/datasets#how-to-write-a-good-dataset-description" target='_blank' rel='noopener noreferrer'>
  204. <BookOpenIcon className='w-3 h-[18px] mr-1' />
  205. {t('datasetSettings.form.descWrite')}
  206. </a>
  207. </div>
  208. </div>
  209. <div className={rowClass}>
  210. <div className={labelClass}>
  211. <div className='text-text-secondary system-sm-semibold'>{t('datasetSettings.form.permissions')}</div>
  212. </div>
  213. <div className='w-full sm:w-[480px]'>
  214. <PermissionSelector
  215. disabled={!currentDataset?.embedding_available || isCurrentWorkspaceDatasetOperator}
  216. permission={permission}
  217. value={selectedMemberIDs}
  218. onChange={v => setPermission(v)}
  219. onMemberSelect={setSelectedMemberIDs}
  220. memberList={memberList}
  221. />
  222. </div>
  223. </div>
  224. {currentDataset && currentDataset.indexing_technique && (
  225. <>
  226. <div className='w-full h-0 border-b-[0.5px] border-b-gray-200 my-2' />
  227. <div className={rowClass}>
  228. <div className={labelClass}>
  229. <div className='text-text-secondary system-sm-semibold'>{t('datasetSettings.form.indexMethod')}</div>
  230. </div>
  231. <div className='w-full sm:w-[480px]'>
  232. <IndexMethodRadio
  233. disable={!currentDataset?.embedding_available}
  234. value={indexMethod}
  235. onChange={v => setIndexMethod(v)}
  236. />
  237. </div>
  238. </div>
  239. </>
  240. )}
  241. {indexMethod === 'high_quality' && (
  242. <div className={rowClass}>
  243. <div className={labelClass}>
  244. <div className='text-text-secondary system-sm-semibold'>{t('datasetSettings.form.embeddingModel')}</div>
  245. </div>
  246. <div className='w-[480px]'>
  247. <ModelSelector
  248. triggerClassName=''
  249. defaultModel={embeddingModel}
  250. modelList={embeddingModelList}
  251. onSelect={(model: DefaultModel) => {
  252. setEmbeddingModel(model)
  253. }}
  254. />
  255. </div>
  256. </div>
  257. )}
  258. {/* Retrieval Method Config */}
  259. {currentDataset?.provider === 'external'
  260. ? <>
  261. <div className={rowClass}><Divider/></div>
  262. <div className={rowClass}>
  263. <div className={labelClass}>
  264. <div className='text-text-secondary system-sm-semibold'>{t('datasetSettings.form.retrievalSetting.title')}</div>
  265. </div>
  266. <RetrievalSettings
  267. topK={topK}
  268. scoreThreshold={scoreThreshold}
  269. scoreThresholdEnabled={scoreThresholdEnabled}
  270. onChange={handleSettingsChange}
  271. isInRetrievalSetting={true}
  272. />
  273. </div>
  274. <div className={rowClass}><Divider/></div>
  275. <div className={rowClass}>
  276. <div className={labelClass}>
  277. <div className='text-text-secondary system-sm-semibold'>{t('datasetSettings.form.externalKnowledgeAPI')}</div>
  278. </div>
  279. <div className='w-full max-w-[480px]'>
  280. <div className='flex h-full px-3 py-2 items-center gap-1 rounded-lg bg-components-input-bg-normal'>
  281. <ApiConnectionMod className='w-4 h-4 text-text-secondary' />
  282. <div className='overflow-hidden text-text-secondary text-ellipsis system-sm-medium'>
  283. {currentDataset?.external_knowledge_info.external_knowledge_api_name}
  284. </div>
  285. <div className='text-text-tertiary system-xs-regular'>·</div>
  286. <div className='text-text-tertiary system-xs-regular'>{currentDataset?.external_knowledge_info.external_knowledge_api_endpoint}</div>
  287. </div>
  288. </div>
  289. </div>
  290. <div className={rowClass}>
  291. <div className={labelClass}>
  292. <div className='text-text-secondary system-sm-semibold'>{t('datasetSettings.form.externalKnowledgeID')}</div>
  293. </div>
  294. <div className='w-full max-w-[480px]'>
  295. <div className='flex h-full px-3 py-2 items-center gap-1 rounded-lg bg-components-input-bg-normal'>
  296. <div className='text-text-tertiary system-xs-regular'>{currentDataset?.external_knowledge_info.external_knowledge_id}</div>
  297. </div>
  298. </div>
  299. </div>
  300. <div className={rowClass}><Divider/></div>
  301. </>
  302. : <div className={rowClass}>
  303. <div className={labelClass}>
  304. <div>
  305. <div className='text-text-secondary system-sm-semibold'>{t('datasetSettings.form.retrievalSetting.title')}</div>
  306. <div className='leading-[18px] text-xs font-normal text-gray-500'>
  307. <a target='_blank' rel='noopener noreferrer' href='https://docs.dify.ai/guides/knowledge-base/create-knowledge-and-upload-documents#id-4-retrieval-settings' className='text-[#155eef]'>{t('datasetSettings.form.retrievalSetting.learnMore')}</a>
  308. {t('datasetSettings.form.retrievalSetting.description')}
  309. </div>
  310. </div>
  311. </div>
  312. <div className='w-[480px]'>
  313. {indexMethod === 'high_quality'
  314. ? (
  315. <RetrievalMethodConfig
  316. value={retrievalConfig}
  317. onChange={setRetrievalConfig}
  318. />
  319. )
  320. : (
  321. <EconomicalRetrievalMethodConfig
  322. value={retrievalConfig}
  323. onChange={setRetrievalConfig}
  324. />
  325. )}
  326. </div>
  327. </div>
  328. }
  329. <div className={rowClass}>
  330. <div className={labelClass} />
  331. <div className='w-[480px]'>
  332. <Button
  333. className='min-w-24'
  334. variant='primary'
  335. onClick={handleSave}
  336. >
  337. {t('datasetSettings.form.save')}
  338. </Button>
  339. </div>
  340. </div>
  341. </div>
  342. )
  343. }
  344. export default Form