From fbedd08292827d7404247ca930f4df3b15ae3df6 Mon Sep 17 00:00:00 2001 From: Yi Date: Mon, 23 Sep 2024 23:34:01 +0800 Subject: [PATCH] feat: add external api --- web/app/(commonLayout)/datasets/Container.tsx | 14 ++ .../datasets/NewDatasetCard.tsx | 26 +++- .../solid/development/api-connection-mod.svg | 5 + .../solid/development/ApiConnectionMod.json | 38 +++++ .../solid/development/ApiConnectionMod.tsx | 16 ++ .../src/vender/solid/development/index.ts | 1 + web/app/components/base/modal/index.css | 2 +- .../external-api/external-api-modal/Form.tsx | 0 .../external-api/external-api-modal/index.tsx | 141 ++++++++++++++++++ .../external-api/external-api-panel/index.tsx | 70 +++++++++ web/context/modal-context.tsx | 25 ++++ web/i18n/en-US/dataset.ts | 24 +++ web/i18n/zh-Hans/dataset.ts | 24 +++ web/models/datasets.ts | 25 ++++ web/service/datasets.ts | 10 ++ 15 files changed, 412 insertions(+), 9 deletions(-) create mode 100644 web/app/components/base/icons/assets/vender/solid/development/api-connection-mod.svg create mode 100644 web/app/components/base/icons/src/vender/solid/development/ApiConnectionMod.json create mode 100644 web/app/components/base/icons/src/vender/solid/development/ApiConnectionMod.tsx create mode 100644 web/app/components/datasets/external-api/external-api-modal/Form.tsx create mode 100644 web/app/components/datasets/external-api/external-api-modal/index.tsx create mode 100644 web/app/components/datasets/external-api/external-api-panel/index.tsx diff --git a/web/app/(commonLayout)/datasets/Container.tsx b/web/app/(commonLayout)/datasets/Container.tsx index f532ca416f..b626da05f5 100644 --- a/web/app/(commonLayout)/datasets/Container.tsx +++ b/web/app/(commonLayout)/datasets/Container.tsx @@ -8,6 +8,7 @@ import { useDebounceFn } from 'ahooks' import useSWR from 'swr' // Components +import ExternalAPIPanel from '../../components/datasets/external-api/external-api-panel' import Datasets from './Datasets' import DatasetFooter from './DatasetFooter' import ApiServer from './ApiServer' @@ -16,6 +17,8 @@ import TabSliderNew from '@/app/components/base/tab-slider-new' import SearchInput from '@/app/components/base/search-input' import TagManagementModal from '@/app/components/base/tag-management' import TagFilter from '@/app/components/base/tag-management/filter' +import Button from '@/app/components/base/button' +import { ApiConnectionMod } from '@/app/components/base/icons/src/vender/solid/development' // Services import { fetchDatasetApiBaseUrl } from '@/service/datasets' @@ -30,6 +33,7 @@ const Container = () => { const router = useRouter() const { currentWorkspace } = useAppContext() const showTagManagementModal = useTagStore(s => s.showTagManagementModal) + const [showExternalApiPanel, setShowExternalApiPanel] = useState(false) const options = useMemo(() => { return [ @@ -80,6 +84,14 @@ const Container = () => {
+
+
)} {activeTab === 'api' && data && } @@ -96,6 +108,8 @@ const Container = () => { )} {activeTab === 'api' && data && } + + {showExternalApiPanel && setShowExternalApiPanel(false)} isShow={showExternalApiPanel} />}
) diff --git a/web/app/(commonLayout)/datasets/NewDatasetCard.tsx b/web/app/(commonLayout)/datasets/NewDatasetCard.tsx index f76efa5769..19a7ba2ab6 100644 --- a/web/app/(commonLayout)/datasets/NewDatasetCard.tsx +++ b/web/app/(commonLayout)/datasets/NewDatasetCard.tsx @@ -4,21 +4,31 @@ import { forwardRef } from 'react' import { useTranslation } from 'react-i18next' import { RiAddLine, + RiArrowRightLine, } from '@remixicon/react' const CreateAppCard = forwardRef((_, ref) => { const { t } = useTranslation() return ( - -
-
- +
+ +
+
+ +
+
{t('dataset.createDataset')}
-
{t('dataset.createDataset')}
-
-
{t('dataset.createDatasetIntro')}
- + + +
{t('dataset.connectDataset')}
+ + +
) }) diff --git a/web/app/components/base/icons/assets/vender/solid/development/api-connection-mod.svg b/web/app/components/base/icons/assets/vender/solid/development/api-connection-mod.svg new file mode 100644 index 0000000000..9e4b0c81ec --- /dev/null +++ b/web/app/components/base/icons/assets/vender/solid/development/api-connection-mod.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/web/app/components/base/icons/src/vender/solid/development/ApiConnectionMod.json b/web/app/components/base/icons/src/vender/solid/development/ApiConnectionMod.json new file mode 100644 index 0000000000..e8ebcc7448 --- /dev/null +++ b/web/app/components/base/icons/src/vender/solid/development/ApiConnectionMod.json @@ -0,0 +1,38 @@ +{ + "icon": { + "type": "element", + "isRootNode": true, + "name": "svg", + "attributes": { + "width": "16", + "height": "16", + "viewBox": "0 0 16 16", + "fill": "none", + "xmlns": "http://www.w3.org/2000/svg" + }, + "children": [ + { + "type": "element", + "name": "g", + "attributes": { + "id": "Icon L" + }, + "children": [ + { + "type": "element", + "name": "path", + "attributes": { + "id": "Vector", + "fill-rule": "evenodd", + "clip-rule": "evenodd", + "d": "M7.99996 3.33333C5.42263 3.33333 3.33329 5.42267 3.33329 8C3.33329 10.5773 5.42263 12.6667 7.99996 12.6667C9.72643 12.6667 11.2348 11.7295 12.0427 10.3329C12.227 10.0141 12.6349 9.90523 12.9536 10.0896C13.2723 10.274 13.3812 10.6818 13.1968 11.0005C12.1604 12.7921 10.2216 14 7.99996 14C4.91159 14 2.36821 11.6666 2.03658 8.66667H1.33329C0.965103 8.66667 0.666626 8.36819 0.666626 8C0.666626 7.63181 0.965103 7.33333 1.33329 7.33333H2.03658C2.36821 4.33337 4.91159 2 7.99996 2C10.2216 2 12.1604 3.20785 13.1968 4.99952C13.3812 5.31823 13.2723 5.72605 12.9536 5.91041C12.6349 6.09477 12.227 5.98585 12.0427 5.66714C11.2348 4.27054 9.72643 3.33333 7.99996 3.33333ZM7.99996 6C6.89539 6 5.99996 6.89543 5.99996 8C5.99996 9.10455 6.89539 10 7.99996 10C9.1045 10 9.99996 9.10454 9.99996 8C9.99996 6.89543 9.10451 6 7.99996 6ZM4.66663 8C4.66663 6.15905 6.15901 4.66667 7.99996 4.66667C9.61257 4.66667 10.9578 5.81184 11.2666 7.33333H14.6666C15.0348 7.33333 15.3333 7.63181 15.3333 8C15.3333 8.36819 15.0348 8.66667 14.6666 8.66667H11.2666C10.9578 10.1881 9.61257 11.3333 7.99996 11.3333C6.159 11.3333 4.66663 9.84092 4.66663 8Z", + "fill": "currentColor" + }, + "children": [] + } + ] + } + ] + }, + "name": "ApiConnectionMod" +} \ No newline at end of file diff --git a/web/app/components/base/icons/src/vender/solid/development/ApiConnectionMod.tsx b/web/app/components/base/icons/src/vender/solid/development/ApiConnectionMod.tsx new file mode 100644 index 0000000000..f88431a237 --- /dev/null +++ b/web/app/components/base/icons/src/vender/solid/development/ApiConnectionMod.tsx @@ -0,0 +1,16 @@ +// GENERATE BY script +// DON NOT EDIT IT MANUALLY + +import * as React from 'react' +import data from './ApiConnectionMod.json' +import IconBase from '@/app/components/base/icons/IconBase' +import type { IconBaseProps, IconData } from '@/app/components/base/icons/IconBase' + +const Icon = React.forwardRef, Omit>(( + props, + ref, +) => ) + +Icon.displayName = 'ApiConnectionMod' + +export default Icon diff --git a/web/app/components/base/icons/src/vender/solid/development/index.ts b/web/app/components/base/icons/src/vender/solid/development/index.ts index 7fe781e2ce..159a1cbc0b 100644 --- a/web/app/components/base/icons/src/vender/solid/development/index.ts +++ b/web/app/components/base/icons/src/vender/solid/development/index.ts @@ -1,3 +1,4 @@ +export { default as ApiConnectionMod } from './ApiConnectionMod' export { default as ApiConnection } from './ApiConnection' export { default as BarChartSquare02 } from './BarChartSquare02' export { default as Container } from './Container' diff --git a/web/app/components/base/modal/index.css b/web/app/components/base/modal/index.css index 799b375168..727a9455d7 100644 --- a/web/app/components/base/modal/index.css +++ b/web/app/components/base/modal/index.css @@ -3,5 +3,5 @@ } .modal-panel { - @apply w-full max-w-md transform rounded-2xl bg-white p-6 text-left align-middle shadow-xl transition-all; + @apply w-full max-w-[480px] transform rounded-2xl bg-white p-6 text-left align-middle shadow-xl transition-all; } diff --git a/web/app/components/datasets/external-api/external-api-modal/Form.tsx b/web/app/components/datasets/external-api/external-api-modal/Form.tsx new file mode 100644 index 0000000000..e69de29bb2 diff --git a/web/app/components/datasets/external-api/external-api-modal/index.tsx b/web/app/components/datasets/external-api/external-api-modal/index.tsx new file mode 100644 index 0000000000..243ae1c6d3 --- /dev/null +++ b/web/app/components/datasets/external-api/external-api-modal/index.tsx @@ -0,0 +1,141 @@ +import type { FC } from 'react' +import { + memo, + useState, +} from 'react' +import { useTranslation } from 'react-i18next' +import { + RiCloseLine, + RiInformation2Line, + RiLock2Fill, +} from '@remixicon/react' +import { useToastContext } from '@/app/components/base/toast' +import { + PortalToFollowElem, + PortalToFollowElemContent, +} from '@/app/components/base/portal-to-follow-elem' +import ActionButton from '@/app/components/base/action-button' +import Input from '@/app/components/base/input' +import Button from '@/app/components/base/button' +import Tooltip from '@/app/components/base/tooltip' + +type AddExternalAPIModalProps = { + show: boolean + onHide: () => void +} + +const AddExternalAPIModal: FC = ({ show, onHide }) => { + const { t } = useTranslation() + const { notify } = useToastContext() + const [showConfirm, setShowConfirm] = useState(false) + const [formData, setFormData] = useState({ name: '', endpoint: '', apiKey: '' }) + const isEditMode = true + + const handleInputChange = (e: React.ChangeEvent) => { + const { name, value } = e.target + setFormData({ ...formData, [name]: value }) + } + + const handleFormSubmit = (e: React.FormEvent) => { + e.preventDefault() + // Handle form submission logic here + console.log('Form Data:', formData) + onHide() + } + + return ( + + +
+
+
+
+ { + isEditMode ? t('dataset.editExternalAPIFormTitle') : t('dataset.createExternalAPIFormTitle') + } +
+ {isEditMode && ( +
+ {t('dataset.editExternalAPIFormWarning.front')} + +  3 {t('dataset.editExternalAPIFormWarning.end')}  + +
+ )} +
+ + + +
+
+
+ + +
+
+ + +
+
+ + +
+
+
+
+ + +
+
+ + {t('dataset.externalAPIForm.encrypted.front')} + + PKCS1_OAEP + + {t('dataset.externalAPIForm.encrypted.end')} +
+
+
+ + + ) +} + +export default memo(AddExternalAPIModal) diff --git a/web/app/components/datasets/external-api/external-api-panel/index.tsx b/web/app/components/datasets/external-api/external-api-panel/index.tsx new file mode 100644 index 0000000000..881540617e --- /dev/null +++ b/web/app/components/datasets/external-api/external-api-panel/index.tsx @@ -0,0 +1,70 @@ +import React from 'react' +import { + RiAddLine, + RiBookOpenLine, + RiCloseLine, +} from '@remixicon/react' +import { useTranslation } from 'react-i18next' +import cn from '@/utils/classnames' +// import AddExternalAPIForm from '../create/add-external-api' +import ActionButton from '@/app/components/base/action-button' +import Button from '@/app/components/base/button' +import { useModalContext } from '@/context/modal-context' + +type ExternalAPIPanelProps = { + onClose: () => void + isShow: boolean +} + +const ExternalAPIPanel: React.FC = ({ onClose, isShow }) => { + const { t } = useTranslation() + const { setShowExternalAPIModal } = useModalContext() + + const handleOpenExternalAPIModal = () => { + setShowExternalAPIModal() + } + + return ( +
+
+
+
+
{t('dataset.externalAPIPanelTitle')}
+
{t('dataset.externalAPIPanelDescription')}
+ + +
{t('dataset.externalAPIPanelDocumentation')}
+ +
+
+ onClose()}> + + +
+
+
+ +
+
+ +
+
+
+ ) +} + +export default ExternalAPIPanel diff --git a/web/context/modal-context.tsx b/web/context/modal-context.tsx index 3547c45aac..31e9037fdb 100644 --- a/web/context/modal-context.tsx +++ b/web/context/modal-context.tsx @@ -10,6 +10,7 @@ import ModerationSettingModal from '@/app/components/app/configuration/toolbox/m import ExternalDataToolModal from '@/app/components/app/configuration/tools/external-data-tool-modal' import AnnotationFullModal from '@/app/components/billing/annotation-full/modal' import ModelModal from '@/app/components/header/account-setting/model-provider-page/model-modal' +import ExternalAPIModal from '@/app/components/datasets/external-api/external-api-modal' import type { ConfigurationMethodEnum, CustomConfigurationModelFixedFields, @@ -52,6 +53,7 @@ export type ModalContextState = { setShowPricingModal: () => void setShowAnnotationFullModal: () => void setShowModelModal: Dispatch | null>> + setShowExternalAPIModal: () => void setShowModelLoadBalancingModal: Dispatch> setShowModelLoadBalancingEntryModal: Dispatch | null>> } @@ -63,6 +65,7 @@ const ModalContext = createContext({ setShowPricingModal: () => { }, setShowAnnotationFullModal: () => { }, setShowModelModal: () => { }, + setShowExternalAPIModal: () => { }, setShowModelLoadBalancingModal: () => { }, setShowModelLoadBalancingEntryModal: () => { }, }) @@ -86,6 +89,7 @@ export const ModalContextProvider = ({ const [showModerationSettingModal, setShowModerationSettingModal] = useState | null>(null) const [showExternalDataToolModal, setShowExternalDataToolModal] = useState | null>(null) const [showModelModal, setShowModelModal] = useState | null>(null) + const [showExternalAPIModal, setShowExternalAPIModal] = useState(false) const [showModelLoadBalancingModal, setShowModelLoadBalancingModal] = useState(null) const [showModelLoadBalancingEntryModal, setShowModelLoadBalancingEntryModal] = useState | null>(null) const searchParams = useSearchParams() @@ -122,6 +126,18 @@ export const ModalContextProvider = ({ setShowModelModal(null) }, [showModelModal]) + // const handleCancelExternalApiModal = useCallback(() => { + // setShowExternalAPIModal(null) + // if (showExternalAPIModal?.onCancelCallback) + // showExternalAPIModal.onCancelCallback() + // }, [showExternalAPIModal]) + + // const handleSaveExternalApiModal = useCallback(() => { + // if (showExternalAPIModal?.onSaveCallback) + // showExternalAPIModal.onSaveCallback(null) + // setShowExternalAPIModal(null) + // }, [showExternalAPIModal]) + const handleCancelModelLoadBalancingEntryModal = useCallback(() => { showModelLoadBalancingEntryModal?.onCancelCallback?.() setShowModelLoadBalancingEntryModal(null) @@ -173,6 +189,7 @@ export const ModalContextProvider = ({ setShowPricingModal: () => setShowPricingModal(true), setShowAnnotationFullModal: () => setShowAnnotationFullModal(true), setShowModelModal, + setShowExternalAPIModal: () => setShowExternalAPIModal(true), setShowModelLoadBalancingModal, setShowModelLoadBalancingEntryModal, }}> @@ -245,6 +262,14 @@ export const ModalContextProvider = ({ /> ) } + { + !!showExternalAPIModal && ( + setShowExternalAPIModal(false)} + /> + ) + } { Boolean(showModelLoadBalancingModal) && ( diff --git a/web/i18n/en-US/dataset.ts b/web/i18n/en-US/dataset.ts index a15efe5dc0..3572459464 100644 --- a/web/i18n/en-US/dataset.ts +++ b/web/i18n/en-US/dataset.ts @@ -1,9 +1,21 @@ const translation = { knowledge: 'Knowledge', + externalAPI: 'External API', + externalAPIPanelTitle: 'External Knowledge API', + externalAPIPanelDescription: 'The external knowledge API is used to connect to a knowledge base outside of Dify and retrieve knowledge from that knowledge base.', + externalAPIPanelDocumentation: 'Learn how to create an external API', documentCount: ' docs', wordCount: ' k words', appCount: ' linked apps', createDataset: 'Create Knowledge', + createExternalAPI: 'Add an External API', + createExternalAPIFormTitle: 'Add an External Knowledge API', + editExternalAPIFormTitle: 'Edit the External Knowledge API', + editExternalAPIFormWarning: { + front: 'This External API is linked to', + end: 'external knowledge', + }, + connectDataset: 'Connect to an external knowledge base', createDatasetIntro: 'Import your own text data or write data in real-time via Webhook for LLM context enhancement.', deleteDatasetConfirmTitle: 'Delete this Knowledge?', deleteDatasetConfirmContent: @@ -22,6 +34,18 @@ const translation = { unavailableTip: 'Embedding model is not available, the default embedding model needs to be configured', datasets: 'KNOWLEDGE', datasetsApi: 'API ACCESS', + externalAPIForm: { + name: 'Name', + endpoint: 'API Endpoint', + apiKey: 'API Key', + save: 'Save', + cancel: 'Cancel', + edit: 'Edit', + encrypted: { + front: 'Your API Token will be encrypted and stored using', + end: 'technology.', + }, + }, retrieval: { semantic_search: { title: 'Vector Search', diff --git a/web/i18n/zh-Hans/dataset.ts b/web/i18n/zh-Hans/dataset.ts index 013830af6f..6ea94410bb 100644 --- a/web/i18n/zh-Hans/dataset.ts +++ b/web/i18n/zh-Hans/dataset.ts @@ -1,9 +1,21 @@ const translation = { knowledge: '知识库', + externalAPI: '外部 API', + externalAPIPanelTitle: '外部知识库 API', + externalAPIPanelDescription: '外部知识库 API 用于连接到 Dify 之外的知识库并从中检索知识。', + externalAPIPanelDocumentation: '了解如何创建外部 API', documentCount: ' 文档', wordCount: ' 千字符', appCount: ' 关联应用', createDataset: '创建知识库', + createExternalAPI: '添加外部 API', + createExternalAPIFormTitle: '添加外部知识库 API', + editExternalAPIFormTitle: '编辑外部知识库 API', + editExternalAPIFormWarning: { + front: '此外部 API 已链接到', + end: '外部知识库', + }, + connectDataset: '连接外部知识库', createDatasetIntro: '导入您自己的文本数据或通过 Webhook 实时写入数据以增强 LLM 的上下文。', deleteDatasetConfirmTitle: '要删除知识库吗？', deleteDatasetConfirmContent: @@ -22,6 +34,18 @@ const translation = { unavailableTip: '由于 embedding 模型不可用，需要配置默认 embedding 模型', datasets: '知识库', datasetsApi: 'API', + externalAPIForm: { + name: '名称', + endpoint: 'API 端点', + apiKey: 'API 密钥', + save: '保存', + cancel: '取消', + edit: '编辑', + encrypted: { + front: '您的 API Token 将使用', + end: '加密并存储。', + }, + }, retrieval: { semantic_search: { title: '向量检索', diff --git a/web/models/datasets.ts b/web/models/datasets.ts index 23d1fe6136..294eb73af8 100644 --- a/web/models/datasets.ts +++ b/web/models/datasets.ts @@ -34,6 +34,23 @@ export type DataSet = { partial_member_list?: any[] } +export type ExternalAPIItem = { + id: string + tenant_id: string + name: string + description: string + settings: { + endpoint: string + api_key: string + document_retrieval_setting: { + top_k: number + score_threshold: number + } + } + created_by: string + created_at: string +} + export type CustomFile = File & { id?: string extension?: string @@ -72,6 +89,14 @@ export type DataSetListResponse = { total: number } +export type ExternalAPIListResponse = { + data: ExternalAPIItem[] + has_more: boolean + limit: number + page: number + total: number +} + export type QA = { question: string answer: string diff --git a/web/service/datasets.ts b/web/service/datasets.ts index 4ca269a7d6..812bcd602d 100644 --- a/web/service/datasets.ts +++ b/web/service/datasets.ts @@ -8,6 +8,8 @@ import type { DocumentDetailResponse, DocumentListResponse, ErrorDocsResponse, + ExternalAPIItem, + ExternalAPIListResponse, FileIndexingEstimateResponse, HitTestingRecordsResponse, HitTestingResponse, @@ -82,6 +84,14 @@ export const deleteDataset: Fetcher = (datasetID) => { return del(`/datasets/${datasetID}`) } +export const fetchExternalAPIList: Fetcher = ({ url, params }) => { + return get(url, { params }) +} + +export const createExternalAPI: Fetcher = ({ body }) => { + return post('/datasets/api-template', { body }) +} + export const fetchDefaultProcessRule: Fetcher = ({ url }) => { return get(url) }