Setting metadata: FALSE Causes Empty Results in Workflows #13876

Closed
opened 2026-02-21 19:14:19 -05:00 by yindo · 1 comment
Owner

Originally created by @yuji-ogawa-short on GitHub (May 14, 2025).

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

I discovered this while creating the External Knowledge API.
https://docs.dify.ai/en/guides/knowledge-base/external-knowledge-api

The documentation states that metadata is not required (i.e., "Required" is set to false).
However, although it passed during testing, when actually used in workflows, I found that the result would sometimes be empty.

Once I modified it to return metadata, the process worked correctly.

Just wanted to report this.

Originally created by @yuji-ogawa-short on GitHub (May 14, 2025). ### Self Checks - [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 report (我已阅读并同意 [Language Policy](https://github.com/langgenius/dify/issues/1542)). - [x] [FOR CHINESE USERS] 请务必使用英文提交 Issue,否则会被关闭。谢谢!:) - [x] Please do not modify this template :) and fill in all the required fields. ### Provide a description of requested docs changes I discovered this while creating the External Knowledge API. https://docs.dify.ai/en/guides/knowledge-base/external-knowledge-api The documentation states that metadata is not required (i.e., "Required" is set to false). However, although it passed during testing, when actually used in workflows, I found that the result would sometimes be empty. Once I modified it to return metadata, the process worked correctly. Just wanted to report this.
yindo added the 🐞 bugstale labels 2026-02-21 19:14:19 -05:00
yindo closed this issue 2026-02-21 19:14:19 -05:00
Author
Owner

@dosubot[bot] commented on GitHub (May 14, 2025):

Hello @yuji-ogawa-short! I'm Dosu, and I'm here to help you solve bugs, answer questions, and guide you in becoming a contributor. While you're waiting for a human maintainer, feel free to share any details or questions you have!

The issue you're experiencing with the External Knowledge API returning empty results when metadata is set to FALSE in workflows might be related to known limitations or bugs in the Dify platform. According to the documentation, the metadata property is optional and not required to be present in the response when set to FALSE [1]. However, there have been reports of metadata filtering not working correctly in workflows, which could potentially lead to unexpected empty results [2].

If modifying the setting to return metadata resolves the issue, it suggests that there might be a dependency or bug related to how metadata is handled in workflows. It would be beneficial to check if there are any updates or patches available for Dify that address this specific behavior.

To continue talking to Dosu, mention @dosu.


Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other

@dosubot[bot] commented on GitHub (May 14, 2025): <!-- Greeting --> Hello @yuji-ogawa-short! I'm [Dosu](https://dosu.dev), and I'm here to help you solve bugs, answer questions, and guide you in becoming a contributor. While you're waiting for a human maintainer, feel free to share any details or questions you have! <!-- Answer --> The issue you're experiencing with the External Knowledge API returning empty results when metadata is set to FALSE in workflows might be related to known limitations or bugs in the Dify platform. According to the documentation, the `metadata` property is optional and not required to be present in the response when set to FALSE <sup>[[1]](https://github.com/crazywoola/dify-docs-mintlify/blob/main/ja-jp/guides/knowledge-base/api-documentation/external-knowledge-api-documentation.mdx)</sup>. However, there have been reports of metadata filtering not working correctly in workflows, which could potentially lead to unexpected empty results <sup>[[2]](https://github.com/langgenius/dify/issues/16466)</sup>. If modifying the setting to return metadata resolves the issue, it suggests that there might be a dependency or bug related to how metadata is handled in workflows. It would be beneficial to check if there are any updates or patches available for Dify that address this specific behavior. <!-- Dosu Comment Footer --> *To continue talking to [Dosu](https://dosu.dev), mention @dosu.* --- <sup>Help Dosu learn! Give it feedback: [Great Response](https://app.dosu.dev/response-feedback/2a792bbe-dd7f-443c-acb6-27a09239725c?feedback_type=great_response) | [Irrelevant Answer](https://app.dosu.dev/response-feedback/2a792bbe-dd7f-443c-acb6-27a09239725c?feedback_type=irrelevant_answer) | [Incorrect Sources](https://app.dosu.dev/response-feedback/2a792bbe-dd7f-443c-acb6-27a09239725c?feedback_type=incorrect_sources) | [Too Verbose](https://app.dosu.dev/response-feedback/2a792bbe-dd7f-443c-acb6-27a09239725c?feedback_type=too_verbose) | [Hallucination](https://app.dosu.dev/response-feedback/2a792bbe-dd7f-443c-acb6-27a09239725c?feedback_type=hallucination) | [Bug Report](https://app.dosu.dev/response-feedback/2a792bbe-dd7f-443c-acb6-27a09239725c?feedback_type=bug_report) | [Other](https://app.dosu.dev/response-feedback/2a792bbe-dd7f-443c-acb6-27a09239725c?feedback_type=other)</sup>
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#13876