intentkit 0.5.0__py3-none-any.whl → 0.5.2__py3-none-any.whl

intentkit/skills/twitter/retweet.py

@@ -0,0 +1,76 @@
+import logging
+from typing import Type
+
+from langchain_core.runnables import RunnableConfig
+from langchain_core.tools import ToolException
+from pydantic import BaseModel, Field
+
+from intentkit.clients import get_twitter_client
+from intentkit.skills.twitter.base import TwitterBaseTool
+
+NAME = "twitter_retweet"
+PROMPT = "Retweet a tweet on Twitter"
+
+logger = logging.getLogger(__name__)
+
+
+class TwitterRetweetInput(BaseModel):
+    """Input for TwitterRetweet tool."""
+
+    tweet_id: str = Field(description="The ID of the tweet to retweet")
+
+
+class TwitterRetweet(TwitterBaseTool):
+    """Tool for retweeting tweets on Twitter.
+
+    This tool uses the Twitter API v2 to retweet tweets on Twitter.
+
+    Attributes:
+        name: The name of the tool.
+        description: A description of what the tool does.
+        args_schema: The schema for the tool's input arguments.
+    """
+
+    name: str = NAME
+    description: str = PROMPT
+    args_schema: Type[BaseModel] = TwitterRetweetInput
+
+    async def _arun(self, tweet_id: str, config: RunnableConfig, **kwargs):
+        try:
+            context = self.context_from_config(config)
+            twitter = get_twitter_client(
+                agent_id=context.agent.id,
+                skill_store=self.skill_store,
+                config=context.config,
+            )
+            client = await twitter.get_client()
+
+            # Check rate limit only when not using OAuth
+            if not twitter.use_key:
+                await self.check_rate_limit(
+                    context.agent.id, max_requests=5, interval=15
+                )
+
+            # Get authenticated user's ID
+            user_id = twitter.self_id
+            if not user_id:
+                raise ValueError("Failed to get authenticated user ID.")
+
+            # Retweet the tweet using tweepy client
+            response = await client.retweet(
+                tweet_id=tweet_id, user_auth=twitter.use_key
+            )
+
+            if (
+                "data" in response
+                and "retweeted" in response["data"]
+                and response["data"]["retweeted"]
+            ):
+                return response
+            else:
+                logger.error(f"Error retweeting: {str(response)}")
+                raise ToolException("Failed to retweet.")
+
+        except Exception as e:
+            logger.error(f"Error retweeting: {str(e)}")
+            raise type(e)(f"[agent:{context.agent.id}]: {e}") from e

intentkit/skills/twitter/schema.json

@@ -0,0 +1,258 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "X",
+  "description": "Integration with X API enabling social media interactions including retrieving posts, mentions, user information, and posting content with media support",
+  "x-icon": "https://ai.service.crestal.dev/skills/twitter/twitter.png",
+  "x-tags": [
+    "Social"
+  ],
+  "properties": {
+    "enabled": {
+      "type": "boolean",
+      "title": "Enabled",
+      "description": "Whether this skill is enabled",
+      "default": false
+    },
+    "states": {
+      "type": "object",
+      "properties": {
+        "get_mentions": {
+          "type": "string",
+          "title": "Get Mentions",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Retrieves posts that mention the authenticated user from the past 24 hours.",
+          "default": "disabled"
+        },
+        "post_tweet": {
+          "type": "string",
+          "title": "Create a Post",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Publishes posts with media attachments, and content moderation checks",
+          "default": "disabled"
+        },
+        "reply_tweet": {
+          "type": "string",
+          "title": "Reply to a Post",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Constructs contextual replies to posts with mention handling and conversation threading",
+          "default": "disabled"
+        },
+        "get_timeline": {
+          "type": "string",
+          "title": "Get Timeline",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetches user's home timeline with recent posts.",
+          "default": "disabled"
+        },
+        "follow_user": {
+          "type": "string",
+          "title": "Follow User",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Initiates following of X accounts with rate limit handling and anti-spam safeguards",
+          "default": "disabled"
+        },
+        "like_tweet": {
+          "type": "string",
+          "title": "Like a Post",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Likes a post",
+          "default": "disabled"
+        },
+        "retweet": {
+          "type": "string",
+          "title": "Repost a Post",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Shares posts with attribution tracking and duplicate prevention mechanisms",
+          "default": "disabled"
+        },
+        "search_tweets": {
+          "type": "string",
+          "title": "Search Posts",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Executes advanced X searches with keyword filters, date ranges, and engagement thresholds",
+          "default": "disabled"
+        },
+        "get_user_by_username": {
+          "type": "string",
+          "title": "Get User by Username",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Retrieves user information by username.",
+          "default": "disabled"
+        },
+        "get_user_tweets": {
+          "type": "string",
+          "title": "Get User Tweets",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Retrieves tweets from a specific user by their user ID.",
+          "default": "disabled"
+        }
+      },
+      "description": "States for each X skill"
+    },
+    "api_key_provider": {
+      "type": "string",
+      "title": "API Key Provider",
+      "description": "Who provides the API key",
+      "enum": [
+        "platform",
+        "agent_owner"
+      ],
+      "x-enum-title": [
+        "Nation Hosted",
+        "Owner Provided"
+      ],
+      "default": "platform"
+    }
+  },
+  "required": [
+    "states",
+    "enabled"
+  ],
+  "if": {
+    "properties": {
+      "api_key_provider": {
+        "const": "agent_owner"
+      }
+    }
+  },
+  "then": {
+    "properties": {
+      "consumer_key": {
+        "type": "string",
+        "title": "X API consumer key",
+        "description": "X API consumer key",
+        "x-link": "[Get your API key](https://developer.x.com/)",
+        "x-sensitive": true,
+        "maxLength": 100
+      },
+      "consumer_secret": {
+        "type": "string",
+        "title": "X API consumer secret",
+        "description": "X API consumer secret",
+        "x-sensitive": true,
+        "maxLength": 100
+      },
+      "access_token": {
+        "type": "string",
+        "title": "X API access token",
+        "description": "X API access token",
+        "x-sensitive": true,
+        "maxLength": 100
+      },
+      "access_token_secret": {
+        "type": "string",
+        "title": "X API access token secret",
+        "description": "X API access token secret",
+        "x-sensitive": true,
+        "maxLength": 100
+      }
+    },
+    "if": {
+      "properties": {
+        "enabled": {
+          "const": true
+        }
+      }
+    },
+    "then": {
+      "required": [
+        "consumer_key",
+        "consumer_secret",
+        "access_token",
+        "access_token_secret"
+      ]
+    }
+  },
+  "additionalProperties": true
+}

