feat: Update retrieval method configuration to use new OptionCard component and improve layout

pull/21398/head
twwu 1 year ago
parent 4d68aadc1c
commit 0a891e5392

@ -2,12 +2,12 @@
import type { FC } from 'react' import type { FC } from 'react'
import React from 'react' import React from 'react'
import { useTranslation } from 'react-i18next' import { useTranslation } from 'react-i18next'
import Image from 'next/image'
import RetrievalParamConfig from '../retrieval-param-config' import RetrievalParamConfig from '../retrieval-param-config'
import { OptionCard } from '../../create/step-two/option-card'
import { retrievalIcon } from '../../create/icons'
import { RETRIEVE_METHOD } from '@/types/app' import { RETRIEVE_METHOD } from '@/types/app'
import type { RetrievalConfig } from '@/types/app' import type { RetrievalConfig } from '@/types/app'
import OptionCard from '../../settings/option-card'
import { VectorSearch } from '@/app/components/base/icons/src/vender/knowledge'
import { EffectColor } from '../../settings/chunk-structure/types'
type Props = { type Props = {
disabled?: boolean disabled?: boolean
@ -23,20 +23,25 @@ const EconomicalRetrievalMethodConfig: FC<Props> = ({
const { t } = useTranslation() const { t } = useTranslation()
return ( return (
<div className='space-y-2'> <OptionCard
<OptionCard id={RETRIEVE_METHOD.invertedIndex}
disabled={disabled} icon={<Image className='h-4 w-4' src={retrievalIcon.vector} alt='' />} disabled={disabled}
title={t('dataset.retrieval.invertedIndex.title')} icon={<VectorSearch className='size-4' />}
description={t('dataset.retrieval.invertedIndex.description')} isActive iconActiveColor='text-util-colors-purple-purple-600'
activeHeaderClassName='bg-dataset-option-card-purple-gradient' title={t('dataset.retrieval.invertedIndex.title')}
> description={t('dataset.retrieval.invertedIndex.description')}
<RetrievalParamConfig isActive
type={RETRIEVE_METHOD.invertedIndex} effectColor={EffectColor.purple}
value={value} showEffectColor
onChange={onChange} showChildren
/> className='gap-x-2'
</OptionCard> >
</div> <RetrievalParamConfig
type={RETRIEVE_METHOD.invertedIndex}
value={value}
onChange={onChange}
/>
</OptionCard>
) )
} }
export default React.memo(EconomicalRetrievalMethodConfig) export default React.memo(EconomicalRetrievalMethodConfig)

@ -2,11 +2,7 @@
import type { FC } from 'react' import type { FC } from 'react'
import React, { useCallback } from 'react' import React, { useCallback } from 'react'
import { useTranslation } from 'react-i18next' import { useTranslation } from 'react-i18next'
import Image from 'next/image'
import RetrievalParamConfig from '../retrieval-param-config' import RetrievalParamConfig from '../retrieval-param-config'
import { OptionCard } from '../../create/step-two/option-card'
import Effect from '../../create/assets/option-card-effect-purple.svg'
import { retrievalIcon } from '../../create/icons'
import type { RetrievalConfig } from '@/types/app' import type { RetrievalConfig } from '@/types/app'
import { RETRIEVE_METHOD } from '@/types/app' import { RETRIEVE_METHOD } from '@/types/app'
import { useProviderContext } from '@/context/provider-context' import { useProviderContext } from '@/context/provider-context'
@ -17,7 +13,9 @@ import {
RerankingModeEnum, RerankingModeEnum,
WeightedScoreEnum, WeightedScoreEnum,
} from '@/models/datasets' } from '@/models/datasets'
import Badge from '@/app/components/base/badge' import OptionCard from '../../settings/option-card'
import { FullTextSearch, HybridSearch, VectorSearch } from '@/app/components/base/icons/src/vender/knowledge'
import { EffectColor } from '../../settings/chunk-structure/types'
type Props = { type Props = {
disabled?: boolean disabled?: boolean
@ -92,17 +90,21 @@ const RetrievalMethodConfig: FC<Props> = ({
}, [value, rerankDefaultModel, isRerankDefaultModelValid, onChange]) }, [value, rerankDefaultModel, isRerankDefaultModelValid, onChange])
return ( return (
<div className='space-y-2'> <div className='flex flex-col gap-y-2'>
{supportRetrievalMethods.includes(RETRIEVE_METHOD.semantic) && ( {supportRetrievalMethods.includes(RETRIEVE_METHOD.semantic) && (
<OptionCard disabled={disabled} icon={<Image className='h-4 w-4' src={retrievalIcon.vector} alt='' />} <OptionCard
id={RETRIEVE_METHOD.semantic}
disabled={disabled}
icon={<VectorSearch className='size-4' />}
iconActiveColor='text-util-colors-purple-purple-600'
title={t('dataset.retrieval.semantic_search.title')} title={t('dataset.retrieval.semantic_search.title')}
description={t('dataset.retrieval.semantic_search.description')} description={t('dataset.retrieval.semantic_search.description')}
isActive={ isActive={value.search_method === RETRIEVE_METHOD.semantic}
value.search_method === RETRIEVE_METHOD.semantic onClick={onSwitch}
} effectColor={EffectColor.purple}
onSwitched={() => onSwitch(RETRIEVE_METHOD.semantic)} showEffectColor
effectImg={Effect.src} showChildren={value.search_method === RETRIEVE_METHOD.semantic}
activeHeaderClassName='bg-dataset-option-card-purple-gradient' className='gap-x-2'
> >
<RetrievalParamConfig <RetrievalParamConfig
type={RETRIEVE_METHOD.semantic} type={RETRIEVE_METHOD.semantic}
@ -112,15 +114,19 @@ const RetrievalMethodConfig: FC<Props> = ({
</OptionCard> </OptionCard>
)} )}
{supportRetrievalMethods.includes(RETRIEVE_METHOD.fullText) && ( {supportRetrievalMethods.includes(RETRIEVE_METHOD.fullText) && (
<OptionCard disabled={disabled} icon={<Image className='h-4 w-4' src={retrievalIcon.fullText} alt='' />} <OptionCard
id={RETRIEVE_METHOD.fullText}
disabled={disabled}
icon={<FullTextSearch className='size-4' />}
iconActiveColor='text-util-colors-purple-purple-600'
title={t('dataset.retrieval.full_text_search.title')} title={t('dataset.retrieval.full_text_search.title')}
description={t('dataset.retrieval.full_text_search.description')} description={t('dataset.retrieval.full_text_search.description')}
isActive={ isActive={value.search_method === RETRIEVE_METHOD.fullText}
value.search_method === RETRIEVE_METHOD.fullText onClick={onSwitch}
} effectColor={EffectColor.purple}
onSwitched={() => onSwitch(RETRIEVE_METHOD.fullText)} showEffectColor
effectImg={Effect.src} showChildren={value.search_method === RETRIEVE_METHOD.fullText}
activeHeaderClassName='bg-dataset-option-card-purple-gradient' className='gap-x-2'
> >
<RetrievalParamConfig <RetrievalParamConfig
type={RETRIEVE_METHOD.fullText} type={RETRIEVE_METHOD.fullText}
@ -130,19 +136,20 @@ const RetrievalMethodConfig: FC<Props> = ({
</OptionCard> </OptionCard>
)} )}
{supportRetrievalMethods.includes(RETRIEVE_METHOD.hybrid) && ( {supportRetrievalMethods.includes(RETRIEVE_METHOD.hybrid) && (
<OptionCard disabled={disabled} icon={<Image className='h-4 w-4' src={retrievalIcon.hybrid} alt='' />} <OptionCard
title={ id={RETRIEVE_METHOD.hybrid}
<div className='flex items-center space-x-1'> disabled={disabled}
<div>{t('dataset.retrieval.hybrid_search.title')}</div> icon={<HybridSearch className='size-4' />}
<Badge text={t('dataset.retrieval.hybrid_search.recommend')!} className='ml-1 h-[18px] border-text-accent-secondary text-text-accent-secondary' uppercase /> iconActiveColor='text-util-colors-purple-purple-600'
</div> title={t('dataset.retrieval.hybrid_search.title')}
} description={t('dataset.retrieval.hybrid_search.description')}
description={t('dataset.retrieval.hybrid_search.description')} isActive={ isActive={value.search_method === RETRIEVE_METHOD.hybrid}
value.search_method === RETRIEVE_METHOD.hybrid onClick={onSwitch}
} effectColor={EffectColor.purple}
onSwitched={() => onSwitch(RETRIEVE_METHOD.hybrid)} showEffectColor
effectImg={Effect.src} isRecommended
activeHeaderClassName='bg-dataset-option-card-purple-gradient' showChildren={value.search_method === RETRIEVE_METHOD.hybrid}
className='gap-x-2'
> >
<RetrievalParamConfig <RetrievalParamConfig
type={RETRIEVE_METHOD.hybrid} type={RETRIEVE_METHOD.hybrid}

@ -38,6 +38,7 @@ import Divider from '@/app/components/base/divider'
import ChunkStructure from '../chunk-structure' import ChunkStructure from '../chunk-structure'
import Toast from '@/app/components/base/toast' import Toast from '@/app/components/base/toast'
import { RiAlertFill } from '@remixicon/react' import { RiAlertFill } from '@remixicon/react'
import { useGetDocLanguage } from '@/context/i18n'
const rowClass = 'flex gap-x-1' const rowClass = 'flex gap-x-1'
const labelClass = 'flex items-center shrink-0 w-[180px] h-7 pt-1' const labelClass = 'flex items-center shrink-0 w-[180px] h-7 pt-1'
@ -91,6 +92,7 @@ const Form = () => {
} = useModelListAndDefaultModelAndCurrentProviderAndModel(ModelTypeEnum.rerank) } = useModelListAndDefaultModelAndCurrentProviderAndModel(ModelTypeEnum.rerank)
const { data: embeddingModelList } = useModelList(ModelTypeEnum.textEmbedding) const { data: embeddingModelList } = useModelList(ModelTypeEnum.textEmbedding)
const previousAppIcon = useRef(DEFAULT_APP_ICON) const previousAppIcon = useRef(DEFAULT_APP_ICON)
const docLanguage = useGetDocLanguage()
const getMembers = async () => { const getMembers = async () => {
const { accounts } = await fetchMembers({ url: '/workspaces/current/members', params: {} }) const { accounts } = await fetchMembers({ url: '/workspaces/current/members', params: {} })
@ -181,6 +183,7 @@ const Form = () => {
score_threshold_enabled: scoreThresholdEnabled, score_threshold_enabled: scoreThresholdEnabled,
}, },
}), }),
keyword_number: keywordNumber,
}, },
} as any } as any
if (permission === DatasetPermission.partialMembers) { if (permission === DatasetPermission.partialMembers) {
@ -273,22 +276,20 @@ const Form = () => {
/> />
{/* Chunk Structure */} {/* Chunk Structure */}
<div className={rowClass}> <div className={rowClass}>
<div> <div className='flex w-[180px] shrink-0 flex-col'>
<div className='flex w-[180px] shrink-0 flex-col'> <div className='system-sm-semibold flex h-8 items-center text-text-secondary'>
<div className='system-sm-semibold flex h-8 items-center text-text-secondary'> {t('datasetSettings.form.chunkStructure.title')}
{t('datasetSettings.form.chunkStructure.title')} </div>
</div> <div className='body-xs-regular text-text-tertiary'>
<div className='body-xs-regular text-text-tertiary'> <a
<a target='_blank'
target='_blank' rel='noopener noreferrer'
rel='noopener noreferrer' href='https://example.com' // todo: replace link
href='https://example.com' // todo: replace link className='text-text-accent'
className='text-text-accent' >
> {t('datasetSettings.form.chunkStructure.learnMore')}
{t('datasetSettings.form.chunkStructure.learnMore')} </a>
</a> {t('datasetSettings.form.chunkStructure.description')}
{t('datasetSettings.form.chunkStructure.description')}
</div>
</div> </div>
</div> </div>
<div className='grow'> <div className='grow'>
@ -353,80 +354,110 @@ const Form = () => {
)} )}
{/* Retrieval Method Config */} {/* Retrieval Method Config */}
{currentDataset?.provider === 'external' {currentDataset?.provider === 'external'
? <> ? (
<div className='my-1 h-0 w-full border-b border-divider-subtle' /> <>
<div className={rowClass}> <Divider
<div className={labelClass}> type='horizontal'
<div className='system-sm-semibold text-text-secondary'>{t('datasetSettings.form.retrievalSetting.title')}</div> className='my-1 h-px bg-divider-subtle'
</div>
<RetrievalSettings
topK={topK}
scoreThreshold={scoreThreshold}
scoreThresholdEnabled={scoreThresholdEnabled}
onChange={handleSettingsChange}
isInRetrievalSetting={true}
/> />
</div> <div className={rowClass}>
<div className='my-1 h-0 w-full border-b border-divider-subtle' /> <div className={labelClass}>
<div className={rowClass}> <div className='system-sm-semibold text-text-secondary'>{t('datasetSettings.form.retrievalSetting.title')}</div>
<div className={labelClass}>
<div className='system-sm-semibold text-text-secondary'>{t('datasetSettings.form.externalKnowledgeAPI')}</div>
</div>
<div className='w-full'>
<div className='flex h-full items-center gap-1 rounded-lg bg-components-input-bg-normal px-3 py-2'>
<ApiConnectionMod className='h-4 w-4 text-text-secondary' />
<div className='system-sm-medium overflow-hidden text-ellipsis text-text-secondary'>
{currentDataset?.external_knowledge_info.external_knowledge_api_name}
</div>
<div className='system-xs-regular text-text-tertiary'>·</div>
<div className='system-xs-regular text-text-tertiary'>{currentDataset?.external_knowledge_info.external_knowledge_api_endpoint}</div>
</div> </div>
<RetrievalSettings
topK={topK}
scoreThreshold={scoreThreshold}
scoreThresholdEnabled={scoreThresholdEnabled}
onChange={handleSettingsChange}
isInRetrievalSetting={true}
/>
</div> </div>
</div> <Divider
<div className={rowClass}> type='horizontal'
<div className={labelClass}> className='my-1 h-px bg-divider-subtle'
<div className='system-sm-semibold text-text-secondary'>{t('datasetSettings.form.externalKnowledgeID')}</div> />
</div> <div className={rowClass}>
<div className='w-full'> <div className={labelClass}>
<div className='flex h-full items-center gap-1 rounded-lg bg-components-input-bg-normal px-3 py-2'> <div className='system-sm-semibold text-text-secondary'>{t('datasetSettings.form.externalKnowledgeAPI')}</div>
<div className='system-xs-regular text-text-tertiary'>{currentDataset?.external_knowledge_info.external_knowledge_id}</div> </div>
<div className='w-full'>
<div className='flex h-full items-center gap-1 rounded-lg bg-components-input-bg-normal px-3 py-2'>
<ApiConnectionMod className='h-4 w-4 text-text-secondary' />
<div className='system-sm-medium overflow-hidden text-ellipsis text-text-secondary'>
{currentDataset?.external_knowledge_info.external_knowledge_api_name}
</div>
<div className='system-xs-regular text-text-tertiary'>·</div>
<div className='system-xs-regular text-text-tertiary'>
{currentDataset?.external_knowledge_info.external_knowledge_api_endpoint}
</div>
</div>
</div> </div>
</div> </div>
</div>
</>
: indexMethod
? <>
<div className='my-1 h-0 w-full border-b border-divider-subtle' />
<div className={rowClass}> <div className={rowClass}>
<div className={labelClass}> <div className={labelClass}>
<div> <div className='system-sm-semibold text-text-secondary'>{t('datasetSettings.form.externalKnowledgeID')}</div>
<div className='system-sm-semibold text-text-secondary'>{t('datasetSettings.form.retrievalSetting.title')}</div> </div>
<div className='body-xs-regular text-text-tertiary'> <div className='w-full'>
<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-text-accent'>{t('datasetSettings.form.retrievalSetting.learnMore')}</a> <div className='flex h-full items-center gap-1 rounded-lg bg-components-input-bg-normal px-3 py-2'>
{t('datasetSettings.form.retrievalSetting.description')} <div className='system-xs-regular text-text-tertiary'>
{currentDataset?.external_knowledge_info.external_knowledge_id}
</div> </div>
</div> </div>
</div> </div>
<div className='grow'>
{indexMethod === IndexingType.QUALIFIED
? (
<RetrievalMethodConfig
value={retrievalConfig}
onChange={setRetrievalConfig}
/>
)
: (
<EconomicalRetrievalMethodConfig
value={retrievalConfig}
onChange={setRetrievalConfig}
/>
)}
</div>
</div> </div>
</> </>
)
// eslint-disable-next-line sonarjs/no-nested-conditional
: indexMethod
? (
<>
<Divider
type='horizontal'
className='my-1 h-px bg-divider-subtle'
/>
<div className={rowClass}>
<div className={labelClass}>
<div className='flex w-[180px] shrink-0 flex-col'>
<div className='system-sm-semibold flex h-7 items-center pt-1 text-text-secondary'>
{t('datasetSettings.form.retrievalSetting.title')}
</div>
<div className='body-xs-regular text-text-tertiary'>
<a
target='_blank'
rel='noopener noreferrer'
href={`https://docs.dify.ai/${docLanguage}/guides/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods`}
className='text-text-accent'
>
{t('datasetSettings.form.retrievalSetting.learnMore')}
</a>
{t('datasetSettings.form.retrievalSetting.description')}
</div>
</div>
</div>
<div className='grow'>
{indexMethod === IndexingType.QUALIFIED
? (
<RetrievalMethodConfig
value={retrievalConfig}
onChange={setRetrievalConfig}
/>
)
: (
<EconomicalRetrievalMethodConfig
value={retrievalConfig}
onChange={setRetrievalConfig}
/>
)}
</div>
</div>
</>
)
: null : null
} }
<div className='my-1 h-0 w-full border-b border-divider-subtle' /> <Divider
type='horizontal'
className='my-1 h-px bg-divider-subtle'
/>
<div className={rowClass}> <div className={rowClass}>
<div className={labelClass} /> <div className={labelClass} />
<div className='grow'> <div className='grow'>

Loading…
Cancel
Save