fix: update documentation and return types for web tools
- Revised docstrings for `web_search` and `web_extract` functions to clarify return types and structure. - Updated the execution code schema documentation to reflect changes in the output format for both tools, ensuring consistency and improved understanding for users.
This commit is contained in:
parent
783acd712d
commit
273b367f05
1 changed files with 5 additions and 5 deletions
|
|
@ -67,13 +67,13 @@ _TOOL_STUBS = {
|
||||||
"web_search": (
|
"web_search": (
|
||||||
"web_search",
|
"web_search",
|
||||||
"query: str, limit: int = 5",
|
"query: str, limit: int = 5",
|
||||||
'"""Search the web. Returns dict with "results" list of {url, title, description}."""',
|
'"""Search the web. Returns dict with data.web list of {url, title, description}."""',
|
||||||
'{"query": query, "limit": limit}',
|
'{"query": query, "limit": limit}',
|
||||||
),
|
),
|
||||||
"web_extract": (
|
"web_extract": (
|
||||||
"web_extract",
|
"web_extract",
|
||||||
"urls: list",
|
"urls: list",
|
||||||
'"""Extract content from URLs. Returns markdown text."""',
|
'"""Extract content from URLs. Returns dict with results list of {url, content, error}."""',
|
||||||
'{"urls": urls}',
|
'{"urls": urls}',
|
||||||
),
|
),
|
||||||
"read_file": (
|
"read_file": (
|
||||||
|
|
@ -536,9 +536,9 @@ EXECUTE_CODE_SCHEMA = {
|
||||||
"or the task requires interactive user input.\n\n"
|
"or the task requires interactive user input.\n\n"
|
||||||
"Available via `from hermes_tools import ...`:\n\n"
|
"Available via `from hermes_tools import ...`:\n\n"
|
||||||
" web_search(query: str, limit: int = 5) -> dict\n"
|
" web_search(query: str, limit: int = 5) -> dict\n"
|
||||||
" Returns {\"results\": [{\"url\", \"title\", \"description\"}, ...]}\n"
|
" Returns {\"data\": {\"web\": [{\"url\", \"title\", \"description\"}, ...]}}\n"
|
||||||
" web_extract(urls: list[str]) -> str\n"
|
" web_extract(urls: list[str]) -> dict\n"
|
||||||
" Returns extracted page content as markdown text\n"
|
" Returns {\"results\": [{\"url\", \"content\", \"error\"}, ...]} where content is markdown\n"
|
||||||
" read_file(path: str, offset: int = 1, limit: int = 500) -> dict\n"
|
" read_file(path: str, offset: int = 1, limit: int = 500) -> dict\n"
|
||||||
" Lines are 1-indexed. Returns {\"content\": \"...\", \"total_lines\": N}\n"
|
" Lines are 1-indexed. Returns {\"content\": \"...\", \"total_lines\": N}\n"
|
||||||
" write_file(path: str, content: str) -> dict\n"
|
" write_file(path: str, content: str) -> dict\n"
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue