From f4af9cca979823d0ab4658d9c1fe56348e04b57d Mon Sep 17 00:00:00 2001 From: wizardchen Date: Wed, 3 Jun 2026 14:41:12 +0800 Subject: [PATCH] feat(contextualGuides): add multiple contextual guide components for agent and knowledge base creation - Introduced new components: AgentCreateContextualGuide, KbCreateContextualGuide, TenantModelsGuide, and SpotlightGuide to enhance user onboarding. - Implemented dynamic step configurations for each guide, allowing tailored user experiences based on context. - Enhanced the existing NewUserGuide component to utilize the new SpotlightGuide for improved visual guidance. - Updated localization files to include new strings for contextual guides, ensuring a comprehensive user experience across languages. - Refactored existing components to integrate with the new guide system, improving maintainability and user interaction. --- .../components/AgentCreateContextualGuide.vue | 174 +++++ frontend/src/components/ContextualGuide.vue | 100 +++ frontend/src/components/Input-field.vue | 6 +- .../components/KbCreateContextualGuide.vue | 202 ++++++ frontend/src/components/NewUserGuide.vue | 568 +---------------- frontend/src/components/SpotlightGuide.vue | 600 ++++++++++++++++++ frontend/src/components/TenantModelsGuide.vue | 127 ++++ .../composables/useTenantModelReadiness.ts | 54 ++ frontend/src/config/contextualGuides.ts | 140 ++++ frontend/src/i18n/locales/en-US.ts | 204 ++++++ frontend/src/i18n/locales/ko-KR.ts | 204 ++++++ frontend/src/i18n/locales/ru-RU.ts | 204 ++++++ frontend/src/i18n/locales/zh-CN.ts | 204 ++++++ frontend/src/types/spotlightGuide.ts | 13 + frontend/src/utils/tenantModelReadiness.ts | 36 ++ frontend/src/views/agent/AgentEditorModal.vue | 59 +- frontend/src/views/agent/AgentList.vue | 36 +- frontend/src/views/creatChat/creatChat.vue | 9 +- .../src/views/knowledge/KnowledgeBase.vue | 15 +- .../knowledge/KnowledgeBaseEditorModal.vue | 64 +- .../src/views/knowledge/KnowledgeBaseList.vue | 39 +- .../knowledge/settings/KBModelConfig.vue | 4 +- 22 files changed, 2483 insertions(+), 579 deletions(-) create mode 100644 frontend/src/components/AgentCreateContextualGuide.vue create mode 100644 frontend/src/components/ContextualGuide.vue create mode 100644 frontend/src/components/KbCreateContextualGuide.vue create mode 100644 frontend/src/components/SpotlightGuide.vue create mode 100644 frontend/src/components/TenantModelsGuide.vue create mode 100644 frontend/src/composables/useTenantModelReadiness.ts create mode 100644 frontend/src/config/contextualGuides.ts create mode 100644 frontend/src/types/spotlightGuide.ts create mode 100644 frontend/src/utils/tenantModelReadiness.ts diff --git a/frontend/src/components/AgentCreateContextualGuide.vue b/frontend/src/components/AgentCreateContextualGuide.vue new file mode 100644 index 00000000..d502b652 --- /dev/null +++ b/frontend/src/components/AgentCreateContextualGuide.vue @@ -0,0 +1,174 @@ + + + diff --git a/frontend/src/components/ContextualGuide.vue b/frontend/src/components/ContextualGuide.vue new file mode 100644 index 00000000..5b70b6ad --- /dev/null +++ b/frontend/src/components/ContextualGuide.vue @@ -0,0 +1,100 @@ + + + diff --git a/frontend/src/components/Input-field.vue b/frontend/src/components/Input-field.vue index 6865bff5..ca31f8a8 100644 --- a/frontend/src/components/Input-field.vue +++ b/frontend/src/components/Input-field.vue @@ -2099,7 +2099,7 @@ defineExpose({ -
+
@@ -2255,7 +2255,7 @@ defineExpose({ allSelectedItems.length }) : $t('input.knowledgeBase') }} -
@@ -2332,7 +2332,7 @@ defineExpose({ -
diff --git a/frontend/src/components/KbCreateContextualGuide.vue b/frontend/src/components/KbCreateContextualGuide.vue new file mode 100644 index 00000000..d9a8a82a --- /dev/null +++ b/frontend/src/components/KbCreateContextualGuide.vue @@ -0,0 +1,202 @@ + + + diff --git a/frontend/src/components/NewUserGuide.vue b/frontend/src/components/NewUserGuide.vue index 8f230f2c..48d930bb 100644 --- a/frontend/src/components/NewUserGuide.vue +++ b/frontend/src/components/NewUserGuide.vue @@ -1,94 +1,21 @@ - - diff --git a/frontend/src/components/SpotlightGuide.vue b/frontend/src/components/SpotlightGuide.vue new file mode 100644 index 00000000..6d5c4118 --- /dev/null +++ b/frontend/src/components/SpotlightGuide.vue @@ -0,0 +1,600 @@ + + + + + diff --git a/frontend/src/components/TenantModelsGuide.vue b/frontend/src/components/TenantModelsGuide.vue new file mode 100644 index 00000000..c8d0cae5 --- /dev/null +++ b/frontend/src/components/TenantModelsGuide.vue @@ -0,0 +1,127 @@ + + + diff --git a/frontend/src/composables/useTenantModelReadiness.ts b/frontend/src/composables/useTenantModelReadiness.ts new file mode 100644 index 00000000..6c554aba --- /dev/null +++ b/frontend/src/composables/useTenantModelReadiness.ts @@ -0,0 +1,54 @@ +import { computed, onMounted, ref, watch } from 'vue' +import { useUIStore } from '@/stores/ui' +import { + fetchTenantModelReadiness, + type TenantModelReadiness, +} from '@/utils/tenantModelReadiness' + +export function useTenantModelReadiness() { + const uiStore = useUIStore() + const readiness = ref(null) + const loaded = ref(false) + const loading = ref(false) + + const refresh = async () => { + loading.value = true + try { + readiness.value = await fetchTenantModelReadiness() + } finally { + loading.value = false + loaded.value = true + } + } + + onMounted(() => { + refresh() + }) + + watch( + () => uiStore.showSettingsModal, + (open, wasOpen) => { + if (wasOpen && !open) { + refresh() + } + }, + ) + + const isReadyForDocumentKb = computed( + () => readiness.value?.isReadyForDocumentKb ?? false, + ) + + const isReadyForAgent = computed(() => readiness.value?.isReadyForAgent ?? false) + + const hasChat = computed(() => readiness.value?.hasChat ?? false) + + return { + readiness, + loaded, + loading, + refresh, + isReadyForDocumentKb, + isReadyForAgent, + hasChat, + } +} diff --git a/frontend/src/config/contextualGuides.ts b/frontend/src/config/contextualGuides.ts new file mode 100644 index 00000000..b40a9370 --- /dev/null +++ b/frontend/src/config/contextualGuides.ts @@ -0,0 +1,140 @@ +import type { SpotlightGuideStep } from '@/types/spotlightGuide' + +export const GLOBAL_USER_GUIDE_KEY = 'weknora:new-user-guide-done:v1' + +export const KB_EDITOR_FOCUS_SECTION_EVENT = 'weknora:kb-editor-focus-section' +export const AGENT_EDITOR_FOCUS_SECTION_EVENT = 'weknora:agent-editor-focus-section' + +export type ContextualGuideTourId = + | 'kbList' + | 'kbCreate' + | 'kbDetail' + | 'chat' + | 'tenantModels' + | 'agentList' + | 'agentCreate' + +const focusKbEditorSection = (section: string) => { + window.dispatchEvent( + new CustomEvent(KB_EDITOR_FOCUS_SECTION_EVENT, { detail: { section } }), + ) +} + +const focusKbEditorBasic = () => focusKbEditorSection('basic') + +export interface ContextualGuideTourConfig { + storageKey: string + stepI18nPrefix: string + steps: SpotlightGuideStep[] + /** 首次展示前的延迟(毫秒) */ + openDelayMs: number + /** 完成本引导时一并标记为已完成的其他引导 */ + alsoCompleteTours?: ContextualGuideTourId[] +} + +export const CONTEXTUAL_GUIDE_TOURS: Record = { + kbList: { + storageKey: 'weknora:contextual-guide-kb-list:v2', + stepI18nPrefix: 'contextualGuide.kbList.steps', + openDelayMs: 500, + steps: [ + { + key: 'create', + // 空列表时优先高亮居中的主 CTA,否则退化为顶栏新建按钮 + target: '.empty-state-btn[data-guide="kb-list-create"], [data-guide="kb-list-create"]', + placement: 'bottom', + interact: true, + }, + ], + }, + // 步骤由 KbCreateContextualGuide.vue 按文档库/FAQ 动态组装 + kbCreate: { + storageKey: 'weknora:contextual-guide-kb-create:v3', + stepI18nPrefix: 'contextualGuide.kbCreate.steps', + openDelayMs: 450, + alsoCompleteTours: ['kbList'], + steps: [], + }, + tenantModels: { + storageKey: 'weknora:contextual-guide-tenant-models:v1', + stepI18nPrefix: 'contextualGuide.tenantModels.steps', + openDelayMs: 500, + steps: [], + }, + kbDetail: { + storageKey: 'weknora:contextual-guide-kb-detail:v1', + stepI18nPrefix: 'contextualGuide.kbDetail.steps', + openDelayMs: 600, + steps: [ + { + key: 'intro', + }, + { + key: 'upload', + target: '[data-guide="kb-detail-add-doc"]', + placement: 'bottom', + }, + { key: 'done' }, + ], + }, + chat: { + storageKey: 'weknora:contextual-guide-chat:v1', + stepI18nPrefix: 'contextualGuide.chat.steps', + openDelayMs: 800, + steps: [ + { + key: 'kb', + target: '[data-guide="chat-kb-mention"]', + placement: 'top', + optional: true, + }, + { + key: 'input', + target: '[data-guide="chat-input"]', + placement: 'top', + }, + { + key: 'send', + target: '[data-guide="chat-send"]', + placement: 'top', + }, + { key: 'done' }, + ], + }, + agentList: { + storageKey: 'weknora:contextual-guide-agent-list:v1', + stepI18nPrefix: 'contextualGuide.agentList.steps', + openDelayMs: 500, + steps: [ + { + key: 'create', + target: '.empty-state-btn[data-guide="agent-list-create"], [data-guide="agent-list-create"]', + placement: 'bottom', + interact: true, + }, + ], + }, + agentCreate: { + storageKey: 'weknora:contextual-guide-agent-create:v1', + stepI18nPrefix: 'contextualGuide.agentCreate.steps', + openDelayMs: 450, + alsoCompleteTours: ['agentList'], + steps: [], + }, +} + +export function isContextualGuideDone(tourId: ContextualGuideTourId): boolean { + return localStorage.getItem(CONTEXTUAL_GUIDE_TOURS[tourId].storageKey) === '1' +} + +export function markContextualGuideDone(tourId: ContextualGuideTourId) { + const config = CONTEXTUAL_GUIDE_TOURS[tourId] + localStorage.setItem(config.storageKey, '1') + config.alsoCompleteTours?.forEach((id) => { + localStorage.setItem(CONTEXTUAL_GUIDE_TOURS[id].storageKey, '1') + }) +} + +export function isGlobalUserGuideDone(): boolean { + return localStorage.getItem(GLOBAL_USER_GUIDE_KEY) === '1' +} diff --git a/frontend/src/i18n/locales/en-US.ts b/frontend/src/i18n/locales/en-US.ts index e4db55ef..239a05dc 100755 --- a/frontend/src/i18n/locales/en-US.ts +++ b/frontend/src/i18n/locales/en-US.ts @@ -65,6 +65,210 @@ export default { }, }, }, + contextualGuide: { + stepOf: '{current} / {total}', + skip: 'Skip', + prev: 'Back', + next: 'Next', + done: 'Got it', + interactHint: 'Click the highlighted area to continue', + kbList: { + steps: { + create: { + title: 'Create your first knowledge base', + desc: 'Knowledge bases hold documents and FAQs. Click the highlighted "New knowledge base" button below and we will walk you through the form.', + }, + }, + }, + tenantModels: { + needModelsFirst: 'Add a chat model and an Embedding model before creating a knowledge base.', + needChatModelFirst: 'Add a chat model (KnowledgeQA) before creating an agent.', + steps: { + intro: { + title: 'Configure models first', + desc: 'A document knowledge base needs at least one chat model (summaries and Q&A) and one Embedding model (vector search). Add them in system settings.', + }, + addModel: { + title: 'Add models', + desc: 'Click "Add model" and configure KnowledgeQA (chat) and Embedding types. Lite users can pull local models via Ollama.', + }, + done: { + title: 'Then continue', + desc: 'After saving models, close settings and click "New knowledge base". The wizard will walk you through type, indexing, and model binding.', + }, + }, + stepsAgent: { + intro: { + title: 'Configure a chat model first', + desc: 'Creating an agent requires at least one KnowledgeQA model. Add it in system settings (Embedding is only required for knowledge bases).', + }, + addModel: { + title: 'Add a chat model', + desc: 'Click "Add model" and configure a KnowledgeQA type.', + }, + done: { + title: 'Then create an agent', + desc: 'After saving, close settings and click "Create agent". The wizard covers mode, knowledge bases, and multimodal options.', + }, + }, + }, + kbCreate: { + steps: { + type: { + title: 'Choose a type', + desc: 'Document bases are for PDFs, Word files, and similar uploads. FAQ bases are for question–answer pairs. The type cannot be changed later.', + }, + name: { + title: 'Enter a name', + desc: 'Pick a clear name such as "Product manual" or "Support FAQ". Description is optional.', + }, + indexing: { + title: 'Indexing capabilities', + desc: 'Vector and keyword search are on by default. You can also enable Wiki or knowledge-graph indexing. Keep at least one search mode enabled.', + }, + navModels: { + title: 'Model setup (required)', + desc: 'Every knowledge base needs a chat model; retrieval also requires an Embedding model. Open "Model configuration" on the left.', + }, + llm: { + title: 'Chat / summary model', + desc: 'Used for summaries and answers. If the list is empty, use the dropdown to open settings and add a model.', + }, + embedding: { + title: 'Embedding model', + desc: 'Turns text into vectors for semantic search. Works with vector/keyword indexing above.', + }, + parser: { + title: 'Parser engine (optional)', + desc: 'How PDFs and Office files are parsed. Defaults work for most cases; adjust if you need OCR or special layouts.', + }, + chunking: { + title: 'Chunking (optional)', + desc: 'How documents are split for retrieval. Default chunk sizes are tuned for RAG and rarely need changes.', + }, + storage: { + title: 'Storage (optional)', + desc: 'Where raw files are stored (local or object storage). The tenant default is usually fine.', + }, + navMultimodal: { + title: 'Multimodal / images (optional)', + desc: 'Enable this if documents contain charts, scans, or image-heavy content that needs vision understanding.', + }, + multimodalToggle: { + title: 'Enable multimodal parsing', + desc: 'When on, image-bearing uploads are processed with a vision-language model for better retrieval.', + }, + multimodalVllm: { + title: 'Choose a VLM model', + desc: 'Multimodal requires a VLM. Add one in system settings if the list is empty.', + }, + faq: { + title: 'FAQ indexing', + desc: 'Choose how Q&A pairs are indexed. You can add FAQ entries after creation.', + }, + submit: { + title: 'Create the knowledge base', + desc: 'When type, name, and models look correct, click the highlighted Create button. You will then be guided to upload your first document.', + }, + }, + }, + agentList: { + steps: { + create: { + title: 'Create your agent', + desc: 'Agents combine models, knowledge bases, tools, and prompts into reusable assistants. Click the highlighted "Create agent" button.', + }, + }, + }, + agentCreate: { + steps: { + mode: { + title: 'Choose run mode', + desc: '"Quick answer" for straightforward Q&A; "Smart reasoning" uses tools and multi-step thinking for complex tasks.', + }, + agentType: { + title: 'Choose an agent type', + desc: 'Presets fill in the system prompt, recommended tools, and knowledge scope (e.g. Wiki builder, data analysis). Switch by scenario—name and description update accordingly.', + }, + name: { + title: 'Name and description', + desc: 'Pick a recognizable name. Smart-reasoning mode may pre-fill a default you can edit.', + }, + navModel: { + title: 'Bind a chat model', + desc: 'Every agent needs a KnowledgeQA model as its reasoning engine.', + }, + model: { + title: 'Select model', + desc: 'Choose from configured chat models, or add one in system settings first.', + }, + navKnowledge: { + title: 'Link knowledge bases', + desc: 'Control which knowledge the agent can retrieve. Default is all knowledge bases.', + }, + knowledge: { + title: 'Knowledge scope', + desc: '"All" for general assistants; "Selected" for a domain; "None" relies on the model alone or web search.', + }, + navWebsearch: { + title: 'Web search (optional)', + desc: 'Allow the agent to call external search for up-to-date information.', + }, + navMultimodal: { + title: 'Image upload (optional)', + desc: 'Lets users send images in chat; requires a VLM model in system settings.', + }, + multimodal: { + title: 'Enable image understanding', + desc: 'Turn on the switch and select a VLM below when enabled.', + }, + navTools: { + title: 'Tools & MCP (optional)', + desc: 'In smart-reasoning mode, enable built-in tools and MCP services for search, code, and more.', + }, + submit: { + title: 'Save the agent', + desc: 'Click the highlighted confirm button to finish. You can then select this agent in chat.', + }, + }, + }, + kbDetail: { + steps: { + intro: { + title: 'This knowledge base is empty', + desc: 'Add your first item so you can search and chat over it. You can also drag and drop supported file types.', + }, + upload: { + title: 'Add documents', + desc: 'Use this menu to upload files or folders, import a URL, or create content online.', + }, + done: { + title: 'Ready after parsing', + desc: 'Once documents are indexed, mention this knowledge base in chat with @ to get answers with citations.', + }, + }, + }, + chat: { + steps: { + kb: { + title: 'Choose knowledge scope', + desc: 'Click @ to pick one or more knowledge bases or files. Answers use only the selection; otherwise the current agent settings apply.', + }, + input: { + title: 'Type your question', + desc: 'Describe what you want to know, or click a suggested question above to get started quickly.', + }, + send: { + title: 'Send to start chatting', + desc: 'Sending creates a new session. The AI answers using your knowledge base and shows cited passages.', + }, + done: { + title: 'You are ready to explore', + desc: 'Try a question related to your uploaded documents and see grounded answers with references.', + }, + }, + }, + }, batchManage: { title: 'Manage Conversations', selectAll: 'Select All', diff --git a/frontend/src/i18n/locales/ko-KR.ts b/frontend/src/i18n/locales/ko-KR.ts index 67872668..8af64fcd 100755 --- a/frontend/src/i18n/locales/ko-KR.ts +++ b/frontend/src/i18n/locales/ko-KR.ts @@ -65,6 +65,210 @@ export default { }, }, }, + contextualGuide: { + stepOf: "{current} / {total}", + skip: "건너뛰기", + prev: "이전", + next: "다음", + done: "확인", + interactHint: "강조된 영역을 클릭하여 계속하세요", + kbList: { + steps: { + create: { + title: "첫 지식 베이스 만들기", + desc: "지식 베이스에 문서와 FAQ를 보관합니다. 아래에 강조된 「새 지식 베이스」 버튼을 누르면 양식 작성을 안내합니다.", + }, + }, + }, + tenantModels: { + needModelsFirst: "지식 베이스를 만들기 전에 대화 모델과 Embedding 모델을 추가하세요.", + needChatModelFirst: "에이전트를 만들기 전에 대화 모델(KnowledgeQA)을 추가하세요.", + steps: { + intro: { + title: "먼저 모델을 구성하세요", + desc: "문서 지식 베이스에는 대화 모델(요약·Q&A)과 Embedding 모델(벡터 검색)이 각각 하나 이상 필요합니다. 시스템 설정에서 추가하세요.", + }, + addModel: { + title: "모델 추가", + desc: "「모델 추가」를 눌러 KnowledgeQA(대화)와 Embedding 유형을 구성하세요. Lite 사용자는 Ollama로 로컬 모델을 받을 수 있습니다.", + }, + done: { + title: "추가 후 계속", + desc: "모델을 저장하고 설정을 닫은 뒤 「새 지식 베이스」를 클릭하세요. 마법사가 유형·색인·모델 연결을 안내합니다.", + }, + }, + stepsAgent: { + intro: { + title: "먼저 대화 모델을 구성하세요", + desc: "에이전트 생성에는 KnowledgeQA 모델이 최소 하나 필요합니다. 시스템 설정에서 추가하세요(Embedding은 지식 베이스에만 필요).", + }, + addModel: { + title: "대화 모델 추가", + desc: "「모델 추가」를 눌러 KnowledgeQA 유형을 구성하세요.", + }, + done: { + title: "이후 에이전트 생성", + desc: "저장 후 설정을 닫고 「에이전트 생성」을 클릭하세요. 마법사가 모드·지식 베이스·멀티모달 옵션을 안내합니다.", + }, + }, + }, + kbCreate: { + steps: { + type: { + title: "유형 선택", + desc: "문서 라이브러리는 PDF·Word 등 파일용, FAQ 라이브러리는 질문·답변 쌍용입니다. 생성 후 유형은 변경할 수 없습니다.", + }, + name: { + title: "이름 입력", + desc: "「제품 매뉴얼」「고객 FAQ」처럼 알아보기 쉬운 이름을 입력하세요. 설명은 선택 사항입니다.", + }, + indexing: { + title: "색인 기능", + desc: "벡터·키워드 검색이 기본으로 켜져 있습니다. Wiki·지식 그래프도 선택할 수 있습니다. 검색 방식은 하나 이상 유지하세요.", + }, + navModels: { + title: "모델 구성(필수)", + desc: "모든 지식 베이스에 대화 모델이 필요하며, 검색을 쓰려면 Embedding 모델도 필요합니다. 왼쪽 「모델 구성」을 여세요.", + }, + llm: { + title: "대화/요약 모델", + desc: "요약·답변 생성에 사용됩니다. 목록이 비어 있으면 드롭다운에서 설정으로 이동해 모델을 추가하세요.", + }, + embedding: { + title: "Embedding 모델", + desc: "텍스트를 벡터로 바꿔 의미 검색을 지원합니다. 위의 벡터/키워드 색인과 함께 사용합니다.", + }, + parser: { + title: "파서 엔진(선택)", + desc: "PDF·Office 파일 파싱 방식을 제어합니다. 기본값으로 대부분 충분하며 OCR이 필요할 때 조정하세요.", + }, + chunking: { + title: "청킹(선택)", + desc: "문서를 검색 단위로 나누는 방식입니다. RAG에 맞춘 기본값을 그대로 쓰면 됩니다.", + }, + storage: { + title: "스토리지(선택)", + desc: "원본 파일 저장 위치(로컬 또는 객체 스토리지)입니다. 테넌트 기본값을 따르면 됩니다.", + }, + navMultimodal: { + title: "멀티모달/이미지(선택)", + desc: "차트·스캔·이미지가 많은 문서를 시각 이해가 필요할 때 활성화하세요.", + }, + multimodalToggle: { + title: "멀티모달 파싱 켜기", + desc: "켜면 이미지가 포함된 업로드를 VLM으로 처리해 검색 품질을 높입니다.", + }, + multimodalVllm: { + title: "VLM 모델 선택", + desc: "멀티모달에는 VLM이 필요합니다. 목록이 비어 있으면 시스템 설정에서 추가하세요.", + }, + faq: { + title: "FAQ 색인", + desc: "Q&A 쌍의 색인 방식을 선택합니다. 생성 후 이 페이지에서 FAQ 항목을 추가할 수 있습니다.", + }, + submit: { + title: "지식 베이스 생성", + desc: "유형·이름·모델을 확인한 뒤 강조된 「생성」을 클릭하세요. 이후 첫 문서 업로드를 안내합니다.", + }, + }, + }, + agentList: { + steps: { + create: { + title: "에이전트 만들기", + desc: "에이전트는 모델·지식 베이스·도구·프롬프트를 묶은 재사용 가능한 어시스턴트입니다. 강조된 「에이전트 생성」을 클릭하세요.", + }, + }, + }, + agentCreate: { + steps: { + mode: { + title: "실행 모드 선택", + desc: "「빠른 답변」은 단순 Q&A용, 「스마트 추론」은 도구와 다단계 사고로 복잡한 작업에 적합합니다.", + }, + agentType: { + title: "에이전트 유형 선택", + desc: "프리셋은 시스템 프롬프트, 권장 도구, 지식 범위(Wiki 빌드, 데이터 분석 등)를 자동으로 채웁니다. 시나리오에 맞게 바꾸면 이름·설명도 함께 갱신됩니다.", + }, + name: { + title: "이름과 설명", + desc: "알아보기 쉬운 이름을 입력하세요. 스마트 추론 모드는 기본값이 채워질 수 있습니다.", + }, + navModel: { + title: "대화 모델 연결", + desc: "모든 에이전트에 KnowledgeQA 모델이 추론 엔진으로 필요합니다.", + }, + model: { + title: "모델 선택", + desc: "구성된 대화 모델 중 선택하거나, 먼저 시스템 설정에서 추가하세요.", + }, + navKnowledge: { + title: "지식 베이스 연결", + desc: "에이전트가 검색할 지식 범위를 설정합니다. 기본값은 전체 지식 베이스입니다.", + }, + knowledge: { + title: "지식 범위", + desc: "「전체」는 범용, 「선택」은 특정 도메인, 「없음」은 모델만 또는 웹 검색에 의존합니다.", + }, + navWebsearch: { + title: "웹 검색(선택)", + desc: "최신 정보를 위해 외부 검색을 호출할 수 있게 합니다.", + }, + navMultimodal: { + title: "이미지 업로드(선택)", + desc: "채팅에서 이미지 전송을 허용합니다. 시스템 설정에 VLM이 필요합니다.", + }, + multimodal: { + title: "이미지 이해 켜기", + desc: "스위치를 켜고 아래에서 VLM을 선택하세요.", + }, + navTools: { + title: "도구 및 MCP(선택)", + desc: "스마트 추론 모드에서 내장 도구와 MCP로 검색·코드 등을 사용할 수 있습니다.", + }, + submit: { + title: "에이전트 저장", + desc: "강조된 확인 버튼을 눌러 완료하세요. 이후 채팅에서 이 에이전트를 선택할 수 있습니다.", + }, + }, + }, + kbDetail: { + steps: { + intro: { + title: "지식 베이스가 비어 있습니다", + desc: "첫 자료를 추가해야 검색과 대화에 사용할 수 있습니다. 지원 형식은 드래그 앤 드롭으로도 업로드할 수 있습니다.", + }, + upload: { + title: "문서 추가", + desc: "여기에서 파일·폴더 업로드, URL 가져오기, 온라인 편집 콘텐츠 생성을 할 수 있습니다.", + }, + done: { + title: "분석 후 사용 가능", + desc: "문서가 색인되면 대화에서 @로 이 지식 베이스를 지정해 출처가 포함된 답변을 받을 수 있습니다.", + }, + }, + }, + chat: { + steps: { + kb: { + title: "지식 범위 선택", + desc: "@를 눌러 지식 베이스나 파일을 선택하세요. 선택한 범위만 사용해 답변합니다. 선택하지 않으면 현재 에이전트 설정이 적용됩니다.", + }, + input: { + title: "질문 입력", + desc: "알고 싶은 내용을 입력하거나, 위의 추천 질문을 눌러 빠르게 시작하세요.", + }, + send: { + title: "보내기로 대화 시작", + desc: "전송하면 새 세션이 만들어지고, AI가 지식 베이스를 바탕으로 인용과 함께 답변합니다.", + }, + done: { + title: "이제 탐색해 보세요", + desc: "업로드한 문서와 관련된 질문을 해 보고, 인용이 포함된 답변을 확인해 보세요.", + }, + }, + }, + }, batchManage: { title: "대화 관리", selectAll: "전체 선택", diff --git a/frontend/src/i18n/locales/ru-RU.ts b/frontend/src/i18n/locales/ru-RU.ts index 20b44f43..f89506ab 100755 --- a/frontend/src/i18n/locales/ru-RU.ts +++ b/frontend/src/i18n/locales/ru-RU.ts @@ -65,6 +65,210 @@ export default { }, }, }, + contextualGuide: { + stepOf: '{current} / {total}', + skip: 'Пропустить', + prev: 'Назад', + next: 'Далее', + done: 'Понятно', + interactHint: 'Нажмите на выделенную область, чтобы продолжить', + kbList: { + steps: { + create: { + title: 'Создайте первую базу знаний', + desc: 'В базах знаний хранятся документы и FAQ. Нажмите выделенную кнопку «Новая база знаний» ниже — мы проведём вас по форме.', + }, + }, + }, + tenantModels: { + needModelsFirst: 'Сначала добавьте модель чата и Embedding, затем создавайте базу знаний.', + needChatModelFirst: 'Перед созданием агента добавьте модель чата (KnowledgeQA).', + steps: { + intro: { + title: 'Сначала настройте модели', + desc: 'Для документной базы нужна модель чата (сводки и ответы) и модель Embedding (векторный поиск). Добавьте их в системных настройках.', + }, + addModel: { + title: 'Добавить модели', + desc: 'Нажмите «Добавить модель» и настройте типы KnowledgeQA (чат) и Embedding. В Lite можно загрузить локальные модели через Ollama.', + }, + done: { + title: 'Затем продолжите', + desc: 'После сохранения моделей закройте настройки и нажмите «Новая база знаний». Мастер проведёт через тип, индексацию и привязку моделей.', + }, + }, + stepsAgent: { + intro: { + title: 'Сначала настройте модель чата', + desc: 'Для создания агента нужна хотя бы одна модель KnowledgeQA. Добавьте её в системных настройках (Embedding нужен только для баз знаний).', + }, + addModel: { + title: 'Добавить модель чата', + desc: 'Нажмите «Добавить модель» и настройте тип KnowledgeQA.', + }, + done: { + title: 'Затем создайте агента', + desc: 'После сохранения закройте настройки и нажмите «Создать агента». Мастер охватит режим, базы знаний и мультимодальные опции.', + }, + }, + }, + kbCreate: { + steps: { + type: { + title: 'Выберите тип', + desc: 'Для PDF, Word и похожих файлов — база документов. Для пар вопрос–ответ — база FAQ. Тип после создания изменить нельзя.', + }, + name: { + title: 'Введите название', + desc: 'Например «Руководство продукта» или «FAQ поддержки». Описание необязательно.', + }, + indexing: { + title: 'Возможности индексации', + desc: 'По умолчанию включены векторный и ключевой поиск. Можно включить Wiki или граф знаний. Оставьте хотя бы один режим поиска.', + }, + navModels: { + title: 'Модели (обязательно)', + desc: 'Каждой базе нужна модель чата; для поиска также нужен Embedding. Откройте «Конфигурация моделей» слева.', + }, + llm: { + title: 'Модель чата / сводки', + desc: 'Для сводок и ответов. Если список пуст, через выпадающий список откройте настройки и добавьте модель.', + }, + embedding: { + title: 'Модель Embedding', + desc: 'Преобразует текст в векторы для семантического поиска. Работает с векторным/ключевым индексом выше.', + }, + parser: { + title: 'Парсер (необязательно)', + desc: 'Как разбираются PDF и Office. По умолчанию подходит в большинстве случаев; меняйте при необходимости OCR.', + }, + chunking: { + title: 'Разбиение (необязательно)', + desc: 'Как документ делится на фрагменты для поиска. Размеры по умолчанию подобраны для RAG.', + }, + storage: { + title: 'Хранилище (необязательно)', + desc: 'Где хранятся исходные файлы (локально или объектное хранилище). Обычно достаточно значения арендатора.', + }, + navMultimodal: { + title: 'Мультимодальность / изображения (необязательно)', + desc: 'Включите, если в документах много диаграмм, сканов или изображений, требующих визуального понимания.', + }, + multimodalToggle: { + title: 'Включить мультимодальный разбор', + desc: 'При включении загрузки с изображениями обрабатываются VLM для лучшего поиска.', + }, + multimodalVllm: { + title: 'Выберите модель VLM', + desc: 'Для мультимодальности нужна VLM. Если список пуст, добавьте модель в настройках.', + }, + faq: { + title: 'Индексация FAQ', + desc: 'Выберите режим индексации пар вопрос–ответ. Записи FAQ можно добавить после создания.', + }, + submit: { + title: 'Создать базу знаний', + desc: 'Проверьте тип, название и модели, затем нажмите выделенную кнопку «Создать». Далее подскажем загрузить первый документ.', + }, + }, + }, + agentList: { + steps: { + create: { + title: 'Создайте агента', + desc: 'Агенты объединяют модели, базы знаний, инструменты и промпты в переиспользуемых помощников. Нажмите выделенную кнопку «Создать агента».', + }, + }, + }, + agentCreate: { + steps: { + mode: { + title: 'Выберите режим работы', + desc: '«Быстрый ответ» для простого Q&A; «Умное рассуждение» — инструменты и многошаговое мышление для сложных задач.', + }, + agentType: { + title: 'Выберите тип агента', + desc: 'Пресеты подставляют системный промпт, рекомендуемые инструменты и область знаний (например, построение Wiki, анализ данных). При смене типа обновляются имя и описание.', + }, + name: { + title: 'Название и описание', + desc: 'Укажите узнаваемое имя. В режиме умного рассуждения может подставиться значение по умолчанию.', + }, + navModel: { + title: 'Привязать модель чата', + desc: 'Каждому агенту нужна модель KnowledgeQA как движок рассуждений.', + }, + model: { + title: 'Выбор модели', + desc: 'Выберите из настроенных моделей чата или сначала добавьте в системных настройках.', + }, + navKnowledge: { + title: 'Связать базы знаний', + desc: 'Определите, к каким знаниям агент может обращаться. По умолчанию — все базы.', + }, + knowledge: { + title: 'Область знаний', + desc: '«Все» — универсальный помощник; «Выбранные» — домен; «Нет» — только модель или веб-поиск.', + }, + navWebsearch: { + title: 'Веб-поиск (необязательно)', + desc: 'Разрешить агенту вызывать внешний поиск для актуальной информации.', + }, + navMultimodal: { + title: 'Загрузка изображений (необязательно)', + desc: 'Позволяет отправлять изображения в чате; нужна VLM в настройках.', + }, + multimodal: { + title: 'Включить понимание изображений', + desc: 'Включите переключатель и выберите VLM ниже.', + }, + navTools: { + title: 'Инструменты и MCP (необязательно)', + desc: 'В режиме умного рассуждения включите встроенные инструменты и MCP для поиска, кода и др.', + }, + submit: { + title: 'Сохранить агента', + desc: 'Нажмите выделенную кнопку подтверждения. Затем выберите этого агента в чате.', + }, + }, + }, + kbDetail: { + steps: { + intro: { + title: 'База знаний пуста', + desc: 'Добавьте первый материал, чтобы искать по нему и общаться в чате. Поддерживаемые файлы можно перетащить мышью.', + }, + upload: { + title: 'Добавить документы', + desc: 'Здесь можно загрузить файлы или папки, импортировать URL или создать материал онлайн.', + }, + done: { + title: 'Готово после индексации', + desc: 'После обработки документов укажите эту базу через @ в чате и получайте ответы со ссылками на источники.', + }, + }, + }, + chat: { + steps: { + kb: { + title: 'Выберите область знаний', + desc: 'Нажмите @, чтобы выбрать одну или несколько баз знаний или файлов. Иначе используются настройки текущего агента.', + }, + input: { + title: 'Введите вопрос', + desc: 'Опишите, что хотите узнать, или нажмите на рекомендуемый вопрос выше.', + }, + send: { + title: 'Отправить, чтобы начать чат', + desc: 'После отправки создаётся новая сессия. ИИ отвечает на основе базы знаний и показывает цитаты.', + }, + done: { + title: 'Можно исследовать', + desc: 'Задайте вопрос по загруженным документам и посмотрите ответы со ссылками на источники.', + }, + }, + }, + }, batchManage: { title: 'Управление диалогами', selectAll: 'Выбрать все', diff --git a/frontend/src/i18n/locales/zh-CN.ts b/frontend/src/i18n/locales/zh-CN.ts index 3c3707b5..8a27964a 100755 --- a/frontend/src/i18n/locales/zh-CN.ts +++ b/frontend/src/i18n/locales/zh-CN.ts @@ -65,6 +65,210 @@ export default { }, }, }, + contextualGuide: { + stepOf: "{current} / {total}", + skip: "跳过", + prev: "上一步", + next: "下一步", + done: "知道了", + interactHint: "请直接点击高亮区域继续", + kbList: { + steps: { + create: { + title: "创建第一个知识库", + desc: "知识库用来存放文档与 FAQ。点击下方高亮的「新建知识库」按钮,我们会带你完成表单填写。", + }, + }, + }, + tenantModels: { + needModelsFirst: "请先添加对话模型与 Embedding 模型,再创建知识库。", + needChatModelFirst: "请先添加对话模型(KnowledgeQA),再创建智能体。", + steps: { + intro: { + title: "需要先配置模型", + desc: "创建文档知识库至少需要:一个对话模型(用于摘要与问答)和一个 Embedding 模型(用于向量检索)。请先在系统设置中添加。", + }, + addModel: { + title: "添加模型", + desc: "点击「添加模型」,分别配置 KnowledgeQA(对话)与 Embedding 类型。Lite 用户可使用 Ollama 拉取本地模型。", + }, + done: { + title: "添加完成后继续", + desc: "模型保存后关闭设置页,即可点击「新建知识库」;创建向导会引导你完成类型、索引与模型绑定。", + }, + }, + stepsAgent: { + intro: { + title: "需要先配置对话模型", + desc: "创建智能体至少需要一种 KnowledgeQA(对话)模型。请先在系统设置中添加;Embedding 模型仅创建知识库时需要。", + }, + addModel: { + title: "添加对话模型", + desc: "点击「添加模型」,选择 KnowledgeQA 类型并填写接入信息。", + }, + done: { + title: "然后创建智能体", + desc: "保存并关闭设置后,点击「创建智能体」,向导会带你配置模式、知识库与多模态等选项。", + }, + }, + }, + kbCreate: { + steps: { + type: { + title: "选择知识库类型", + desc: "文档库适合上传 PDF、Word 等文件;FAQ 库适合问答对。创建后类型不可更改,请按需选择。", + }, + name: { + title: "填写名称", + desc: "取一个便于识别的名称,例如「产品手册」或「客服 FAQ」。描述可选填。", + }, + indexing: { + title: "选择索引能力", + desc: "默认已开启向量与关键词检索,可按需开启 Wiki 结构化索引或知识图谱。至少保留一种检索方式。", + }, + navModels: { + title: "配置模型(必填)", + desc: "知识库必须绑定对话模型;开启检索时还需 Embedding 模型。点击左侧「模型配置」进入。", + }, + llm: { + title: "对话 / 摘要模型", + desc: "用于文档摘要、问答生成等。若列表为空,请通过下拉菜单前往系统设置添加模型。", + }, + embedding: { + title: "Embedding 模型", + desc: "将文本转为向量以支持语义检索。与上方索引策略中的「向量/关键词检索」配合使用。", + }, + parser: { + title: "解析引擎(可选)", + desc: "控制 PDF、Office 等文件的解析方式。默认配置适用于大多数场景,有 OCR 需求时可在此调整。", + }, + chunking: { + title: "分块策略(可选)", + desc: "决定文档如何切分为检索片段。默认分块大小已针对 RAG 优化,一般无需修改。", + }, + storage: { + title: "存储引擎(可选)", + desc: "原始文件存放位置(本地或对象存储)。默认跟随租户设置即可。", + }, + navMultimodal: { + title: "多模态 / 图片理解(可选)", + desc: "若文档含大量图表、扫描件或需理解图片内容,可在此开启多模态并选择 VLM 模型。", + }, + multimodalToggle: { + title: "开启多模态解析", + desc: "启用后,上传的图片类文档将使用视觉语言模型提取内容,便于检索与问答。", + }, + multimodalVllm: { + title: "选择 VLM 模型", + desc: "开启多模态后需指定 VLM(视觉语言模型)。若列表为空,请先在系统设置中添加 VLLM 类型模型。", + }, + faq: { + title: "FAQ 索引方式", + desc: "配置问答对的索引模式。创建后可在本页继续添加 FAQ 条目。", + }, + submit: { + title: "创建知识库", + desc: "确认类型、名称与模型已选好后,点击高亮的「创建」按钮。创建成功后将引导你上传第一份文档。", + }, + }, + }, + agentList: { + steps: { + create: { + title: "创建你的智能体", + desc: "智能体把模型、知识库、工具与提示词组合成可复用的对话助手。点击下方高亮的「创建智能体」开始配置。", + }, + }, + }, + agentCreate: { + steps: { + mode: { + title: "选择运行模式", + desc: "「普通模式」适合固定流程的快速问答;「智能推理」可调用工具、多步思考,适合复杂任务。", + }, + agentType: { + title: "选择智能体类型", + desc: "预设类型会自动填充系统提示词、推荐工具与知识库范围(如 Wiki 构建、数据分析等)。可按场景切换,名称与描述会随之更新。", + }, + name: { + title: "命名与描述", + desc: "取一个易识别的名称。智能推理模式下系统可能已预填默认名称,可按需修改。", + }, + navModel: { + title: "绑定对话模型", + desc: "每个智能体必须指定一个 KnowledgeQA 模型作为推理引擎。", + }, + model: { + title: "选择模型", + desc: "从下拉列表选择已配置的对话模型;没有合适模型时请先到系统设置添加。", + }, + navKnowledge: { + title: "关联知识库", + desc: "决定智能体可检索哪些知识。默认「全部知识库」,也可改为指定库或暂不关联。", + }, + knowledge: { + title: "知识库范围", + desc: "「全部」适合通用助手;「指定」可限定专业领域;「不关联」则仅依赖模型自身能力或联网搜索。", + }, + navWebsearch: { + title: "联网搜索(可选)", + desc: "配置是否允许智能体调用外部搜索引擎补充实时信息。", + }, + navMultimodal: { + title: "图片上传(可选)", + desc: "开启后,对话中可上传图片并由 VLM 理解;需先在系统设置中配置 VLLM 模型。", + }, + multimodal: { + title: "启用图片理解", + desc: "打开开关后,记得在下方选择 VLM 模型(开启时必填)。", + }, + navTools: { + title: "工具与 MCP(可选)", + desc: "智能推理模式下可勾选内置工具、MCP 服务等,扩展搜索、计算等能力。", + }, + submit: { + title: "保存智能体", + desc: "确认配置后点击高亮的「确定」完成创建,即可在对话中选择该智能体。", + }, + }, + }, + kbDetail: { + steps: { + intro: { + title: "知识库还是空的", + desc: "添加第一份资料后,才能基于它进行检索与对话。支持拖拽上传多种文档格式。", + }, + upload: { + title: "添加文档", + desc: "点击此处上传文件、文件夹,或导入网页与在线编辑内容。", + }, + done: { + title: "解析完成后即可使用", + desc: "文档解析入库后,可在对话中 @ 本知识库提问,回答会附带引用来源。", + }, + }, + }, + chat: { + steps: { + kb: { + title: "选择知识范围", + desc: "点击 @ 可指定一个或多个知识库/文件,仅基于选中内容回答;不选则按当前智能体配置检索。", + }, + input: { + title: "输入你的问题", + desc: "直接描述你想了解的内容;也可点击上方推荐问题快速开始。", + }, + send: { + title: "发送开始对话", + desc: "发送后将创建新会话,AI 会结合知识库内容作答,并标注引用片段。", + }, + done: { + title: "开始探索吧", + desc: "试试提一个与已上传文档相关的问题,体验带引用的精准回答。", + }, + }, + }, + }, batchManage: { title: "管理对话记录", selectAll: "全选", diff --git a/frontend/src/types/spotlightGuide.ts b/frontend/src/types/spotlightGuide.ts new file mode 100644 index 00000000..6552c7e0 --- /dev/null +++ b/frontend/src/types/spotlightGuide.ts @@ -0,0 +1,13 @@ +export type GuidePlacement = 'right' | 'left' | 'bottom' | 'top' + +export interface SpotlightGuideStep { + key: string + /** 高亮目标的 CSS 选择器;缺省表示居中卡片 */ + target?: string + placement?: GuidePlacement + before?: () => void | Promise + /** 目标不存在时是否跳过该步骤 */ + optional?: boolean + /** 为 true 时引导用户直接点击高亮区域,不展示「下一步」 */ + interact?: boolean +} diff --git a/frontend/src/utils/tenantModelReadiness.ts b/frontend/src/utils/tenantModelReadiness.ts new file mode 100644 index 00000000..4f94116e --- /dev/null +++ b/frontend/src/utils/tenantModelReadiness.ts @@ -0,0 +1,36 @@ +import { listModels, type ModelConfig } from '@/api/model' + +export interface TenantModelReadiness { + chatCount: number + embeddingCount: number + hasChat: boolean + hasEmbedding: boolean + /** 文档库默认开启向量/关键词检索时所需的模型是否齐备 */ + isReadyForDocumentKb: boolean + /** 创建智能体至少需要对话模型 */ + isReadyForAgent: boolean +} + +export function evaluateTenantModelReadiness(models: ModelConfig[]): TenantModelReadiness { + const chatCount = models.filter((m) => m.type === 'KnowledgeQA').length + const embeddingCount = models.filter((m) => m.type === 'Embedding').length + const hasChat = chatCount > 0 + const hasEmbedding = embeddingCount > 0 + return { + chatCount, + embeddingCount, + hasChat, + hasEmbedding, + isReadyForDocumentKb: hasChat && hasEmbedding, + isReadyForAgent: hasChat, + } +} + +export async function fetchTenantModelReadiness(): Promise { + try { + const models = await listModels() + return evaluateTenantModelReadiness(models || []) + } catch { + return evaluateTenantModelReadiness([]) + } +} diff --git a/frontend/src/views/agent/AgentEditorModal.vue b/frontend/src/views/agent/AgentEditorModal.vue index 3e0e1957..66b2cb66 100644 --- a/frontend/src/views/agent/AgentEditorModal.vue +++ b/frontend/src/views/agent/AgentEditorModal.vue @@ -17,9 +17,10 @@
-
+
+ :class="['nav-item', { 'active': currentSection === item.key }]" + :data-guide="`agent-editor-nav-${item.key}`" @click="currentSection = item.key"> {{ item.label }}
@@ -72,7 +73,7 @@ $t('agent.editor.normalDesc') }}

- + {{ $t('agent.type.normal') }} @@ -84,7 +85,8 @@
-
+

{{ $t('agentEditor.agentType.desc') }}

@@ -106,7 +108,7 @@
-
+
@@ -329,7 +331,7 @@
-
+

{{ $t('agentEditor.desc.model') }}

@@ -391,7 +393,7 @@
-
+

{{ $t('agentEditor.imageUpload.desc') }}

@@ -846,7 +848,7 @@
-
+

{{ $t('agentEditor.desc.kbScope') }}

@@ -1300,7 +1302,8 @@ {{ props.readOnly ? $t('common.close') : $t('common.cancel') }} - {{ + {{ $t('common.confirm') }}
@@ -1310,10 +1313,17 @@
+ +