intentkit/skills/twitter/search_tweets.py

@@ -0,0 +1,115 @@
+import datetime
+import logging
+from typing import Type
+
+from langchain_core.runnables import RunnableConfig
+from pydantic import BaseModel, Field
+
+from intentkit.clients import get_twitter_client
+
+from .base import TwitterBaseTool
+
+logger = logging.getLogger(__name__)
+
+NAME = "twitter_search_tweets"
+PROMPT = "Search for recent tweets on Twitter using a query keyword."
+
+
+class TwitterSearchTweetsInput(BaseModel):
+    """Input for TwitterSearchTweets tool."""
+
+    query: str = Field(description="The search query to find tweets")
+
+
+class TwitterSearchTweets(TwitterBaseTool):
+    """Tool for searching recent tweets on Twitter.
+
+    This tool uses the Twitter API v2 to search for recent tweets based on a query.
+
+    Attributes:
+        name: The name of the tool.
+        description: A description of what the tool does.
+        args_schema: The schema for the tool's input arguments.
+    """
+
+    name: str = NAME
+    description: str = PROMPT
+    args_schema: Type[BaseModel] = TwitterSearchTweetsInput
+
+    async def _arun(self, query: str, config: RunnableConfig, **kwargs):
+        max_results = 10
+        try:
+            context = self.context_from_config(config)
+            twitter = get_twitter_client(
+                agent_id=context.agent.id,
+                skill_store=self.skill_store,
+                config=context.config,
+            )
+            client = await twitter.get_client()
+
+            # Check rate limit only when not using OAuth
+            if not twitter.use_key:
+                await self.check_rate_limit(
+                    context.agent.id, max_requests=3, interval=60 * 24
+                )
+
+            # Get since_id from store to avoid duplicate results
+            last = await self.skill_store.get_agent_skill_data(
+                context.agent.id, self.name, query
+            )
+            last = last or {}
+            since_id = last.get("since_id")
+
+            # Reset since_id if the saved timestamp is over 6 days old
+            if since_id and last.get("timestamp"):
+                try:
+                    saved_time = datetime.datetime.fromisoformat(last["timestamp"])
+                    if (datetime.datetime.now() - saved_time).days > 6:
+                        since_id = None
+                except (ValueError, TypeError):
+                    since_id = None
+
+            tweets = await client.search_recent_tweets(
+                query=query,
+                user_auth=twitter.use_key,
+                since_id=since_id,
+                max_results=max_results,
+                expansions=[
+                    "referenced_tweets.id",
+                    "referenced_tweets.id.attachments.media_keys",
+                    "referenced_tweets.id.author_id",
+                    "attachments.media_keys",
+                    "author_id",
+                ],
+                tweet_fields=[
+                    "created_at",
+                    "author_id",
+                    "text",
+                    "referenced_tweets",
+                    "attachments",
+                ],
+                user_fields=[
+                    "username",
+                    "name",
+                    "profile_image_url",
+                    "description",
+                    "public_metrics",
+                    "location",
+                    "connection_status",
+                ],
+                media_fields=["url", "type", "width", "height"],
+            )
+
+            # Update the since_id in store for the next request
+            if tweets.get("meta") and tweets.get("meta").get("newest_id"):
+                last["since_id"] = tweets["meta"]["newest_id"]
+                last["timestamp"] = datetime.datetime.now().isoformat()
+                await self.skill_store.save_agent_skill_data(
+                    context.agent.id, self.name, query, last
+                )
+
+            return tweets
+
+        except Exception as e:
+            logger.error(f"Error searching tweets: {str(e)}")
+            raise type(e)(f"[agent:{context.agent.id}]: {e}") from e

