mirror of
https://github.com/infiniflow/ragflow.git
synced 2025-12-08 12:32:30 +08:00
3f6177b5e5
### What problem does this PR solve? #9082 #6365 ### Type of change - [x] New Feature (non-breaking change which adds functionality)
120 lines
5.0 KiB
Python
120 lines
5.0 KiB
Python
#
|
|
# Copyright 2024 The InfiniFlow Authors. All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
import logging
|
|
import os
|
|
import time
|
|
from abc import ABC
|
|
from duckduckgo_search import DDGS
|
|
from agent.tools.base import ToolMeta, ToolParamBase, ToolBase
|
|
from api.utils.api_utils import timeout
|
|
|
|
|
|
class DuckDuckGoParam(ToolParamBase):
|
|
"""
|
|
Define the DuckDuckGo component parameters.
|
|
"""
|
|
|
|
def __init__(self):
|
|
self.meta:ToolMeta = {
|
|
"name": "duckduckgo_search",
|
|
"description": "DuckDuckGo is a search engine focused on privacy. It offers search capabilities for web pages, images, and provides translation services. DuckDuckGo also features a private AI chat interface, providing users with an AI assistant that prioritizes data protection.",
|
|
"parameters": {
|
|
"query": {
|
|
"type": "string",
|
|
"description": "The search keywords to execute with DuckDuckGo. The keywords should be the most important words/terms(includes synonyms) from the original request.",
|
|
"default": "{sys.query}",
|
|
"required": True
|
|
},
|
|
"channel": {
|
|
"type": "string",
|
|
"description": "default:general. The category of the search. `news` is useful for retrieving real-time updates, particularly about politics, sports, and major current events covered by mainstream media sources. `general` is for broader, more general-purpose searches that may include a wide range of sources.",
|
|
"enum": ["general", "news"],
|
|
"default": "general",
|
|
"required": False,
|
|
},
|
|
}
|
|
}
|
|
super().__init__()
|
|
self.top_n = 10
|
|
self.channel = "text"
|
|
|
|
def check(self):
|
|
self.check_positive_integer(self.top_n, "Top N")
|
|
self.check_valid_value(self.channel, "Web Search or News", ["text", "news"])
|
|
|
|
def get_input_form(self) -> dict[str, dict]:
|
|
return {
|
|
"query": {
|
|
"name": "Query",
|
|
"type": "line"
|
|
},
|
|
"channel": {
|
|
"name": "Channel",
|
|
"type": "options",
|
|
"value": "general",
|
|
"options": ["general", "news"]
|
|
}
|
|
}
|
|
|
|
|
|
class DuckDuckGo(ToolBase, ABC):
|
|
component_name = "DuckDuckGo"
|
|
|
|
@timeout(os.environ.get("COMPONENT_EXEC_TIMEOUT", 12))
|
|
def _invoke(self, **kwargs):
|
|
if not kwargs.get("query"):
|
|
self.set_output("formalized_content", "")
|
|
return ""
|
|
|
|
last_e = ""
|
|
for _ in range(self._param.max_retries+1):
|
|
try:
|
|
if kwargs.get("topic", "general") == "general":
|
|
with DDGS() as ddgs:
|
|
# {'title': '', 'href': '', 'body': ''}
|
|
duck_res = ddgs.text(kwargs["query"], max_results=self._param.top_n)
|
|
self._retrieve_chunks(duck_res,
|
|
get_title=lambda r: r["title"],
|
|
get_url=lambda r: r.get("href", r.get("url")),
|
|
get_content=lambda r: r["body"])
|
|
self.set_output("json", duck_res)
|
|
return self.output("formalized_content")
|
|
else:
|
|
with DDGS() as ddgs:
|
|
# {'date': '', 'title': '', 'body': '', 'url': '', 'image': '', 'source': ''}
|
|
duck_res = ddgs.news(kwargs["query"], max_results=self._param.top_n)
|
|
self._retrieve_chunks(duck_res,
|
|
get_title=lambda r: r["title"],
|
|
get_url=lambda r: r.get("href", r.get("url")),
|
|
get_content=lambda r: r["body"])
|
|
self.set_output("json", duck_res)
|
|
return self.output("formalized_content")
|
|
except Exception as e:
|
|
last_e = e
|
|
logging.exception(f"DuckDuckGo error: {e}")
|
|
time.sleep(self._param.delay_after_error)
|
|
|
|
if last_e:
|
|
self.set_output("_ERROR", str(last_e))
|
|
return f"DuckDuckGo error: {last_e}"
|
|
|
|
assert False, self.output()
|
|
|
|
def thoughts(self) -> str:
|
|
return """
|
|
Keywords: {}
|
|
Looking for the most relevant articles.
|
|
""".format(self.get_input().get("query", "-_-!")) |