Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

5.0 KB
Raw Blame
import type { DocumentDetailResponse } from '@dify/contracts/api/console/datasets/types.gen'
import type { BuiltInMetadataItem, MetadataItemWithValue } from '../types'
import { useMutation, useQuery } from '@tanstack/react-query'
import { get } from 'es-toolkit/compat'
import { useCallback, useState } from 'react'
import { useTranslation } from 'react-i18next'
import { toast } from '@/app/notifications'
import { useDatasetDetailContext } from '@/context/dataset-detail'
import { useLanguages, useMetadataMap } from '@/hooks/use-metadata'
import { consoleQuery } from '@/service/console'
import { DataType } from '../types'
import useCheckMetadataName from './use-check-metadata-name'

type Props = Readonly<{
  datasetId: string
  documentId: string
  docDetail: DocumentDetailResponse
}>
const useMetadataDocument = ({ datasetId, documentId, docDetail }: Props) => {
  const { t } = useTranslation(['common'])
  const { dataset } = useDatasetDetailContext()
  const embeddingAvailable = !!dataset?.embedding_available
  const { mutateAsync: updateDocumentMetadata } = useMutation(
    consoleQuery.datasets.byDatasetId.documents.metadata.post.mutationOptions(),
  )
  const { checkName } = useCheckMetadataName()
  const [isEdit, setIsEdit] = useState(false)
  const { data: documentDetail } = useQuery(
    consoleQuery.datasets.byDatasetId.documents.byDocumentId.get.queryOptions({
      input: {
        params: { dataset_id: datasetId, document_id: documentId },
        query: { metadata: 'only' },
      },
    }),
  )
  const allList = documentDetail?.doc_metadata || []
  const list = allList.filter((item) => item.id !== 'built-in')
  const builtList = allList.filter((item) => item.id === 'built-in')
  const [tempList, setTempList] = useState<MetadataItemWithValue[]>(list)
  const { mutateAsync: createMetaData } = useMutation(
    consoleQuery.datasets.byDatasetId.metadata.post.mutationOptions(),
  )
  const handleSelectMetaData = useCallback((metaData: MetadataItemWithValue) => {
    setTempList((prev) => {
      const index = prev.findIndex((item) => item.id === metaData.id)
      if (index === -1) return [...prev, metaData]
      return prev
    })
  }, [])
  const handleAddMetaData = useCallback(
    async (payload: BuiltInMetadataItem) => {
      const errorMsg = checkName(payload.name).errorMsg
      if (errorMsg) {
        toast.error(errorMsg)
        return Promise.reject(new Error(errorMsg))
      }
      await createMetaData({ params: { dataset_id: datasetId }, body: payload })
      toast.success(t(($) => $['api.actionSuccess'], { ns: 'common' }))
    },
    [checkName, createMetaData, datasetId, t],
  )
  const hasData = list.length > 0
  const handleSave = async () => {
    await updateDocumentMetadata({
      params: { dataset_id: datasetId },
      body: { operation_data: [{ document_id: documentId, metadata_list: tempList }] },
    })
    setIsEdit(false)
    toast.success(t(($) => $['api.actionSuccess'], { ns: 'common' }))
  }
  const handleCancel = () => {
    setTempList(list)
    setIsEdit(false)
  }
  const startToEdit = () => {
    setTempList(list)
    setIsEdit(true)
  }
  // built in enabled is set in dataset
  const { data: datasetMetaData } = useQuery(
    consoleQuery.datasets.byDatasetId.metadata.get.queryOptions({
      input: { params: { dataset_id: datasetId } },
    }),
  )
  const builtInEnabled = datasetMetaData?.built_in_field_enabled
  // old metadata and technical params
  const metadataMap = useMetadataMap()
  const languageMap = useLanguages()
  const getReadOnlyMetaData = (mainField: 'originInfo' | 'technicalParameters') => {
    const fieldMap = metadataMap[mainField]?.subFieldsMap
    const sourceData = docDetail
    const getTargetMap = (field: string) => {
      if (field === 'language') return languageMap
      return {} as any
    }
    const getTargetValue = (field: string) => {
      const val: unknown = get(sourceData, field, '')
      if (typeof val !== 'string' && typeof val !== 'number') return '-'
      if (!val && val !== 0) return '-'
      if (fieldMap[field]?.inputType === 'select') return getTargetMap(field)[val]
      if (fieldMap[field]?.render)
        return fieldMap[field]?.render?.(
          val,
          field === 'hit_count' ? (get(sourceData, 'segment_count', 0) as number) : undefined,
        )
      return val
    }
    const fieldList = Object.keys(fieldMap).map((key) => {
      const field = fieldMap[key]
      return {
        id: field?.label!,
        type: DataType.string,
        name: field?.label!,
        value: getTargetValue(key),
      }
    })
    return fieldList
  }
  const originInfo = getReadOnlyMetaData('originInfo')
  const technicalParameters = getReadOnlyMetaData('technicalParameters')
  return {
    embeddingAvailable,
    isEdit,
    setIsEdit,
    list,
    tempList,
    setTempList,
    handleSelectMetaData,
    handleAddMetaData,
    hasData,
    builtList,
    builtInEnabled,
    startToEdit,
    handleSave,
    handleCancel,
    originInfo: originInfo!,
    technicalParameters: technicalParameters!,
  }
}
export default useMetadataDocument