-
Notifications
You must be signed in to change notification settings - Fork 362
Add content related to summary index #665
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request adds comprehensive documentation for the new Summary Auto-Gen feature, which automatically generates summaries for document chunks to enhance retrievability in knowledge bases.
Changes:
- Added documentation for the Summary Auto-Gen feature across multiple knowledge management pages
- Introduced new document and chunk management actions for generating and managing summaries
- Added best practices section explaining when and how to use summaries effectively
- Restructured and improved the chunking documentation for better clarity
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| maintain-knowledge-documents.mdx | Added "Generate Summary" document action and "Add/Edit/Delete Summary" chunk operation; added new best practices section on using summaries to bridge query-content gaps |
| introduction.mdx | Added "Summary Auto-Gen" setting to knowledge base configuration table with usage instructions |
| knowledge-pipeline-orchestration.mdx | Added new "Summary Auto-Gen" section explaining the feature in the pipeline orchestration context |
| chunking-and-cleaning-text.mdx | Restructured chunking documentation with improved explanations and added "Enable Summary Auto-Gen" section; includes better explanation of delimiters and chunk modes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
en/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents.mdx
Outdated
Show resolved
Hide resolved
en/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text.mdx
Outdated
Show resolved
Hide resolved
en/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text.mdx
Outdated
Show resolved
Hide resolved
🌐 Multi-language Sync✅ Created sync PR #666 Synced 8 files to cn + jp Both PRs can merge independently. Future commits here will auto-update the sync PR. |
🌐 Multi-language Sync✅ Updated sync PR #666 Future commits will auto-update the sync PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
🌐 Multi-language Sync✅ Updated sync PR #666 Synced 6 files to cn + jp Future commits will auto-update the sync PR. |
d37bc6b to
2fa579c
Compare
2fa579c to
f804cf3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Click **Preview** to see how your content will be chunked. A limited number of chunks will be displayed for a quick review. | ||
|
|
||
| Once configured, click **“Preview Chunk”** to see the chunking results. You can see the total character count of the parent chunk. Characters highlighted in blue represent child chunks, and the character count for the current child chunk is also displayed for reference. | ||
| If the results don't perfectly match your expectations, choose the closest configuration—you can manually fine-tune chunks later. See [Manage Documents and Chunks](/en/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents) for details. |
Copilot
AI
Jan 22, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link text "Manage Documents and Chunks" doesn't match the actual page title "Manage Knowledge Content". While the link target is correct, consider using either the exact page title or adjusting the text to something like "manage documents and chunks" (lowercase, as part of a sentence) to make it clear it's a descriptive reference rather than a title reference.
|
|
||
| Instead of splitting the text into paragraphs, the entire document is used as the parent chunk and retrieved directly. For performance reasons, only the first 10,000 tokens of the text are retained. This setting is ideal for smaller documents where paragraphs are interrelated, requiring full doc retrieval. | ||
| - **Remove all URLs and email addresses**\ | ||
| Eliminates URLs and email addresses that rarely contribute to meaningful retrieval. |
Copilot
AI
Jan 22, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrase "URLs and email addresses that rarely contribute to meaningful retrieval" could be more precise. Consider "URLs and email addresses, which rarely contribute to meaningful retrieval" or "URLs and email addresses that typically don't contribute to meaningful retrieval" to make the statement clearer and less absolute.
| Eliminates URLs and email addresses that rarely contribute to meaningful retrieval. | |
| Eliminates URLs and email addresses, which rarely contribute to meaningful retrieval. |
|
|
||
| Summaries are embedded and indexed for retrieval as well. When a summary matches a query, its corresponding chunk is also returned. | ||
|
|
||
| You can manually edit auto-generated summaries or regenerate them for specific documents later. See [Manage Documents and Chunks](/en/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents) for details. |
Copilot
AI
Jan 22, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link text "Manage Documents and Chunks" doesn't match the actual page title "Manage Knowledge Content". While the link target is correct, consider using either the exact page title or adjusting the text to something like "manage documents and chunks" (lowercase, as part of a sentence) to make it clear it's a descriptive reference rather than a title reference.
| You can manually edit auto-generated summaries or regenerate them for specific documents later. See [Manage Documents and Chunks](/en/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents) for details. | |
| You can manually edit auto-generated summaries or regenerate them for specific documents later. See [Manage Knowledge Content](/en/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents) for details. |
|
|
||
| * **Chunk Delimiter**: The system automatically chunks the text whenever the specified delimiter appears. The default value is `\n`, which chunks text by sentences. | ||
| * **Maximum chunk length:** Specifies the maximum number of text characters allowed per chunk. If this limit is exceeded, the system will automatically enforce chunking. | ||
| You can manually edit auto-generated summaries or regenerate them for specific documents later. See [Manage Documents and Chunks](/en/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents) for details. |
Copilot
AI
Jan 22, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link text "Manage Documents and Chunks" doesn't match the actual page title "Manage Knowledge Content". While the link target is correct, consider using either the exact page title or adjusting the text to something like "manage documents and chunks" (lowercase, as part of a sentence) to make it clear it's a descriptive reference rather than a title reference.
f804cf3 to
b874d19
Compare
b874d19 to
7cd52d4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
e0dd9e3 to
718702b
Compare
No description provided.