bebfcab1e9
This PR introduces the `lookup_tweet_by_id` tool to the X toolkit,
enabling users to retrieve tweet details by tweet ID. This enhancement
extends the toolkit's capabilities, allowing for more comprehensive
interactions with the X (Twitter) API.
**Key Changes:**
- **Added `lookup_tweet_by_id` Tool:**
- Implemented the `lookup_tweet_by_id` function in `tools/tweets.py`,
which allows users to fetch tweet information using a tweet ID.
- Included error handling for API response codes and expanded URLs in
tweets to assist language models in avoiding hallucinations due to
shortened URLs.
- **Enhanced Toolkit Structure:**
- Added several configuration files to the X toolkit to establish a
standardized project structure, which in the future will be generated by
`arcade new`. These include:
- `.pre-commit-config.yaml`: Defines pre-commit hooks for code quality
checks.
- `.ruff.toml`: Configuration for the Ruff linter.
- `LICENSE`: MIT License file for the toolkit.
- `Makefile`: Contains common commands for building, testing, and
linting the toolkit.
- **Updated Makefile:**
- Added `make check-toolkits` command to the top-level `Makefile`. This
command runs code quality tools for each toolkit that contains a
`Makefile`.
**Additional Notes:**
- **Tests:**
- Added unit tests for the new `lookup_tweet_by_id` tool in
`tests/test_tweets.py`.
- Included tests for the user lookup functionality in
`tests/test_users.py`.
- **Linting and Code Quality:**
- Configured pre-commit hooks and Ruff linter to enforce code standards.
- Updated the `pyproject.toml` file with development dependencies for
testing and linting.
-
---------
Co-authored-by: Eric Gustin <eric@arcade-ai.com>
64 lines
2.1 KiB
Python
64 lines
2.1 KiB
Python
from typing import Annotated
|
|
|
|
import httpx
|
|
from arcade.sdk import ToolContext, tool
|
|
from arcade.sdk.auth import X
|
|
from arcade.sdk.errors import RetryableToolError
|
|
|
|
from arcade_x.tools.utils import (
|
|
expand_urls_in_user_description,
|
|
expand_urls_in_user_url,
|
|
get_headers_with_token,
|
|
)
|
|
|
|
# Users Lookup Tools. See developer docs for additional available query parameters:
|
|
# https://developer.x.com/en/docs/x-api/users/lookup/api-reference
|
|
|
|
|
|
@tool(requires_auth=X(scopes=["users.read", "tweet.read"]))
|
|
async def lookup_single_user_by_username(
|
|
context: ToolContext,
|
|
username: Annotated[str, "The username of the X (Twitter) user to look up"],
|
|
) -> Annotated[dict, "User information including id, name, username, and description"]:
|
|
"""Look up a user on X (Twitter) by their username."""
|
|
|
|
headers = get_headers_with_token(context)
|
|
|
|
user_fields = ",".join([
|
|
"created_at",
|
|
"description",
|
|
"id",
|
|
"location",
|
|
"most_recent_tweet_id",
|
|
"name",
|
|
"pinned_tweet_id",
|
|
"profile_image_url",
|
|
"protected",
|
|
"public_metrics",
|
|
"url",
|
|
"username",
|
|
"verified",
|
|
"verified_type",
|
|
"withheld",
|
|
"entities",
|
|
])
|
|
url = f"https://api.x.com/2/users/by/username/{username}?user.fields={user_fields}"
|
|
|
|
async with httpx.AsyncClient() as client:
|
|
response = await client.get(url, headers=headers, timeout=10)
|
|
if response.status_code == 404:
|
|
# User not found
|
|
raise RetryableToolError( # noqa: TRY003
|
|
"User not found",
|
|
developer_message=f"User with username '{username}' not found.",
|
|
additional_prompt_content="Please check the username and try again.",
|
|
retry_after_ms=500, # Play nice with X API rate limits
|
|
)
|
|
response.raise_for_status()
|
|
# Parse the response JSON
|
|
user_data = response.json()["data"]
|
|
|
|
user_data = expand_urls_in_user_description(user_data, delete_entities=False)
|
|
user_data = expand_urls_in_user_url(user_data, delete_entities=True)
|
|
|
|
return {"data": user_data}
|