Skip to content
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

doc: Added explanation of chunk_overlap to knowledge API #12247

Merged
merged 1 commit into from
Jan 3, 2025

Conversation

yagiyuki
Copy link
Contributor

@yagiyuki yagiyuki commented Dec 31, 2024

Summary

The following four Knowledge APIs allow you to specify "chunk_overlap" as a parameter when creating a document.
However, this is not described in the API specifications, so it needs to be added.

  • Create a Document from Text
  • Create a Document from a File
  • Update a Document with Text
  • Update a Document with a File

Fixes #12180

Tip

Close issue syntax: Fixes #<issue number> or Resolves #<issue number>, see documentation for more details.

Screenshots

Before After
... ...

Checklist

Important

Please review the checklist below before submitting your pull request.

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. 📚 documentation Improvements or additions to documentation labels Dec 31, 2024
@jasonfish568
Copy link

Commit message not up to the community standard. I would suggest you do some readings on commit message format and also properlly include description in the PR.

@yagiyuki yagiyuki changed the title Added explanation of chunk_overlap to knowledge API doc: Added explanation of chunk_overlap to knowledge API Dec 31, 2024
@yagiyuki
Copy link
Contributor Author

Commit message not up to the community standard. I would suggest you do some readings on commit message format and also properlly include description in the PR.

@jasonfish568

I have updated the PR Summary to include a more detailed description of the changes. Regarding the commit message format, I will make sure to follow the community standards for future commits.

@crazywoola
Copy link
Member

Hello there, please update the docs in JA as well.

@yagiyuki
Copy link
Contributor Author

yagiyuki commented Jan 2, 2025

@crazywoola

Hello there, please update the docs in JA as well.

Thank you for your feedback. Currently, there is no documentation in Japanese for the Knowledge API.
https://github.com/langgenius/dify/tree/5b01eb9437b24a260bf4ec3084256d9995bcf93a/web/app/(commonLayout)/datasets/template

Therefore, I don't think there is any need to take action.

If you think adding it would be helpful, feel free to create a new issue—or let me know, and I can create one.

@crazywoola crazywoola force-pushed the docs/12180-add-chunk-overlap branch from 2eab1cc to ddbff19 Compare January 3, 2025 01:56
@crazywoola
Copy link
Member

@crazywoola

Hello there, please update the docs in JA as well.

Thank you for your feedback. Currently, there is no documentation in Japanese for the Knowledge API. https://github.com/langgenius/dify/tree/5b01eb9437b24a260bf4ec3084256d9995bcf93a/web/app/(commonLayout)/datasets/template

Therefore, I don't think there is any need to take action.

If you think adding it would be helpful, feel free to create a new issue—or let me know, and I can create one.

Thanks :)

Actually I figure it would be helpful to add JA document to this section, because we have added several templates in API develop section right now.

https://github.com/langgenius/dify/blob/6b49889041f5d25cd2c5bc2e0f7915abb7027027/web/app/components/develop/template/template.ja.mdx

We appreciate that you could add this if you have some spare time.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 3, 2025
@crazywoola crazywoola merged commit 7c71bd7 into langgenius:main Jan 3, 2025
4 checks passed
@yagiyuki
Copy link
Contributor Author

yagiyuki commented Jan 4, 2025

@crazywoola

Thank you.

Actually I figure it would be helpful to add JA document to this section, because we have added several templates in API develop section right now.

https://github.com/langgenius/dify/blob/6b49889041f5d25cd2c5bc2e0f7915abb7027027/web/app/components/develop/template/template.ja.mdx

We appreciate that you could add this if you have some spare time.

I added a Japanese-language issue to the Knowledge API.
#12359

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The chunk_overlap parameter is not documented in the Knowledge API specification.
3 participants