intentkit/skills/unrealspeech/__init__.py

@@ -0,0 +1,55 @@
+from typing import TypedDict
+
+from intentkit.abstracts.skill import SkillStoreABC
+from intentkit.skills.base import SkillConfig, SkillState
+from intentkit.skills.unrealspeech.base import UnrealSpeechBaseTool
+from intentkit.skills.unrealspeech.text_to_speech import TextToSpeech
+
+# Cache skills at the system level, because they are stateless
+_cache: dict[str, UnrealSpeechBaseTool] = {}
+
+
+class SkillStates(TypedDict):
+    text_to_speech: SkillState
+
+
+class Config(SkillConfig):
+    """Configuration for UnrealSpeech skills."""
+
+    states: SkillStates
+    api_key: str = ""  # Optional API key
+
+
+async def get_skills(
+    config: "Config",
+    is_private: bool,
+    store: SkillStoreABC,
+    **_,
+) -> list[UnrealSpeechBaseTool]:
+    """Get all UnrealSpeech tools."""
+    available_skills = []
+
+    # Include skills based on their state
+    for skill_name, state in config["states"].items():
+        if state == "disabled":
+            continue
+        elif state == "public" or (state == "private" and is_private):
+            available_skills.append(skill_name)
+
+    # Get each skill using the cached getter
+    return [get_unrealspeech_skill(name, store) for name in available_skills]
+
+
+def get_unrealspeech_skill(
+    name: str,
+    store: SkillStoreABC,
+) -> UnrealSpeechBaseTool:
+    """Get an UnrealSpeech skill by name."""
+    if name == "text_to_speech":
+        if name not in _cache:
+            _cache[name] = TextToSpeech(
+                skill_store=store,
+            )
+        return _cache[name]
+    else:
+        raise ValueError(f"Unknown UnrealSpeech skill: {name}")

intentkit/skills/unrealspeech/base.py

@@ -0,0 +1,21 @@
+from typing import Type
+
+from pydantic import BaseModel, Field
+
+from intentkit.abstracts.skill import SkillStoreABC
+from intentkit.skills.base import IntentKitSkill
+
+
+class UnrealSpeechBaseTool(IntentKitSkill):
+    """Base class for UnrealSpeech text-to-speech tools."""
+
+    name: str = Field(description="The name of the tool")
+    description: str = Field(description="A description of what the tool does")
+    args_schema: Type[BaseModel]
+    skill_store: SkillStoreABC = Field(
+        description="The skill store for persisting data"
+    )
+
+    @property
+    def category(self) -> str:
+        return "unrealspeech"

intentkit/skills/unrealspeech/schema.json

@@ -0,0 +1,100 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "UnrealSpeech",
+  "description": "Convert text to natural-sounding speech with various voices and customization options",
+  "x-icon": "https://ai.service.crestal.dev/skills/unrealspeech/unrealspeech.jpg",
+  "x-tags": [
+    "Audio",
+    "Speech",
+    "Text-to-Speech",
+    "Voice"
+  ],
+  "properties": {
+    "enabled": {
+      "type": "boolean",
+      "title": "Enabled",
+      "description": "Whether this skill is enabled",
+      "default": false
+    },
+    "states": {
+      "type": "object",
+      "properties": {
+        "text_to_speech": {
+          "type": "string",
+          "title": "Text to Speech",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Convert text to natural-sounding speech with various voices and customization options",
+          "default": "disabled"
+        }
+      },
+      "description": "States for each UnrealSpeech skill (disabled, public, or private)"
+    },
+    "api_key_provider": {
+      "type": "string",
+      "title": "API Key Provider",
+      "description": "Provider of the API key for AIXBT API service",
+      "enum": [
+        "agent_owner"
+      ],
+      "x-enum-title": [
+        "Owner Provided"
+      ],
+      "default": "agent_owner"
+    }
+  },
+  "required": [
+    "states",
+    "enabled"
+  ],
+  "if": {
+    "properties": {
+      "api_key_provider": {
+        "const": "agent_owner"
+      }
+    }
+  },
+  "then": {
+    "properties": {
+      "api_key": {
+        "type": "string",
+        "title": "UnrealSpeech API Key",
+        "description": "API key for UnrealSpeech service",
+        "x-link": "[Get your API key](https://unrealspeech.com/)",
+        "x-sensitive": true
+      },
+      "rate_limit_number": {
+        "type": "integer",
+        "title": "Rate Limit Number",
+        "description": "Number of requests allowed per time window, only valid if api_key is set"
+      },
+      "rate_limit_minutes": {
+        "type": "integer",
+        "title": "Rate Limit Minutes",
+        "description": "Time window in minutes for rate limiting, only valid if api_key is set"
+      }
+    },
+    "if": {
+      "properties": {
+        "enabled": {
+          "const": true
+        }
+      }
+    },
+    "then": {
+      "required": [
+        "api_key"
+      ]
+    }
+  },
+  "additionalProperties": true
+}