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

The tool returns json results but there are no json output variables available in the front-end page tool. #4352

New Issue
Closed
opened 2026-02-21 18:06:02 -05:00 by yindo · 2 comments
yindo commented 2026-02-21 18:06:02 -05:00
Owner
Copy Link
Copy Source

Originally created by @Sakura4036 on GitHub (Jul 1, 2024).

Self Checks

  • This is only for bug report, if you would like to ask a question, please head to Discussions.
  • I have searched for existing issues search for existing issues, including closed ones.
  • I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
  • 请务必使用英文提交 Issue，否则会被关闭。谢谢！:）
  • Please do not modify this template :) and fill in all the required fields.

Dify version

0.6.12-fix1

Cloud or Self Hosted

Self Hosted (Source)

Steps to reproduce

Creating a workflow that uses the GoogleSearch tool.

image

✔️ Expected Behavior

The tool output variable contains text, files, and json.

Wish the front-end could be modified immediately to accommodate the JSON Message API in the tool.

❌ Actual Behavior

The tool output variable only contains text, files.

Originally created by @Sakura4036 on GitHub (Jul 1, 2024). ### Self Checks - [X] This is only for bug report, if you would like to ask a question, please head to [Discussions](https://github.com/langgenius/dify/discussions/categories/general). - [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 this report (我已阅读并同意 [Language Policy](https://github.com/langgenius/dify/issues/1542)). - [X] 请务必使用英文提交 Issue，否则会被关闭。谢谢！:） - [X] Please do not modify this template :) and fill in all the required fields. ### Dify version 0.6.12-fix1 ### Cloud or Self Hosted Self Hosted (Source) ### Steps to reproduce Creating a workflow that uses the GoogleSearch tool. ![image](https://github.com/langgenius/dify/assets/42060616/5fdb8da3-be3c-433a-8dfd-68a898233b35) ### ✔️ Expected Behavior The tool output variable contains text, files, and json. Wish the front-end could be modified immediately to accommodate the [JSON Message API in the tool](https://github.com/langgenius/dify/pull/5440). ### ❌ Actual Behavior The tool output variable only contains text, files.
yindo closed this issue 2026-02-21 18:06:02 -05:00
yindo commented 2026-02-21 18:06:02 -05:00
Author
Owner
Copy Link
Copy Source

@dosubot[bot] commented on GitHub (Jul 1, 2024):

To modify the front-end of Dify version 0.6.12-fix1 to accommodate JSON output variables from the GoogleSearch tool, follow these steps:

  1. Update the Tool YAML Configuration:
    Ensure that the google_search.yaml file includes the necessary output format for JSON.

    identity:
  name: google_search
  author: Dify
  label:
    en_US: GoogleSearch
    zh_Hans: 谷歌搜索
description:
  human:
    en_US: A tool for performing a Google SERP search and extracting snippets and webpages. Input should be a search query.
    zh_Hans: 一个用于执行 Google SERP 搜索并提取片段和网页的工具。输入应该是一个搜索查询。
  llm: A tool for performing a Google SERP search and extracting snippets and webpages. Input should be a search query.
parameters:
  - name: query
    type: string
    required: true
    label:
      en_US: Query string
      zh_Hans: 查询语句
    human_description:
      en_US: used for searching
      zh_Hans: 用于搜索网页内容
    llm_description: key words for searching
    form: llm
  - name: result_type
    type: select
    required: true
    options:
      - value: text
        label:
          en_US: text
          zh_Hans: 文本
      - value: link
        label:
          en_US: link
          zh_Hans: 链接
      - value: json
        label:
          en_US: JSON
          zh_Hans: JSON
    default: link
    label:
      en_US: Result type
      zh_Hans: 结果类型
    human_description:
      en_US: used for selecting the result type, text, link, or JSON
      zh_Hans: 用于选择结果类型，使用文本、链接或JSON进行展示
    form: form

  2. Modify the Tool Logic:
    Update the google_search.py to handle the JSON output.

    from core.tools.tool.builtin_tool import BuiltinTool
from core.tools.entities.tool_entities import ToolInvokeMessage

from typing import Any, Dict, List, Union

class GoogleSearchTool(BuiltinTool):
    def _invoke(self, 
                user_id: str,
                tool_parameters: Dict[str, Any], 
        ) -> Union[ToolInvokeMessage, List[ToolInvokeMessage]]:
        """
            invoke tools
        """
        query = tool_parameters['query']
        result_type = tool_parameters['result_type']
        api_key = self.runtime.credentials['serpapi_api_key']
        # TODO: search with serpapi
        result = SerpAPI(api_key).run(query, result_type=result_type)

        if result_type == 'text':
            return self.create_text_message(text=result)
        elif result_type == 'link':
            return self.create_link_message(link=result)
        elif result_type == 'json':
            return self.create_json_message(json=result)

    def create_json_message(self, json: Any) -> ToolInvokeMessage:
        return ToolInvokeMessage(
            type="json",
            content=json
        )

  3. Update the Front-End:
    Ensure that the front-end is capable of displaying JSON output. This might involve updating the front-end code to handle and render JSON messages appropriately.

    // Example front-end code snippet to handle JSON output
