feat: support reading tags via API (#12891)

[water-in-stone]

What problem does this PR solve?

Enable reading Tag Set tags via API (expose tag_kwd field). The result of the queried list chunks is as shown below:

Type of change

• New Feature (non-breaking change which adds functionality)

[water-in-stone]

@yingfeng PTAL

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.72%. Comparing base (cb78ce0) to head (e298d6d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #13732      +/-   ##
==========================================
- Coverage   98.14%   96.72%   -1.42%     
==========================================
  Files          10       10              
  Lines         702      703       +1     
  Branches      112      112              
==========================================
- Hits          689      680       -9     
- Misses          3        5       +2     
- Partials       10       18       +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[water-in-stone]

@yingfeng wait a moment. I will fix all the unit test errors.

[water-in-stone]

@yingfeng I have fixed all the unit test errors. Please take a look again.

[water-in-stone]

@yingfeng The unit tests were cancelled, could you please help me re-run all the unit tests?

[Copilot]

Pull request overview

This PR adds support for exposing chunk tag keywords (tag_kwd) through the API and propagates that field through the Python SDK, retrieval outputs, and test coverage.

Changes:

• Expose tag_kwd in chunk list/retrieval outputs and SDK chunk objects.
• Accept and validate tag_kwd on chunk create/update endpoints.
• Add HTTP API + Python SDK test cases covering tag_kwd.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
api/apps/sdk/doc.py	Adds tag_kwd to chunk model/output and validates tag_kwd in add/update chunk endpoints (plus OpenAPI response/request docs in some places).
api/apps/chunk_app.py	Adds tag_kwd validation for web chunk create/set flows.
sdk/python/ragflow_sdk/modules/document.py	Adds tag_kwd parameter to Python SDK Document.add_chunk() request body.
sdk/python/ragflow_sdk/modules/chunk.py	Adds tag_kwd attribute so SDK chunk objects retain the field.
rag/nlp/search.py	Includes tag_kwd in retrieval result payloads.
internal/service/chunk.go	Includes tag_kwd when building retrieval test results.
test/testcases/test_sdk_api/test_chunk_management_within_dataset/test_add_chunk.py	Adds SDK tests/validation for tag_kwd on chunk creation.
test/testcases/test_sdk_api/test_chunk_management_within_dataset/test_update_chunk.py	Adds SDK tests for tag_kwd on chunk update.
test/testcases/test_http_api/test_chunk_management_within_dataset/test_add_chunk.py	Adds HTTP API tests for tag_kwd on chunk creation and updates validation helper.
test/testcases/test_http_api/test_chunk_management_within_dataset/test_update_chunk.py	Adds HTTP API tests for tag_kwd on chunk update.
test/testcases/conftest.py	Fixes f-string quoting in token fixture error message.
example/http/chunk_example.sh	Adds a curl example showing tag_kwd in list-chunks output.

Comments suppressed due to low confidence (1)

test/testcases/test_http_api/test_chunk_management_within_dataset/test_add_chunk.py:184

• Inside the expected_code == 0 branch, if res["code"] != 0: assert False is unreachable because the test already asserted res["code"] == expected_code. Removing this dead check will simplify the test and avoid confusion.

        if expected_code == 0:
            validate_chunk_details(dataset_id, document_id, payload, res)
            if res["code"] != 0:
                assert False, res

[water-in-stone]

@yingfeng I have modified my code based on the comments from Copilot. Please take look again.

[yongtenglei]

Hi @water-in-stone

Thank you for your contribution. Codes are all good to me. However, I would like to suggest removing example/http/chunk_example.sh. What do you think? Let me know.

Cheers.

[yingfeng]

Since you've modified API, can you add corresponding adjustments to API documents in this PR?

[water-in-stone]

Hi @water-in-stone

Thank you for your contribution. Codes are all good to me. However, I would like to suggest removing example/http/chunk_example.sh. What do you think? Let me know.

Cheers.

@yongtenglei Thanks for your suggestion. I have removed example/http/chunk_example.sh.

[water-in-stone]

Since you've modified API, can you add corresponding adjustments to API documents in this PR?

@yingfeng Thanks for your suggestion. I have updated the docs corresponding to this PR. Please take a look again.