langgenius/dify
1
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-07-22 04:25:29 -04:00
Code Issues 775 Packages Projects Releases 10 Wiki Activity

External Knowledge API Documentation looks wrong #5999

New Issue
Closed
opened 2026-02-21 18:13:36 -05:00 by yindo · 1 comment
yindo commented 2026-02-21 18:13:36 -05:00
Owner
Copy Link
Copy Source

Originally created by @MrXionGe on GitHub (Oct 10, 2024).

Originally assigned to: @AllenWriter on GitHub.

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

Doc URL

https://docs.dify.ai/guides/knowledge-base/external-knowledge-api-documentation

Screenshot

image

My opinion

“records”. A list of records from querying the knowledge base.
It should be an array. Typically, there are multiple results for knowledge base recall.
An example response would be:

{
    "records": [
        {
            "content": "text",
            "score": 0,
            "title": "text",
            "metadata": "text"
        },
        {
            "content": "text",
            "score": 0,
            "title": "text",
            "metadata": "text"
        },
        {
            "content": "text",
            "score": 0,
            "title": "text",
            "metadata": "text"
        }
    ]
}
Originally created by @MrXionGe on GitHub (Oct 10, 2024). Originally assigned to: @AllenWriter on GitHub. ### 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 ### Doc URL https://docs.dify.ai/guides/knowledge-base/external-knowledge-api-documentation ### Screenshot ![image](https://github.com/user-attachments/assets/7b09e12d-5522-42cd-9d6c-b0efcd6685c1) ### My opinion “records”. A list of records from querying the knowledge base. It should be an array. Typically, there are multiple results for knowledge base recall. An example response would be: ``` json { "records": [ { "content": "text", "score": 0, "title": "text", "metadata": "text" }, { "content": "text", "score": 0, "title": "text", "metadata": "text" }, { "content": "text", "score": 0, "title": "text", "metadata": "text" } ] } ```
yindo added the 📚 documentation label 2026-02-21 18:13:36 -05:00
yindo closed this issue 2026-02-21 18:13:36 -05:00
yindo commented 2026-02-21 18:13:36 -05:00
Author
Owner
Copy Link
Copy Source

@AllenWriter commented on GitHub (Oct 10, 2024):

Gitbook's issue is that it cannot render the OpenAPI code correctly;
I have already provided feedback to the Gitbook team.

@AllenWriter commented on GitHub (Oct 10, 2024): Gitbook's issue is that it cannot render the OpenAPI code correctly; I have already provided feedback to the Gitbook team.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Knowledge Pipeline
Proposal
WIP
cloud
dependencies
feat:webapp
good first issue
outdated
performance
pull-request
Mirrored from GitHub Pull Request
 python:uv
refactor
size:L
stale
status: accepting prs
status: blocked
status: in discussion
stt & tts
vulnerablity
web
wont-fix
🌊 feat:workflow
🌚 invalid
🐞 bug
👻 feat:rag
💪 enhancement
📚 documentation
🔨 feat:tools
🙋‍♂️ question
🙏 help wanted
🤔 cant-reproduce
🤖 feat:agent
No Label 📚 documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#5999
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?