27a6cd31a3
## Before
### Tool: ``GoogleNews.SearchNewsStories``
```python
@tool(requires_secrets=["SERP_API_KEY"])
async def search_news_stories(
context: ToolContext,
keywords: Annotated[
str,
"Keywords to search for news articles. E.g. 'Apple launches new iPhone'.",
],
country_code: Annotated[
CountryCode | None,
"2-character country code to search for news articles. "
"E.g. 'us' (United States). "
f"Defaults to '{DEFAULT_GOOGLE_NEWS_COUNTRY}'.",
] = None,
language_code: Annotated[
LanguageCode,
"2-character language code to search for news articles. E.g. 'en' (English). "
f"Defaults to '{DEFAULT_GOOGLE_NEWS_LANGUAGE}'.",
] = DEFAULT_GOOGLE_NEWS_LANGUAGE,
limit: Annotated[
int | None,
"Maximum number of news articles to return. Defaults to None "
"(returns all results found by the API).",
] = None,
) -> Annotated[dict[str, Any]]:
"""Search for news articles related to a given query."""
...
```
### Tool Definition: ``GoogleNews.SearchNewsStories``
```
{
"name": "SearchNewsStories",
"fully_qualified_name": "GoogleNews.SearchNewsStories",
"description": "Search for news articles related to a given query.",
"toolkit": {
"name": "GoogleNews",
"description": "Arcade.dev LLM tools for getting new via Google News",
"version": "2.0.0"
},
"input": {
"parameters": [
{
"name": "keywords",
"required": true,
"description": "Keywords to search for news articles. E.g. 'Apple launches new iPhone'.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
},
"inferrable": true
},
{
"name": "country_code",
"required": false,
"description": "2-character country code to search for news articles. E.g. 'us' (United States). Defaults to 'None'.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
},
"inferrable": true
},
{
"name": "language_code",
"required": false,
"description": "2-character language code to search for news articles. E.g. 'en' (English). Defaults to 'en'.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
},
"inferrable": true
},
{
"name": "limit",
"required": false,
"description": "Maximum number of news articles to return. Defaults to None (returns all results found by the API).",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
},
"inferrable": true
}
]
},
"output": {
"description": "News search results with article details.",
"available_modes": [
"value",
"error"
],
"value_schema": {
"val_type": "json"
}
},
"requirements": {
"authorization": null,
"secrets": [
{
"key": "serp_api_key"
}
],
"metadata": null
},
"deprecation_message": null
},
```
## After
### Enhanced Tool: ``GoogleNews.SearchNewsStories``
```python
"""Type definitions for Google News API responses and parameters."""
from typing_extensions import TypedDict
CountryCode = str
LanguageCode = str
class SearchNewsParams(TypedDict):
"""Input parameters for searching news articles."""
keywords: str
"""Search query terms to find relevant news articles \
(e.g., 'Apple launches new iPhone')."""
country_code: CountryCode | None
"""Optional 2-letter country code to filter news by region \
(e.g., 'us' for United States, 'uk' for United Kingdom)."""
language_code: LanguageCode | None
"""Optional 2-letter language code to filter news by language \
(e.g., 'en' for English, 'es' for Spanish)."""
limit: int | None
"""Optional maximum number of news articles to return. \
If not specified, returns all results from the API."""
class SourceInfo(TypedDict, total=False):
"""Information about the news source/publication."""
name: str
"""Name of the publication (e.g., 'CNN', 'BBC News', 'The New York Times')."""
icon: str
"""URL to the source's favicon or logo image."""
authors: list[str]
"""List of author names for the article, if available."""
class NewsResult(TypedDict, total=False):
"""Individual news article from the Google News API response."""
position: int
"""Ranking position of this result in the search results."""
title: str
"""Headline or title of the news article."""
link: str
"""Full URL to the original news article."""
source: SourceInfo
"""Information about the publication source."""
date: str
"""Publication date and time (e.g., '2 hours ago', 'Dec 15, 2023')."""
snippet: str
"""Brief excerpt or summary from the article content."""
thumbnail: str
"""URL to a high-resolution thumbnail image for the article."""
thumbnail_small: str
"""URL to a low-resolution thumbnail image for the article."""
story_token: str
"""Token for accessing full coverage of this news story across multiple sources."""
stories: list["NewsResult"]
"""Related news stories from other sources covering the same topic."""
highlight: dict
"""Additional highlighted information about the story."""
class SearchMetadata(TypedDict, total=False):
"""Metadata about the search request and processing."""
id: str
"""Unique identifier for this search request within SerpApi."""
status: str
"""Current processing status ('Processing', 'Success', or 'Error')."""
json_endpoint: str
"""URL to retrieve the JSON results for this search."""
created_at: str
"""Timestamp when the search request was created."""
processed_at: str
"""Timestamp when the search request was processed."""
google_news_url: str
"""Original Google News URL that would return these results."""
total_time_taken: float
"""Total time in seconds taken to process this search."""
class SearchParameters(TypedDict, total=False):
"""Parameters used for the search request."""
engine: str
"""Search engine used (always 'google_news' for this API)."""
q: str
"""Search query string."""
gl: str
"""Country code used for geographic filtering."""
hl: str
"""Language code used for language filtering."""
topic_token: str
"""Token for accessing specific news topics (e.g., 'World', 'Business', 'Technology')."""
publication_token: str
"""Token for accessing news from specific publishers."""
class MenuLink(TypedDict):
"""Navigation link for news categories or topics."""
title: str
"""Display text for the menu item (e.g., 'Technology', 'Sports', 'Business')."""
topic_token: str
"""Token to access this specific topic or category."""
serpapi_link: str
"""SerpApi URL to search within this topic."""
class TopStoriesLink(TypedDict):
"""Link to top stories section."""
topic_token: str
"""Token to access top stories."""
serpapi_link: str
"""SerpApi URL to retrieve top stories."""
class GoogleNewsResponse(TypedDict, total=False):
"""Complete response from the Google News API."""
search_metadata: SearchMetadata
"""Metadata about the search request and processing."""
search_parameters: SearchParameters
"""Parameters that were used for this search."""
news_results: list[NewsResult]
"""List of news articles matching the search criteria."""
menu_links: list[MenuLink]
"""Navigation links to different news categories and topics."""
top_stories_link: TopStoriesLink
"""Link to access top stories."""
title: str
"""Title of the page or topic being displayed."""
class SimplifiedNewsResult(TypedDict):
"""Simplified news article format for tool output."""
title: str
"""Headline of the news article."""
link: str
"""URL to the full article."""
source: str | None
"""Name of the publication source."""
date: str | None
"""When the article was published."""
snippet: str | None
"""Brief excerpt from the article."""
class SearchNewsOutput(TypedDict):
"""Output format for the search_news_stories tool."""
news_results: list[SimplifiedNewsResult]
"""List of news articles in simplified format."""
@tool(requires_secrets=["SERP_API_KEY"])
async def search_news_stories(
context: ToolContext,
keywords: Annotated[
str,
"Keywords to search for news articles. E.g. 'Apple launches new iPhone'.",
],
country_code: Annotated[
CountryCode | None,
"2-character country code to search for news articles. "
"E.g. 'us' (United States). "
f"Defaults to '{DEFAULT_GOOGLE_NEWS_COUNTRY}'.",
] = None,
language_code: Annotated[
LanguageCode,
"2-character language code to search for news articles. E.g. 'en' (English). "
f"Defaults to '{DEFAULT_GOOGLE_NEWS_LANGUAGE}'.",
] = DEFAULT_GOOGLE_NEWS_LANGUAGE,
limit: Annotated[
int | None,
"Maximum number of news articles to return. Defaults to None "
"(returns all results found by the API).",
] = None,
) -> Annotated[SearchNewsOutput, "News search results with article details."]:
"""Search for news articles related to a given query."""
...
```
### Enhanced Tool Definition: ``GoogleNews.SearchNewsStories``
```json
{
"name": "SearchNewsStories",
"fully_qualified_name": "GoogleNews.SearchNewsStories",
"description": "Search for news articles related to a given query.",
"toolkit": {
"name": "GoogleNews",
"description": "Arcade.dev LLM tools for getting new via Google News",
"version": "2.0.0"
},
"input": {
"parameters": [
{
"name": "keywords",
"required": true,
"description": "Keywords to search for news articles. E.g. 'Apple launches new iPhone'.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true
},
{
"name": "country_code",
"required": false,
"description": "2-character country code to search for news articles. E.g. 'us' (United States). Defaults to 'None'.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true
},
{
"name": "language_code",
"required": false,
"description": "2-character language code to search for news articles. E.g. 'en' (English). Defaults to 'en'.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true
},
{
"name": "limit",
"required": false,
"description": "Maximum number of news articles to return. Defaults to None (returns all results found by the API).",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true
}
]
},
"output": {
"description": "News search results with article details.",
"available_modes": [
"value",
"error"
],
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"news_results": {
"val_type": "array",
"inner_val_type": "json",
"enum": null,
"properties": null,
"inner_properties": {
"title": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Headline of the news article."
},
"link": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "URL to the full article."
},
"source": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Name of the publication source."
},
"date": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "When the article was published."
},
"snippet": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Brief excerpt from the article."
}
},
"description": "List of news articles in simplified format."
}
},
"inner_properties": null,
"description": null
}
},
"requirements": {
"authorization": null,
"secrets": [
{
"key": "serp_api_key"
}
],
"metadata": null
},
"deprecation_message": null
},
```
---------
Co-authored-by: Eric Gustin <eric@arcade.dev>
194 lines
5.4 KiB
Python
194 lines
5.4 KiB
Python
from typing import Annotated
|
|
|
|
import pytest
|
|
from arcade_core.catalog import ToolCatalog
|
|
from arcade_core.errors import ToolDefinitionError
|
|
from arcade_core.schema import ToolContext, ToolMetadataKey
|
|
from arcade_tdk import tool
|
|
|
|
|
|
@tool
|
|
def func_with_missing_description():
|
|
pass
|
|
|
|
|
|
@tool(desc="Returning function with declared no return type (illegal)")
|
|
def func_with_missing_return_type():
|
|
return "hello world"
|
|
|
|
|
|
@tool(desc="A function with a union return type (illegal)")
|
|
def func_with_union_return_type_1() -> str | int:
|
|
return "hello world"
|
|
|
|
|
|
@tool(desc="A function with a union return type (illegal)")
|
|
def func_with_union_return_type_2() -> str | int:
|
|
return "hello world"
|
|
|
|
|
|
@tool(desc="A function with a parameter type (illegal)")
|
|
def func_with_missing_param_type(param1):
|
|
pass
|
|
|
|
|
|
@tool(desc="A function with a parameter missing a description (illegal)")
|
|
def func_with_missing_param_description(param1: str):
|
|
pass
|
|
|
|
|
|
@tool(desc="A function with an unsupported parameter type (illegal)")
|
|
def func_with_unsupported_param(param1: complex):
|
|
pass
|
|
|
|
|
|
@tool(desc="A function with a union parameter (illegal)")
|
|
def func_with_union_param_1(param1: str | int):
|
|
pass
|
|
|
|
|
|
@tool(desc="A function with a union parameter (illegal)")
|
|
def func_with_union_param_2(param1: str | int):
|
|
pass
|
|
|
|
|
|
@tool(desc="A function with multiple context parameters (illegal)")
|
|
def func_with_multiple_context_params(context: ToolContext, context2: ToolContext):
|
|
pass
|
|
|
|
|
|
@tool(desc="A function with an invalid renamed parameter")
|
|
def func_with_invalid_renamed_param(
|
|
param1: Annotated[str, "invalid-param-name", "The first parameter"],
|
|
):
|
|
pass
|
|
|
|
|
|
@tool(
|
|
desc="A function with a required secret with a missing key (illegal)",
|
|
requires_secrets=[""],
|
|
)
|
|
def func_with_missing_secret_key(context: ToolContext):
|
|
pass
|
|
|
|
|
|
@tool(
|
|
desc="A function that requires a secret (invalid type)",
|
|
requires_secrets=[True],
|
|
)
|
|
def func_with_secret_requirement_invalid_type():
|
|
pass
|
|
|
|
|
|
@tool(
|
|
desc="A function with a required metadata with a missing key (illegal)",
|
|
requires_metadata=[""],
|
|
)
|
|
def func_with_missing_metadata_key(context: ToolContext):
|
|
pass
|
|
|
|
|
|
@tool(
|
|
desc="A function that requires metadata with an invalid type (illegal)",
|
|
requires_metadata=[True],
|
|
)
|
|
def func_with_metadata_requirement_invalid_type():
|
|
pass
|
|
|
|
|
|
@tool(
|
|
desc="A function with a required metadata key that depends on the tool having an auth requirement, but the tool does not have an auth requirement (illegal)",
|
|
requires_metadata=[ToolMetadataKey.CLIENT_ID],
|
|
)
|
|
def func_with_metadata_and_auth_dependency():
|
|
pass
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"func_under_test, exception_type",
|
|
[
|
|
pytest.param(
|
|
func_with_missing_description,
|
|
ToolDefinitionError,
|
|
id=func_with_missing_description.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_missing_return_type,
|
|
ToolDefinitionError,
|
|
id=func_with_missing_return_type.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_missing_param_type,
|
|
ToolDefinitionError,
|
|
id=func_with_missing_param_type.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_missing_param_description,
|
|
ToolDefinitionError,
|
|
id=func_with_missing_param_description.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_unsupported_param,
|
|
ToolDefinitionError,
|
|
id=func_with_unsupported_param.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_union_param_1,
|
|
ToolDefinitionError,
|
|
id=func_with_union_param_1.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_union_param_2,
|
|
ToolDefinitionError,
|
|
id=func_with_union_param_2.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_multiple_context_params,
|
|
ToolDefinitionError,
|
|
id=func_with_multiple_context_params.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_invalid_renamed_param,
|
|
ToolDefinitionError,
|
|
id=func_with_invalid_renamed_param.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_missing_secret_key,
|
|
ToolDefinitionError,
|
|
id=func_with_missing_secret_key.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_secret_requirement_invalid_type,
|
|
ToolDefinitionError,
|
|
id=func_with_secret_requirement_invalid_type.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_missing_metadata_key,
|
|
ToolDefinitionError,
|
|
id=func_with_missing_metadata_key.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_metadata_requirement_invalid_type,
|
|
ToolDefinitionError,
|
|
id=func_with_metadata_requirement_invalid_type.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_metadata_and_auth_dependency,
|
|
ToolDefinitionError,
|
|
id=func_with_metadata_and_auth_dependency.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_union_return_type_1,
|
|
ToolDefinitionError,
|
|
id=func_with_union_return_type_1.__name__,
|
|
),
|
|
pytest.param(
|
|
func_with_union_return_type_2,
|
|
ToolDefinitionError,
|
|
id=func_with_union_return_type_2.__name__,
|
|
),
|
|
],
|
|
)
|
|
def test_missing_info_raises_error(func_under_test, exception_type):
|
|
with pytest.raises(exception_type):
|
|
ToolCatalog.create_tool_definition(func_under_test, "1.0")
|