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

[PR #5555] Feat/add json process tool #24975

New Issue
Closed
opened 2026-02-21 20:24:02 -05:00 by yindo · 0 comments
yindo commented 2026-02-21 20:24:02 -05:00
Owner
Copy Link
Copy Source

Original Pull Request: https://github.com/langgenius/dify/pull/5555

State: closed
Merged: Yes

Description

The existing template-transform node is quite complex when it comes to processing JSON data. For example, to extract just the URL from {"result": "{"url": "https://github.com/langgenius/dify"}\n"}, the complex code {{ result | replace('\n','') | replace('{"url": "','') | replace('"}','') }} needs to be used. To address this, a tool that uses jsonpath-ng for JSON processing has been introduced. This tool can parse, insert, delete and replace JSON content using simple instructions, greatly improving the ease of handling JSON. For the above example, simply inputting 'url' in json_filter is enough to obtain "https://github.com/langgenius/dify". This tool has significantly enhanced the convenience of JSON processing.

https://github.com/langgenius/dify/assets/105796305/b6c58e58-1dba-4217-ac05-0da011d70315

parse

Given a JSON content and a json_filter, return the parsed result.
When the parsed result is a JSON structure, return it in JSON format. In other cases such as strings, numbers, etc., return a string.

insert

Given a JSON content, a query path, and a new_value:

  • If the query path exists:
    1. If the matched item is a dictionary, update an existing key-value pair or add a new one.
    2. If the matched item is a list, insert the new_value at the specified index, or append it to the end.
    3. For other types, directly replace the original value with the new_value.
  • If the query path does not exist and create_path is true, create the new path and insert the new_value.
  • Otherwise, do not make any changes.

delete

Given a JSON content and query. Based on the type of the query match, perform different deletion operations:

  • For dictionaries, delete the specified key.
  • For lists, remove the specified element.
  • For other cases, try to delete the corresponding key in the parent element.

replace

Given the JSON content, query, replace_value, and replace_model:

  • If replace_model is "pattern", for each result matching the query, replace the replace_pattern in the input string with replace_value.
  • If replace_model is "key", replace the key of each match with replace_key.
  • If replace_model is "value", replace the value of each match with replace_value.

Type of Change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update, included: Dify Document
  • Improvement, including but not limited to code refactoring, performance optimization, and UI/UX improvement
  • Dependency upgrade

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • TODO

Suggested Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods
  • optional I have made corresponding changes to the documentation
  • optional I have added tests that prove my fix is effective or that my feature works
  • optional New and existing unit tests pass locally with my changes
**Original Pull Request:** https://github.com/langgenius/dify/pull/5555 **State:** closed **Merged:** Yes --- # Description The existing template-transform node is quite complex when it comes to processing JSON data. For example, to extract just the URL from {"result": "{"url": "[https://github.com/langgenius/dify\"}\n"}](https://github.com/langgenius/dify%5C%22%7D%5Cn%22%7D), the complex code {{ result | replace('\n','') | replace('{"url": "','') | replace('"}','') }} needs to be used. To address this, a tool that uses jsonpath-ng for JSON processing has been introduced. This tool can **parse**, **insert**, **delete** and **replace** JSON content using simple instructions, greatly improving the ease of handling JSON. For the above example, simply inputting 'url' in json_filter is enough to obtain "https://github.com/langgenius/dify". This tool has significantly enhanced the convenience of JSON processing. https://github.com/langgenius/dify/assets/105796305/b6c58e58-1dba-4217-ac05-0da011d70315 ### parse Given a JSON *content* and a *json_filter*, return the parsed result. When the parsed result is a JSON structure, return it in JSON format. In other cases such as strings, numbers, etc., return a string. ### insert Given a JSON *content*, a *query* path, and a *new_value*: - If the *query* path exists: 1. If the matched item is a dictionary, update an existing key-value pair or add a new one. 2. If the matched item is a list, insert the *new_value* at the specified index, or append it to the end. 3. For other types, directly replace the original value with the *new_value*. - If the *query* path does not exist and *create_path* is true, create the new path and insert the *new_value*. - Otherwise, do not make any changes. ### delete Given a JSON *content* and *query*. Based on the type of the *query* match, perform different deletion operations: - For dictionaries, delete the specified key. - For lists, remove the specified element. - For other cases, try to delete the corresponding key in the parent element. ### replace Given the JSON *content*, *query*, *replace_value*, and *replace_model*: - If *replace_model* is "pattern", for each result matching the *query*, replace the *replace_pattern* in the input string with *replace_value*. - If *replace_model* is "key", replace the key of each match with *replace_key*. - If *replace_model* is "value", replace the value of each match with *replace_value*. ## Type of Change Please delete options that are not relevant. - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs) - [ ] Improvement, including but not limited to code refactoring, performance optimization, and UI/UX improvement - [ ] Dependency upgrade # How Has This Been Tested? Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - [ ] TODO # Suggested Checklist: - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [x] My changes generate no new warnings - [ ] I ran `dev/reformat`(backend) and `cd web && npx lint-staged`(frontend) to appease the lint gods - [ ] `optional` I have made corresponding changes to the documentation - [ ] `optional` I have added tests that prove my fix is effective or that my feature works - [ ] `optional` New and existing unit tests pass locally with my changes
yindo added the pull-request label 2026-02-21 20:24:02 -05:00
yindo closed this issue 2026-02-21 20:24:02 -05:00
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 pull-request
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#24975
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?