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

The chunk_overlap parameter is not documented in the Knowledge API specification. #12180

Open
4 tasks done
yagiyuki opened this issue Dec 28, 2024 · 0 comments
Open
4 tasks done
Labels
📚 documentation Improvements or additions to documentation

Comments

@yagiyuki
Copy link
Contributor

yagiyuki commented Dec 28, 2024

Self Checks

  • I have searched for existing issues search for existing issues, including closed ones.
  • I confirm that I am using English to submit report (我已阅读并同意 Language Policy).
  • [FOR CHINESE USERS] 请务必使用英文提交 Issue,否则会被关闭。谢谢!:)
  • Please do not modify this template :) and fill in all the required fields.

Provide a description of requested docs changes

It is possible to specify "chunk_overlap" as a parameter for document creation in the Knowledge API.
However, this is not mentioned in the API specifications, so an addition is required.

ex: Create a Document from a Fileにおけるchunk_overlap

curl \
  --location \
  --request POST \
  "http://localhost/v1/datasets/${dataset_id}/document/create-by-file" \
  --header "Authorization: Bearer ${api_key}" \
  --form 'data={
    "indexing_technique": "high_quality",
    "process_rule": {
      "rules": {
        "pre_processing_rules": [
          { "id": "remove_extra_spaces", "enabled": true },
          { "id": "remove_urls_emails",  "enabled": true }
        ],
        "segmentation": {
          "separator": "###",
          "max_tokens": 500,
          "chunk_overlap": 100
        }
      },
      "mode": "custom"
    }
  };type=application/json' \
  --form 'file=@"test.txt"'
@dosubot dosubot bot added the 📚 documentation Improvements or additions to documentation label Dec 28, 2024
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
Projects
None yet
Development

No branches or pull requests

1 participant