[DOCS]: Missing 'chunk - overlap' property in Dify.ai document creation API doc #265

Closed
opened 2026-02-16 05:19:40 -05:00 by yindo · 1 comment
Owner

Originally created by @YesonWyld on GitHub (Nov 7, 2025).

Type of Documentation Change

Error/Typo fix

Documentation Page URL or Path

https://docs.dify.ai/api-reference/documents/create-a-document-from-text#body-process-rule-rules-segmentation

Current Content

The documentation at the link https://docs.dify.ai/api-reference/documents/create-a-document-from-text#body-process-rule-rules-segmentation lacks the 'chunk - overlap' property. In actual usage, the 'chunk - overlap' property is needed to configure "The number of overlapping tokens between adjacent sub-chunks.".

Suggested Changes

The specific content that should be added is as follows:

process_rule.rules.segmentation.chunk_overlap
integer
The number of overlapping tokens between adjacent sub-chunks.

Reason for Change

No response

Code of Conduct

  • I agree to follow Dify's documentation contribution guidelines
  • I have searched for existing issues search for existing issues, including closed ones.
  • I confirm that I am using English to submit this report, otherwise it will be closed.
  • 【中文用户 & Non English User】请使用英语提交,否则会被关闭 :)
  • Please do not modify this template :) and fill in all the required fields.
Originally created by @YesonWyld on GitHub (Nov 7, 2025). ### Type of Documentation Change Error/Typo fix ### Documentation Page URL or Path https://docs.dify.ai/api-reference/documents/create-a-document-from-text#body-process-rule-rules-segmentation ### Current Content The documentation at the link https://docs.dify.ai/api-reference/documents/create-a-document-from-text#body-process-rule-rules-segmentation lacks the '```chunk - overlap```' property. In actual usage, the '```chunk - overlap```' property is needed to configure "The number of overlapping tokens between adjacent sub-chunks.". ### Suggested Changes The specific content that should be added is as follows: **process_rule.rules.segmentation.chunk_overlap** ```integer``` The number of overlapping tokens between adjacent sub-chunks. ### Reason for Change _No response_ ### Code of Conduct - [x] I agree to follow Dify's documentation [contribution guidelines](https://github.com/langgenius/dify/blob/0277a37fcad5ad86aeb239485c27fffd5cd90043/CONTRIBUTING.md) - [x] I have searched for existing issues [search for existing issues](https://github.com/langgenius/dify/issues), including closed ones. - [x] I confirm that I am using English to submit this report, otherwise it will be closed. - [x] 【中文用户 & Non English User】请使用英语提交,否则会被关闭 :) - [x] Please do not modify this template :) and fill in all the required fields.
yindo added the documentation label 2026-02-16 05:19:40 -05:00
yindo closed this issue 2026-02-16 05:19:40 -05:00
Author
Owner

@dosubot[bot] commented on GitHub (Nov 18, 2025):

Hi, @wldgntlmn. I'm Dosu, and I'm helping the dify-docs team manage their backlog and am marking this issue as stale.

Issue Summary:

  • You pointed out that the Dify.ai document creation API documentation is missing the 'chunk_overlap' property.
  • This property is important as it defines the overlap of tokens between adjacent sub-chunks.
  • You recommended adding this property to the segmentation rules section for accuracy.
  • There has been no further activity or comments on this issue since your initial report.

Next Steps:

  • Please let me know if this issue is still relevant to the latest version of the dify-docs repository by commenting here.
  • If I do not hear back within 5 days, I will automatically close this issue.

Thank you for your understanding and contribution!

@dosubot[bot] commented on GitHub (Nov 18, 2025): Hi, @wldgntlmn. I'm [Dosu](https://dosu.dev), and I'm helping the dify-docs team manage their backlog and am marking this issue as stale. **Issue Summary:** - You pointed out that the Dify.ai document creation API documentation is missing the 'chunk_overlap' property. - This property is important as it defines the overlap of tokens between adjacent sub-chunks. - You recommended adding this property to the segmentation rules section for accuracy. - There has been no further activity or comments on this issue since your initial report. **Next Steps:** - Please let me know if this issue is still relevant to the latest version of the dify-docs repository by commenting here. - If I do not hear back within 5 days, I will automatically close this issue. Thank you for your understanding and contribution!
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify-docs#265