function renderMessage(message) {
    if (message.type === 'json') {
        const jsonContent = JSON.stringify(message.content, null, 2);
        document.getElementById('output').innerText = jsonContent;
    } else if (message.type === 'text') {
        document.getElementById('output').innerText = message.content;
    } else if (message.type === 'link') {
        const linkElement = document.createElement('a');
        linkElement.href = message.content;
        linkElement.innerText = message.content;
        document.getElementById('output').appendChild(linkElement);
    }
}

By following these steps, you can modify the front-end of Dify to accommodate JSON output variables from the GoogleSearch tool in your workflow [1][2].

To continue talking to Dosu, mention @dosu.

@dosubot[bot] commented on GitHub (Jul 1, 2024): <!-- Answer --> To modify the front-end of Dify version 0.6.12-fix1 to accommodate JSON output variables from the GoogleSearch tool, follow these steps: 1. **Update the Tool YAML Configuration:** Ensure that the `google_search.yaml` file includes the necessary output format for JSON. ```yaml identity: name: google_search author: Dify label: en_US: GoogleSearch zh_Hans: 谷歌搜索 description: human: en_US: A tool for performing a Google SERP search and extracting snippets and webpages. Input should be a search query. zh_Hans: 一个用于执行 Google SERP 搜索并提取片段和网页的工具。输入应该是一个搜索查询。 llm: A tool for performing a Google SERP search and extracting snippets and webpages. Input should be a search query. parameters: - name: query type: string required: true label: en_US: Query string zh_Hans: 查询语句 human_description: en_US: used for searching zh_Hans: 用于搜索网页内容 llm_description: key words for searching form: llm - name: result_type type: select required: true options: - value: text label: en_US: text zh_Hans: 文本 - value: link label: en_US: link zh_Hans: 链接 - value: json label: en_US: JSON zh_Hans: JSON default: link label: en_US: Result type zh_Hans: 结果类型 human_description: en_US: used for selecting the result type, text, link, or JSON zh_Hans: 用于选择结果类型，使用文本、链接或JSON进行展示 form: form ``` 2. **Modify the Tool Logic:** Update the `google_search.py` to handle the JSON output. ```python from core.tools.tool.builtin_tool import BuiltinTool from core.tools.entities.tool_entities import ToolInvokeMessage from typing import Any, Dict, List, Union class GoogleSearchTool(BuiltinTool): def _invoke(self, user_id: str, tool_parameters: Dict[str, Any], ) -> Union[ToolInvokeMessage, List[ToolInvokeMessage]]: """ invoke tools """ query = tool_parameters['query'] result_type = tool_parameters['result_type'] api_key = self.runtime.credentials['serpapi_api_key'] # TODO: search with serpapi result = SerpAPI(api_key).run(query, result_type=result_type) if result_type == 'text': return self.create_text_message(text=result) elif result_type == 'link': return self.create_link_message(link=result) elif result_type == 'json': return self.create_json_message(json=result) def create_json_message(self, json: Any) -> ToolInvokeMessage: return ToolInvokeMessage( type="json", content=json ) ``` 3. **Update the Front-End:** Ensure that the front-end is capable of displaying JSON output. This might involve updating the front-end code to handle and render JSON messages appropriately. ```javascript // Example front-end code snippet to handle JSON output function renderMessage(message) { if (message.type === 'json') { const jsonContent = JSON.stringify(message.content, null, 2); document.getElementById('output').innerText = jsonContent; } else if (message.type === 'text') { document.getElementById('output').innerText = message.content; } else if (message.type === 'link') { const linkElement = document.createElement('a'); linkElement.href = message.content; linkElement.innerText = message.content; document.getElementById('output').appendChild(linkElement); } } ``` By following these steps, you can modify the front-end of Dify to accommodate JSON output variables from the GoogleSearch tool in your workflow <sup>[[1]](https://github.com/langgenius/dify/blob/main/api/core/tools/docs/en_US/tool_scale_out.md)</sup><sup>[[2]](https://github.com/langgenius/dify-docs/blob/main/en/guides/tools/quick-tool-integration.md)</sup>. <!-- Dosu Comment Footer --> *To continue talking to [Dosu](https://dosu.dev), mention @dosu.*
yindo commented 2026-02-21 18:06:02 -05:00
Author
Owner
Copy Link
Copy Source

@hjlarry commented on GitHub (Jul 3, 2024):

OK, I will try to fix this later.

@hjlarry commented on GitHub (Jul 3, 2024): OK, I will try to fix this later.
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
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#4352
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?