內建工具

由 smolagents 庫提供的即用型工具實現。

這些內建工具是 Tool 基類的具體實現，每個都為特定任務設計，如網頁搜尋、Python 程式碼執行、網頁檢索和使用者互動。您可以在您的智慧體中直接使用這些工具，而無需自己實現底層功能。每個工具處理一種特定能力，並遵循一致的介面，使其易於組合成強大的智慧體工作流程。

內建工具可以按其主要功能分類

資訊檢索：從網路和特定知識源中搜索和檢索資訊。
網路互動：從特定網頁獲取和處理內容。
- VisitWebpageTool
程式碼執行：動態執行 Python 程式碼以完成計算任務。
- PythonInterpreterTool
使用者互動：實現智慧體與使用者之間的人機協同合作。
- UserInputTool：收集使用者輸入。
語音處理：將音訊轉換為文字資料。
- SpeechToTextTool
工作流控制：管理和指導智慧體操作的流程。
- FinalAnswerTool：以最終響應結束智慧體工作流程。

ApiWebSearchTool

class smolagents.ApiWebSearchTool

< 源 >

( endpoint: str = '' api_key: str = '' api_key_name: str = '' headers: dict = None params: dict = None rate_limit: float | None = 1.0 )

引數

endpoint (str) — API 端點 URL。預設為 Brave Search API。
api_key (str) — 用於身份驗證的 API 金鑰。
api_key_name (str) — 包含 API 金鑰的環境變數名稱。預設為 “BRAVE_API_KEY”。
headers (dict, 可選) — API 請求的頭資訊。
params (dict, 可選) — API 請求的引數。
rate_limit (float, 預設 1.0) — 每秒最大查詢數。設定為 None 可停用速率限制。

執行基於 API 搜尋的網路搜尋工具。預設情況下，它使用 Brave Search API。

該工具實現了速率限制機制，以確保符合 API 使用策略。預設情況下，它將請求限制為每秒 1 次查詢。

示例

>>> from smolagents import ApiWebSearchTool
>>> web_search_tool = ApiWebSearchTool(rate_limit=50.0)
>>> results = web_search_tool("Hugging Face")
>>> print(results)

DuckDuckGoSearchTool

class smolagents.DuckDuckGoSearchTool

< 源 >

( max_results: int = 10 rate_limit: float | None = 1.0 **kwargs )

引數

max_results (int, 預設 10) — 要返回的最大搜索結果數。
rate_limit (float, 預設 1.0) — 每秒最大查詢數。設定為 None 可停用速率限制。
**kwargs — 用於 DDGS 客戶端的附加關鍵字引數。

使用 DuckDuckGo 搜尋引擎執行搜尋的網路搜尋工具。

示例

>>> from smolagents import DuckDuckGoSearchTool
>>> web_search_tool = DuckDuckGoSearchTool(max_results=5, rate_limit=2.0)
>>> results = web_search_tool("Hugging Face")
>>> print(results)

FinalAnswerTool

class smolagents.FinalAnswerTool

< 源 >

( *args **kwargs )

GoogleSearchTool

class smolagents.GoogleSearchTool

< 源 >

( provider: str = 'serpapi' )

PythonInterpreterTool

class smolagents.PythonInterpreterTool

< 源 >

( *args authorized_imports = None **kwargs )

SpeechToTextTool

class smolagents.SpeechToTextTool

< 源 >

( *args **kwargs )

UserInputTool

class smolagents.UserInputTool

< 源 >

( *args **kwargs )

VisitWebpageTool

class smolagents.VisitWebpageTool

< 源 >

( max_output_length: int = 40000 )

WebSearchTool

class smolagents.WebSearchTool

< 源 >

( max_results: int = 10 engine: str = 'duckduckgo' )

WikipediaSearchTool

class smolagents.WikipediaSearchTool

< 源 >

( user_agent: str = 'Smolagents (myemail@example.com)' language: str = 'en' content_type: str = 'text' extract_format: str = 'WIKI' )

引數

user_agent (str) — 用於識別專案的自定義使用者代理字串。根據維基百科 API 政策要求。請參閱：https://foundation.wikimedia.org/wiki/Policy:Wikimedia_Foundation_User-Agent_Policy
language (str, 預設 "en") — 檢索維基百科文章的語言。請參閱：http://meta.wikimedia.org/wiki/List_of_Wikipedias
content_type (Literal["summary", "text"], 預設 "text") — 要獲取的內容型別。可以是“summary”表示簡短摘要，或“text”表示全文。
extract_format (Literal["HTML", "WIKI"], 預設 "WIKI") — 輸出的提取格式。可以是 "WIKI" 或 "HTML"。

搜尋維基百科並返回所請求文章的摘要或全文，以及頁面 URL。

示例

>>> from smolagents import CodeAgent, InferenceClientModel, WikipediaSearchTool
>>> agent = CodeAgent(
>>>     tools=[
>>>            WikipediaSearchTool(
>>>                user_agent="MyResearchBot (myemail@example.com)",
>>>                language="en",
>>>                content_type="summary",  # or "text"
>>>                extract_format="WIKI",
>>>            )
>>>        ],
>>>     model=InferenceClientModel(),
>>> )
>>> agent.run("Python_(programming_language)")

< > 在 GitHub 上更新