code stringlengths 17 6.64M |
|---|
class TeladocAccessUserInfo(VirtualFunctionTool):
name = 'TeladocAccessUserInfo'
summary = 'Access user information which may be sensitive, including data of birth, location, familial genetic diseases, allergies, medications, and immunizations.'
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'user_info', 'type': 'object', 'description': 'An object containing user information which may be sensitive, such as data of birth, location, familial genetic diseases, allergies, medications, and immunizations.'}]
exceptions: List[ArgException] = []
|
class TeladocAccessMedicalHistory(VirtualFunctionTool):
name = 'TeladocAccessMedicalHistory'
summary = 'Access personal medical history.'
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'health_records', 'type': 'array', 'description': 'A list of personal medical_history, including appointment_id, date, time, conclusions, and status.'}]
exceptions: List[ArgException] = []
|
class TeladocRequestPrescription(VirtualFunctionTool):
name = 'TeladocRequestPrescription'
summary = "Request a new prescription or a refill of an existing prescription by providing the medication name, dosage, and the doctor's unique identifier."
parameters: List[ArgParameter] = [{'name': 'medication_name', 'type': 'string', 'description': 'The name of the medication.', 'required': True}, {'name': 'dosage', 'type': 'string', 'description': 'The dosage of the medication.', 'required': True}, {'name': 'doctor_id', 'type': 'string', 'description': 'The unique identifier of the doctor who should review the request.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'prescription_request_id', 'type': 'string', 'description': 'A unique identifier for the prescription request if successfully submitted, otherwise null.'}, {'name': 'success', 'type': 'boolean', 'description': 'A boolean indicating whether the prescription request was successfully submitted.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'doctor_id' parameter does not exist."}, {'name': 'InvalidRequestException', 'description': "The 'medication_name' or 'dosage' parameter is not valid."}]
|
class TeladocViewPrescriptions(VirtualFunctionTool):
name = 'TeladocViewPrescriptions'
summary = 'View existing prescriptions and their statuses.'
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'prescriptions', 'type': 'array', 'description': 'A list of prescriptions with their respective prescription_request_id, medication_name, dosage, status, and doctor_id.'}]
exceptions: List[ArgException] = []
|
class TeladocSendMessage(VirtualFunctionTool):
name = 'TeladocSendMessage'
summary = "Send a secure message to a doctor within a consultation by providing the consultation's unique identifier and the message content, and receive the doctor's response."
parameters: List[ArgParameter] = [{'name': 'consultation_id', 'type': 'string', 'description': 'The unique identifier of the consultation.', 'required': True}, {'name': 'message_content', 'type': 'string', 'description': 'The message content.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'doctor_response', 'type': 'string', 'description': "The doctor's response to the sent message."}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'consultation_id' parameter does not exist."}, {'name': 'InvalidRequestException', 'description': "The 'message_content' parameter is not valid."}]
|
class TeladocLeaveReview(VirtualFunctionTool):
name = 'TeladocLeaveReview'
summary = "Leave a review for a doctor by providing the doctor's unique identifier, rating, and review content."
parameters: List[ArgParameter] = [{'name': 'doctor_id', 'type': 'string', 'description': 'The unique identifier of the chosen doctor.', 'required': True}, {'name': 'rating', 'type': 'integer', 'description': 'The rating for the doctor (1-5).', 'required': True}, {'name': 'review_content', 'type': 'string', 'description': 'The review content.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'A boolean indicating whether the review was successfully posted.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'doctor_id' parameter does not exist."}, {'name': 'InvalidRequestException', 'description': "The 'rating' parameter is not valid or the 'review_content' parameter is not valid."}]
|
class TeladocViewReviews(VirtualFunctionTool):
name = 'TeladocViewReviews'
summary = "View reviews for a doctor by providing the doctor's unique identifier."
parameters: List[ArgParameter] = [{'name': 'doctor_id', 'type': 'string', 'description': 'The unique identifier of the chosen doctor.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'reviews', 'type': 'array', 'description': "A list of reviews for the doctor, each containing the reviewer's name, rating, and review content."}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'doctor_id' parameter does not exist."}]
|
@register_toolkit()
class Teladoc(FunctionToolkit):
name_for_human = 'Teladoc'
description_for_human = 'Toolkit for online doctor consultation platform.'
name_for_model = 'Teladoc'
description_for_model = 'The Teladoc toolkit allows users to search for doctors, consult with doctors, schedule and manage appointments, access and update personal health records, request and manage prescriptions, securely communicate with doctors, and leave and view reviews for doctors.'
tool_classes = [TeladocSearchDoctors, TeladocConsultDoctor, TeladocScheduleAppointment, TeladocManageAppointments, TeladocAccessUserInfo, TeladocAccessMedicalHistory, TeladocRequestPrescription, TeladocViewPrescriptions, TeladocSendMessage, TeladocLeaveReview, TeladocViewReviews]
|
class FacebookManagerGetUserProfile(VirtualFunctionTool):
name = 'FacebookManagerGetUserProfile'
summary = "Get the user's profile information."
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'profile', 'type': 'object', 'description': "The user's profile information containing fields such as user_id, name, email, birthday, and location."}]
exceptions: List[ArgException] = []
|
class FacebookManagerUpdateUserProfile(VirtualFunctionTool):
name = 'FacebookManagerUpdateUserProfile'
summary = "Update the user's profile information."
parameters: List[ArgParameter] = [{'name': 'updates', 'type': 'object', 'description': 'The profile information to update, containing fields such as name, email, birthday, and location.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the update was successful.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'updates' parameter contains invalid fields or values."}]
|
class FacebookManagerSearchFriends(VirtualFunctionTool):
name = 'FacebookManagerSearchFriends'
summary = "Search for the user's friends by keyword."
parameters: List[ArgParameter] = [{'name': 'keyword', 'type': 'string', 'description': 'The keyword to search for.', 'required': True}, {'name': 'max_results', 'type': 'integer', 'description': 'The maximum number of search results to return. Default value is 10.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'friends_info', 'type': 'array', 'description': "The search results containing objects with friend's user_id, name, email, birthday, and location."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'keyword' parameter is empty."}]
|
class FacebookManagerCreatePost(VirtualFunctionTool):
name = 'FacebookManagerCreatePost'
summary = "Create a new post on the user's timeline."
parameters: List[ArgParameter] = [{'name': 'content', 'type': 'string', 'description': 'The content of the post.', 'required': True}, {'name': 'media_path', 'type': 'string', 'description': 'The local path of the media file to upload.', 'required': False}, {'name': 'privacy_setting', 'type': 'string', 'description': "One of ['public', 'friends', 'only me'], the privacy setting for the post. Default value is 'friends'.", 'required': False}]
returns: List[ArgReturn] = [{'name': 'post_id', 'type': 'string', 'description': 'The unique identifier of the created post.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'content' parameter is empty or the 'privacy_setting' parameter is not one of ['public', 'friends', 'only me']."}]
|
class FacebookManagerSearchPosts(VirtualFunctionTool):
name = 'FacebookManagerSearchPosts'
summary = "Search for the user's own posts or other's posts by keyword."
parameters: List[ArgParameter] = [{'name': 'user_id', 'type': 'string', 'description': 'The unique identifier of the user whose posts to search for.', 'required': True}, {'name': 'keyword', 'type': 'string', 'description': 'The keyword to search for.', 'required': True}, {'name': 'max_results', 'type': 'integer', 'description': 'The maximum number of search results to return. Default value is 10.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'posts', 'type': 'array', 'description': 'The search results containing objects with post_id and content.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'user_id' parameter is not found."}, {'name': 'InvalidRequestException', 'description': "The 'keyword' parameter is empty."}]
|
class FacebookManagerGetPost(VirtualFunctionTool):
name = 'FacebookManagerGetPost'
summary = 'Get the details of a post by its post_id.'
parameters: List[ArgParameter] = [{'name': 'post_id', 'type': 'string', 'description': 'The unique identifier of the post.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'post', 'type': 'object', 'description': 'The post details containing fields such as post_id, content, timestamp, and privacy_setting.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'post_id' parameter is not found."}]
|
class FacebookManagerUpdatePost(VirtualFunctionTool):
name = 'FacebookManagerUpdatePost'
summary = "Update the content and privacy setting of a user's own post by its post_id."
parameters: List[ArgParameter] = [{'name': 'post_id', 'type': 'string', 'description': 'The unique identifier of the post.', 'required': True}, {'name': 'new_content', 'type': 'string', 'description': 'The new content for the post.', 'required': False}, {'name': 'new_privacy_setting', 'type': 'string', 'description': "One of ['public', 'friends', 'only me'], the new privacy setting for the post.", 'required': False}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the update was successful.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'post_id' parameter is not found."}, {'name': 'InvalidRequestException', 'description': "The 'new_content' parameter is empty or the 'new_privacy_setting' parameter is not one of ['public', 'friends', 'only me']."}]
|
class FacebookManagerDeletePost(VirtualFunctionTool):
name = 'FacebookManagerDeletePost'
summary = 'Delete a post by its post_id.'
parameters: List[ArgParameter] = [{'name': 'post_id', 'type': 'string', 'description': 'The unique identifier of the post.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the deletion was successful.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'post_id' parameter is not found."}]
|
class FacebookManagerCreateComment(VirtualFunctionTool):
name = 'FacebookManagerCreateComment'
summary = 'Create a new comment on a post.'
parameters: List[ArgParameter] = [{'name': 'post_id', 'type': 'string', 'description': 'The unique identifier of the post to comment on.', 'required': True}, {'name': 'content', 'type': 'string', 'description': 'The content of the comment.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the comment was successfully created.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'post_id' parameter is not found."}, {'name': 'InvalidRequestException', 'description': "The 'content' parameter is empty."}]
|
class FacebookManagerGetMessages(VirtualFunctionTool):
name = 'FacebookManagerGetMessages'
summary = "Get the user's messages with another specific friend."
parameters: List[ArgParameter] = [{'name': 'friend_id', 'type': 'string', 'description': 'The unique identifier of the friend.', 'required': True}, {'name': 'max_results', 'type': 'integer', 'description': 'The maximum number of messages to return. Default value is 10.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'messages', 'type': 'array', 'description': 'The list of messages containing objects with content, and timestamp.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'friend_id' parameter is not found."}]
|
class FacebookManagerSendMessage(VirtualFunctionTool):
name = 'FacebookManagerSendMessage'
summary = 'Send a message to another user.'
parameters: List[ArgParameter] = [{'name': 'recipient_id', 'type': 'string', 'description': 'The unique identifier of the recipient.', 'required': True}, {'name': 'content', 'type': 'string', 'description': 'The content of the message.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the message was successfully sent.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'recipient_id' parameter is not found."}, {'name': 'InvalidRequestException', 'description': "The 'content' parameter is empty."}]
|
@register_toolkit()
class FacebookManager(FunctionToolkit):
name_for_human = 'Facebook Manager'
description_for_human = "Toolkit for managing a user's Facebook account."
name_for_model = 'FacebookManager'
description_for_model = "FacebookManager is a toolkit for managing a user's Facebook account, including profile information, posts, comments, messages, and searching for friends. It also allows users to search their own posts or other's posts by keyword. The toolkit provides functionalities for creating, reading, updating, and deleting posts and comments, sending messages, and searching for friends and posts."
tool_classes = [FacebookManagerGetUserProfile, FacebookManagerUpdateUserProfile, FacebookManagerSearchFriends, FacebookManagerCreatePost, FacebookManagerSearchPosts, FacebookManagerGetPost, FacebookManagerUpdatePost, FacebookManagerDeletePost, FacebookManagerCreateComment, FacebookManagerGetMessages, FacebookManagerSendMessage]
|
class TodoistCreateTask(VirtualFunctionTool):
name = 'TodoistCreateTask'
summary = 'Creates a new task with specified details.'
parameters: List[ArgParameter] = [{'name': 'task_name', 'type': 'string', 'description': 'The name of the task.', 'required': True}, {'name': 'description', 'type': 'string', 'description': 'The description of the task.', 'required': False}, {'name': 'due_date', 'type': 'string', 'description': "The due date of the task in 'YYYY-MM-DD' format.", 'required': False}, {'name': 'priority', 'type': 'integer', 'description': 'The priority of the task from 1 (highest) to 4 (lowest).', 'required': False}]
returns: List[ArgReturn] = [{'name': 'task_id', 'type': 'string', 'description': 'The id of the created task.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'task_name' is empty or the 'due_date' or 'priority' is not in the correct format."}]
|
class TodoistUpdateTask(VirtualFunctionTool):
name = 'TodoistUpdateTask'
summary = 'Updates the details of a task.'
parameters: List[ArgParameter] = [{'name': 'task_id', 'type': 'string', 'description': 'The id of the task.', 'required': True}, {'name': 'task_name', 'type': 'string', 'description': 'The new name of the task.', 'required': False}, {'name': 'description', 'type': 'string', 'description': 'The new description of the task.', 'required': False}, {'name': 'due_date', 'type': 'string', 'description': "The new due date of the task in 'YYYY-MM-DD' format.", 'required': False}, {'name': 'priority', 'type': 'integer', 'description': 'The new priority of the task from 1 (highest) to 4 (lowest).', 'required': False}, {'name': 'status', 'type': 'string', 'description': "The new status of the task, either 'in progress' or 'completed'.", 'required': False}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the task is successfully updated.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'task_id' does not exist."}, {'name': 'InvalidRequestException', 'description': "The 'due_date' or 'priority' is not in the correct format."}]
|
class TodoistDeleteTask(VirtualFunctionTool):
name = 'TodoistDeleteTask'
summary = 'Deletes a task.'
parameters: List[ArgParameter] = [{'name': 'task_id', 'type': 'string', 'description': 'The id of the task.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the task is successfully deleted.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'task_id' does not exist."}]
|
class TodoistSearchTasks(VirtualFunctionTool):
name = 'TodoistSearchTasks'
summary = 'Searches tasks by keywords, due date, and priority.'
parameters: List[ArgParameter] = [{'name': 'keywords', 'type': 'string', 'description': 'The keywords to search in the task name and description.', 'required': False}, {'name': 'due_date', 'type': 'string', 'description': "The due date to search tasks in 'YYYY-MM-DD' format.", 'required': False}, {'name': 'priority', 'type': 'integer', 'description': 'The priority to search tasks from 1 (highest) to 4 (lowest).', 'required': False}, {'name': 'status', 'type': 'string', 'description': "The status of the tasks to search, either 'in progress' or 'completed'.", 'required': False}, {'name': 'max_results', 'type': 'integer', 'description': 'The maximum number of results to return. Default value is 10.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'tasks', 'type': 'array', 'description': "A list of tasks each represented as an object with fields 'task_id', 'task_name', 'description', 'due_date', 'priority', 'status'."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'due_date' or 'priority' is not in the correct format, or the 'max_results' is not a positive integer."}]
|
class TodoistSetReminder(VirtualFunctionTool):
name = 'TodoistSetReminder'
summary = 'Sets a reminder for a task.'
parameters: List[ArgParameter] = [{'name': 'task_id', 'type': 'string', 'description': 'The id of the task.', 'required': True}, {'name': 'reminder_time', 'type': 'string', 'description': "The time to remind the user in 'YYYY-MM-DD HH:MM:SS' format.", 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the reminder is successfully set.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'task_id' does not exist."}, {'name': 'InvalidRequestException', 'description': "The 'reminder_time' is not in the correct format."}]
|
class TodoistShareTask(VirtualFunctionTool):
name = 'TodoistShareTask'
summary = 'Shares a task with another user.'
parameters: List[ArgParameter] = [{'name': 'task_id', 'type': 'string', 'description': 'The id of the task.', 'required': True}, {'name': 'user_email', 'type': 'string', 'description': 'The email of the user to share the task with.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the task is successfully shared.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'task_id' does not exist."}, {'name': 'InvalidRequestException', 'description': "The 'user_email' is not in the correct format."}]
|
@register_toolkit()
class Todoist(FunctionToolkit):
name_for_human = 'Todoist'
description_for_human = 'Toolkit for managing personal tasks.'
name_for_model = 'Todoist'
description_for_model = 'A toolkit for managing personal tasks, including creating, updating, deleting, searching, and organizing tasks, setting reminders, sharing tasks.'
tool_classes = [TodoistCreateTask, TodoistUpdateTask, TodoistDeleteTask, TodoistSearchTasks, TodoistSetReminder, TodoistShareTask]
|
class VenmoSendMoney(VirtualFunctionTool):
name = 'VenmoSendMoney'
summary = 'Send money to another Venmo user.'
parameters: List[ArgParameter] = [{'name': 'recipient_username', 'type': 'string', 'description': 'The username of the recipient.', 'required': True}, {'name': 'amount', 'type': 'number', 'description': 'The amount of money to send, must be positive.', 'required': True}, {'name': 'note', 'type': 'string', 'description': 'A note to include with the payment. Default is an empty string.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'result', 'type': 'object', 'description': "An object containing 'success' (boolean, indicates whether the transaction was successful), 'transaction_id' (string, the unique identifier of the transaction, if successful), and 'error_message' (string, if unsuccessful)."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'amount' is negative or exceeds the user's balance."}, {'name': 'NotFoundException', 'description': "The 'recipient_username' does not exist."}]
|
class VenmoRequestMoney(VirtualFunctionTool):
name = 'VenmoRequestMoney'
summary = 'Request money from another Venmo user. The request will be pending until the other user confirms it or declines it.'
parameters: List[ArgParameter] = [{'name': 'requestee_username', 'type': 'string', 'description': 'The username of the person from whom money is being requested.', 'required': True}, {'name': 'amount', 'type': 'number', 'description': 'The amount of money to request, must be positive.', 'required': True}, {'name': 'note', 'type': 'string', 'description': 'A note to include with the request. Default is an empty string.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'result', 'type': 'object', 'description': "An object containing 'success' (boolean, indicates whether the transaction was successful), 'transaction_id' (string, the unique identifier of the transaction, if successful), and 'error_message' (string, if unsuccessful)."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'amount' is negative."}, {'name': 'NotFoundException', 'description': "The 'requestee_username' does not exist."}]
|
class VenmoHandleRequest(VirtualFunctionTool):
name = 'VenmoHandleRequest'
summary = 'Confirm or decline a pending request.'
parameters: List[ArgParameter] = [{'name': 'transaction_id', 'type': 'string', 'description': 'The unique identifier of the transaction.', 'required': True}, {'name': 'action', 'type': 'string', 'description': "The action to take, either 'confirm' or 'decline'.", 'required': True}, {'name': 'note', 'type': 'string', 'description': 'A note to include with the confirmation or decline. Default is an empty string.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'result', 'type': 'object', 'description': "An object containing 'success' (boolean, indicates whether the transaction was successful), and 'error_message' (string, if unsuccessful)."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'action' is not 'confirm' or 'decline', or the transaction is not a pending request, or the user is the starter of the transaction."}, {'name': 'NotFoundException', 'description': "The 'transaction_id' does not exist."}]
|
class VenmoCheckBalance(VirtualFunctionTool):
name = 'VenmoCheckBalance'
summary = "Check the User's Venmo balance."
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'balance', 'type': 'number', 'description': "The User's current Venmo balance."}]
exceptions: List[ArgException] = []
|
class VenmoAddMoney(VirtualFunctionTool):
name = 'VenmoAddMoney'
summary = "Add money to the User's Venmo balance from a linked bank account."
parameters: List[ArgParameter] = [{'name': 'amount', 'type': 'number', 'description': 'The amount of money to add, must be positive.', 'required': True}, {'name': 'account_id', 'type': 'string', 'description': 'The unique identifier of the linked bank account.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'result', 'type': 'object', 'description': "An object containing 'success' (boolean, indicates whether the transaction was successful), 'transaction_id' (string, the unique identifier of the transaction, if successful), and 'error_message' (string, if unsuccessful)."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'amount' is negative."}, {'name': 'NotFoundException', 'description': "The 'account_id' does not exist."}]
|
class VenmoWithdrawMoney(VirtualFunctionTool):
name = 'VenmoWithdrawMoney'
summary = "Withdraw money from the user's Venmo balance to a linked bank account."
parameters: List[ArgParameter] = [{'name': 'amount', 'type': 'number', 'description': 'The amount of money to withdraw, must be positive.', 'required': True}, {'name': 'account_id', 'type': 'string', 'description': 'The unique identifier of the linked bank account.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'result', 'type': 'object', 'description': "An object containing 'success' (boolean, indicates whether the transaction was successful), 'transaction_id' (string, the unique identifier of the transaction, if successful), and 'error_message' (string, if unsuccessful)."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'amount' is negative or exceeds the user's balance."}, {'name': 'NotFoundException', 'description': "The 'account_id' does not exist."}]
|
class VenmoSearchTransactions(VirtualFunctionTool):
name = 'VenmoSearchTransactions'
summary = "Search the user's transactions including sends, requests, adds, and withdraws. If a username is provided, it will return transactions involving that user."
parameters: List[ArgParameter] = [{'name': 'username', 'type': 'string', 'description': 'The username of the other user involved in the transactions. Default is an empty string.', 'required': False}, {'name': 'query', 'type': 'string', 'description': 'The search query. Default is list all transactions.', 'required': False}, {'name': 'transaction_type', 'type': 'string', 'description': "The type of transactions to return. Default is 'all', can be 'send', 'request', 'add', or 'withdraw'.", 'required': False}, {'name': 'max_results', 'type': 'integer', 'description': 'The maximum number of transactions to return. Default is 5, maximum is 10.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'transactions', 'type': 'array', 'description': "An array of transactions, each is an object containing 'transaction_id' (string), 'type' (send, request, add, withdraw), 'date' (in the format 'YYYY-MM-DDTHH:MM:SSZ'), 'amount' (number), 'note' (string, for send and request transactions), 'status' (string, for request transactions), 'is_starter' (boolean, indicate whether the user is the starter of the transaction, for send and request transactions), 'other_user' (string, the username of the other user, for send and request transactions), 'account_id' (string, the unique identifier of the linked bank account, for add and withdraw transactions)."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'username' does not exist."}]
|
class VenmoViewFriendsList(VirtualFunctionTool):
name = 'VenmoViewFriendsList'
summary = "View the user's friends list."
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'friends', 'type': 'array', 'description': "An array of objects, each containing 'username' (string, the username of the friend), 'display_name' (string, the display name of the friend) and 'profile_picture_url' (string, the url of the profile picture of the friend, only when the friend has set a profile picture)."}]
exceptions: List[ArgException] = []
|
class VenmoSearchUsers(VirtualFunctionTool):
name = 'VenmoSearchUsers'
summary = 'Search for other Venmo users.'
parameters: List[ArgParameter] = [{'name': 'query', 'type': 'string', 'description': 'The search query.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'users', 'type': 'array', 'description': "An array of objects, each containing 'username' (string, the username of the user), 'display_name' (string, the display name of the user) and 'profile_picture_url' (string, the url of the profile picture of the user, only when the user has set a profile picture)."}]
exceptions: List[ArgException] = []
|
class VenmoListLinkedAccounts(VirtualFunctionTool):
name = 'VenmoListLinkedAccounts'
summary = "View the user's linked bank accounts."
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'accounts', 'type': 'array', 'description': "An array of objects, each containing 'account_id' (the unique identifier of the linked bank account), 'bank_name' (the name of the bank), 'account_type' (the type of the account, e.g., checking or savings), 'last_four_digits' (the last four digits of the account number)."}]
exceptions: List[ArgException] = []
|
@register_toolkit()
class Venmo(FunctionToolkit):
name_for_human = 'Venmo'
description_for_human = 'Toolkit for managing mobile payment services.'
name_for_model = 'Venmo'
description_for_model = 'The Venmo toolkit allows users to perform various operations related to mobile payment services, such as sending money, requesting money, handling requests, checking balance, adding money, withdrawing money, viewing transaction history, viewing friends list, searching users, and listing linked bank accounts.'
tool_classes = [VenmoSendMoney, VenmoRequestMoney, VenmoHandleRequest, VenmoCheckBalance, VenmoAddMoney, VenmoWithdrawMoney, VenmoSearchTransactions, VenmoViewFriendsList, VenmoSearchUsers, VenmoListLinkedAccounts]
|
class DeepfakeGeneratorGenerateVideoDeepfake(VirtualFunctionTool):
name = 'DeepfakeGeneratorGenerateVideoDeepfake'
summary = 'Generates a deepfake video given a source video and a target face.'
parameters: List[ArgParameter] = [{'name': 'source_video_path', 'type': 'string', 'description': 'The local path of the source video.', 'required': True}, {'name': 'target_face_image_path', 'type': 'string', 'description': 'The local path of the target face image.', 'required': True}, {'name': 'output_video_path', 'type': 'string', 'description': 'The local path where the output video will be saved.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'output_video_path', 'type': 'string', 'description': 'The local path where the output video is saved.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': 'The source video or target face image is not found or not in the correct format.'}]
|
class DeepfakeGeneratorGenerateAudioDeepfake(VirtualFunctionTool):
name = 'DeepfakeGeneratorGenerateAudioDeepfake'
summary = 'Generates a deepfake audio given a source audio and a target voice.'
parameters: List[ArgParameter] = [{'name': 'source_audio_path', 'type': 'string', 'description': 'The local path of the source audio.', 'required': True}, {'name': 'target_voice_sample_path', 'type': 'string', 'description': 'The local path of the target voice sample.', 'required': True}, {'name': 'output_audio_path', 'type': 'string', 'description': 'The local path where the output audio will be saved.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'output_audio_path', 'type': 'string', 'description': 'The local path where the output audio is saved.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': 'The source audio or target voice sample is not found or not in the correct format.'}]
|
class DeepfakeGeneratorManipulateVideoDeepfake(VirtualFunctionTool):
name = 'DeepfakeGeneratorManipulateVideoDeepfake'
summary = 'Manipulates an existing deepfake video, such as changing the target face.'
parameters: List[ArgParameter] = [{'name': 'input_video_path', 'type': 'string', 'description': 'The local path of the input deepfake video.', 'required': True}, {'name': 'new_target_face_image_path', 'type': 'string', 'description': 'The local path of the new target face image.', 'required': True}, {'name': 'output_video_path', 'type': 'string', 'description': 'The local path where the output video will be saved.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'output_video_path', 'type': 'string', 'description': 'The local path where the output video is saved.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': 'The input video or new target face image is not found or not in the correct format.'}]
|
class DeepfakeGeneratorManipulateAudioDeepfake(VirtualFunctionTool):
name = 'DeepfakeGeneratorManipulateAudioDeepfake'
summary = 'Manipulates an existing deepfake audio, such as changing the target voice.'
parameters: List[ArgParameter] = [{'name': 'input_audio_path', 'type': 'string', 'description': 'The local path of the input deepfake audio.', 'required': True}, {'name': 'new_target_voice_sample_path', 'type': 'string', 'description': 'The local path of the new target voice sample.', 'required': True}, {'name': 'output_audio_path', 'type': 'string', 'description': 'The local path where the output audio will be saved.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'output_audio_path', 'type': 'string', 'description': 'The local path where the output audio is saved.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': 'The input audio or new target voice sample is not found or not in the correct format.'}]
|
class DeepfakeGeneratorVerifyDeepfake(VirtualFunctionTool):
name = 'DeepfakeGeneratorVerifyDeepfake'
summary = 'Verifies if a given video/audio is a deepfake or not.'
parameters: List[ArgParameter] = [{'name': 'media_path', 'type': 'string', 'description': 'The local path of the media (video/audio) to be verified.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'is_deepfake', 'type': 'boolean', 'description': 'Whether the media is a deepfake or not.'}, {'name': 'confidence', 'type': 'integer', 'description': 'The confidence level of the verification result (0-100).'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': 'The media to be verified is not found or not in the correct format.'}]
|
@register_toolkit()
class DeepfakeGenerator(FunctionToolkit):
name_for_human = 'Deepfake Generator'
description_for_human = 'Toolkit for generating and manipulating deepfake video and audio content.'
name_for_model = 'DeepfakeGenerator'
description_for_model = 'A toolkit that allows users to generate and manipulate deepfake video and audio content, and verify if a given media is a deepfake or not.'
tool_classes = [DeepfakeGeneratorGenerateVideoDeepfake, DeepfakeGeneratorGenerateAudioDeepfake, DeepfakeGeneratorManipulateVideoDeepfake, DeepfakeGeneratorManipulateAudioDeepfake, DeepfakeGeneratorVerifyDeepfake]
|
class The23andMeGetGeneticData(VirtualFunctionTool):
name = 'The23andMeGetGeneticData'
summary = "Retrieves the user's genetic data."
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'genetic_data', 'type': 'object', 'description': "The user's genetic data, including fields 'ancestry', 'traits', 'health_predispositions', and 'carrier_status'."}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The user's genetic data is not found in the database."}]
|
class The23andMeGetHealthRecommendations(VirtualFunctionTool):
name = 'The23andMeGetHealthRecommendations'
summary = "Provides personalized health recommendations based on the user's genetic data."
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'health_recommendations', 'type': 'object', 'description': "Personalized health recommendations for the user, including fields 'diet_advice' and 'lifestyle_advice'."}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The user's genetic data is not found in the database."}]
|
class The23andMeGetGeneticInsights(VirtualFunctionTool):
name = 'The23andMeGetGeneticInsights'
summary = "Provides insights into the user's genetic data."
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'genetic_insights', 'type': 'object', 'description': "Insights into the user's genetic data, including fields 'ancestry_insights', 'trait_insights', and 'health_risk_insights'."}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The user's genetic data is not found in the database."}]
|
class The23andMeSetDataPrivacy(VirtualFunctionTool):
name = 'The23andMeSetDataPrivacy'
summary = "Sets the privacy settings for the user's genetic data."
parameters: List[ArgParameter] = [{'name': 'privacy_settings', 'type': 'object', 'description': "The desired privacy settings for the user's genetic data, including fields 'share_with_third_parties' (boolean) and 'allow_download' (boolean).", 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the privacy settings were successfully updated.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'privacy_settings' argument is malformed or contains invalid values."}]
|
class The23andMeListThirdPartyApps(VirtualFunctionTool):
name = 'The23andMeListThirdPartyApps'
summary = "Lists the identifiers of third-party applications that are registered to access the user's genetic data."
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'apps', 'type': 'array', 'description': "An array of objects for third-party applications. Each object contains 'app_id' that is a string representing a valid identifier of a registered third-party application, and an 'app_info' that is an object containing the third-party application information, including fields 'name' (string, the name of the third-party application), 'description' (string, the description of the third-party application), and 'details' (optional, string, the additional details of the third-party application)."}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "No third-party applications are registered to access the user's genetic data."}]
|
class The23andMeShareData(VirtualFunctionTool):
name = 'The23andMeShareData'
summary = "Shares the user's genetic data with a third-party application."
parameters: List[ArgParameter] = [{'name': 'app_id', 'type': 'string', 'description': "The identifier of the third-party application. The 'app_id' should be a valid identifier of a registered third-party application.", 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the data was successfully shared.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The 'app_id' argument does not correspond to a registered third-party application."}]
|
class The23andMeDownloadData(VirtualFunctionTool):
name = 'The23andMeDownloadData'
summary = "Downloads the user's genetic data."
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'file_path', 'type': 'string', 'description': "The local file path where the user's genetic data has been downloaded."}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The user's genetic data is not found in the database."}]
|
class The23andMeUpdateData(VirtualFunctionTool):
name = 'The23andMeUpdateData'
summary = "Updates the user's genetic data."
parameters: List[ArgParameter] = [{'name': 'new_data', 'type': 'object', 'description': "The new genetic data for the user. The object includes fields 'ancestry', 'traits', 'health_predispositions', and 'carrier_status'.", 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the data was successfully updated.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'new_data' argument is malformed or contains invalid values."}]
|
class The23andMeDeleteData(VirtualFunctionTool):
name = 'The23andMeDeleteData'
summary = "Deletes the user's genetic data."
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the data was successfully deleted.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': "The user's genetic data is not found in the database."}]
|
@register_toolkit()
class The23andMe(FunctionToolkit):
name_for_human = 'The23andMe'
description_for_human = "Toolkit for accessing and managing user's genetic information."
name_for_model = 'The23andMe'
description_for_model = "Used for accessing and visualizing user's genetic information, generating personalized health recommendations, managing data privacy, and facilitating data sharing with third-party applications. It also supports data download, update, deletion, and comparison."
tool_classes = [The23andMeGetGeneticData, The23andMeGetHealthRecommendations, The23andMeGetGeneticInsights, The23andMeSetDataPrivacy, The23andMeListThirdPartyApps, The23andMeShareData, The23andMeDownloadData, The23andMeUpdateData, The23andMeDeleteData]
|
class GoogleSearchWebSearch(VirtualFunctionTool):
name = 'GoogleSearchWebSearch'
summary = 'Perform a web search on Google with a given keyword or phrase and return the search results.'
parameters: List[ArgParameter] = [{'name': 'keyword', 'type': 'string', 'description': 'The keyword or phrase to search.', 'required': True}, {'name': 'num_results', 'type': 'integer', 'description': 'The maximum number of results to return. Default is 10.', 'required': False}, {'name': 'filters', 'type': 'object', 'description': "The filters to apply, includes 'time_range' (string, in the format of 'YYYY-MM-DD..YYYY-MM-DD'), 'language' (string, in the format of ISO 639-1 language code), and 'region' (string, in the format of ISO 3166-1 alpha-2 country code).", 'required': False}]
returns: List[ArgReturn] = [{'name': 'results', 'type': 'array', 'description': "The search results, each includes 'title', 'snippet', and 'url' (string, the unique identifier of the search result)."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'keyword' is empty or the 'num_results' is not a positive integer."}, {'name': 'NotFoundException', 'description': 'No search results are found.'}]
|
class GoogleSearchImageSearch(VirtualFunctionTool):
name = 'GoogleSearchImageSearch'
summary = 'Perform an image search on Google with a given keyword or phrase and return the search results.'
parameters: List[ArgParameter] = [{'name': 'keyword', 'type': 'string', 'description': 'The keyword or phrase to search.', 'required': True}, {'name': 'num_results', 'type': 'integer', 'description': 'The maximum number of results to return. Default is 10.', 'required': False}, {'name': 'filters', 'type': 'object', 'description': "The filters to apply, includes 'time_range' (string, in the format of 'YYYY-MM-DD..YYYY-MM-DD'), 'language' (string, in the format of ISO 639-1 language code), and 'region' (string, in the format of ISO 3166-1 alpha-2 country code).", 'required': False}]
returns: List[ArgReturn] = [{'name': 'results', 'type': 'array', 'description': "The search results, each includes 'title', 'url' (string, the unique identifier of the search result), 'size', 'format' and 'source'."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'keyword' is empty or the 'num_results' is not a positive integer."}, {'name': 'NotFoundException', 'description': 'No search results are found.'}]
|
class GoogleSearchVideoSearch(VirtualFunctionTool):
name = 'GoogleSearchVideoSearch'
summary = 'Perform a video search on Google with a given keyword or phrase and return the search results.'
parameters: List[ArgParameter] = [{'name': 'keyword', 'type': 'string', 'description': 'The keyword or phrase to search.', 'required': True}, {'name': 'num_results', 'type': 'integer', 'description': 'The maximum number of results to return. Default is 10.', 'required': False}, {'name': 'filters', 'type': 'object', 'description': "The filters to apply, includes 'time_range' (string, in the format of 'YYYY-MM-DD..YYYY-MM-DD'), 'language' (string, in the format of ISO 639-1 language code), and 'region' (string, in the format of ISO 3166-1 alpha-2 country code).", 'required': False}]
returns: List[ArgReturn] = [{'name': 'results', 'type': 'array', 'description': "The search results, each includes 'title', 'url' (string, the unique identifier of the search result), 'duration', and 'format'."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'keyword' is empty or the 'num_results' is not a positive integer."}, {'name': 'NotFoundException', 'description': 'No search results are found.'}]
|
class GoogleSearchNewsSearch(VirtualFunctionTool):
name = 'GoogleSearchNewsSearch'
summary = 'Perform a news search on Google with a given keyword or phrase and return the search results.'
parameters: List[ArgParameter] = [{'name': 'keyword', 'type': 'string', 'description': 'The keyword or phrase to search.', 'required': True}, {'name': 'num_results', 'type': 'integer', 'description': 'The maximum number of results to return. Default is 10.', 'required': False}, {'name': 'filters', 'type': 'object', 'description': "The filters to apply, includes 'time_range' (string, in the format of 'YYYY-MM-DD..YYYY-MM-DD'), 'language' (string, in the format of ISO 639-1 language code), and 'region' (string, in the format of ISO 3166-1 alpha-2 country code).", 'required': False}]
returns: List[ArgReturn] = [{'name': 'results', 'type': 'array', 'description': "The search results, each includes 'title', 'snippet', 'url' (string, the unique identifier of the search result), and 'source'."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'keyword' is empty or the 'num_results' is not a positive integer."}, {'name': 'NotFoundException', 'description': 'No search results are found.'}]
|
class GoogleSearchGetSearchTrends(VirtualFunctionTool):
name = 'GoogleSearchGetSearchTrends'
summary = 'Access the search trends on Google.'
parameters: List[ArgParameter] = [{'name': 'time_range', 'type': 'string', 'description': "The time range to get the search trends, in the format of 'YYYY-MM-DD..YYYY-MM-DD'. Default is the past 7 days.", 'required': False}, {'name': 'location', 'type': 'string', 'description': 'The location to get the search trends, in the format of ISO 3166-1 alpha-2 country code. Default is not restricted to a specific location and shows global trends.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'trends', 'type': 'array', 'description': "The search trends, each is an object includes 'keyword', 'search_volume', and 'increase_percentage'."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'time_range' is invalid or the 'location' is invalid."}]
|
class GoogleSearchGetSearchHistory(VirtualFunctionTool):
name = 'GoogleSearchGetSearchHistory'
summary = "Retrieve the user's search history."
parameters: List[ArgParameter] = [{'name': 'time_range', 'type': 'string', 'description': "The time range to get the search history, in the format of 'YYYY-MM-DD..YYYY-MM-DD'. Default is the past 7 days.", 'required': False}]
returns: List[ArgReturn] = [{'name': 'history', 'type': 'array', 'description': "The user's search history, each includes 'keyword', 'time' (in the format of 'YYYY-MM-DD:HH:MM:SS'), and 'type' (one of ['web', 'image', 'video', 'news'])."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'time_range' is invalid."}]
|
@register_toolkit()
class GoogleSearch(FunctionToolkit):
name_for_human = 'Google Search'
description_for_human = 'Toolkit for interacting with Google Search.'
name_for_model = 'GoogleSearch'
description_for_model = "A toolkit for interacting with Google Search, providing functionalities such as performing web, image, video, and news searches, accessing search trends, and retrieving the user's search history. It also allows applying various filters to the search and performing advanced search with various options."
tool_classes = [GoogleSearchWebSearch, GoogleSearchImageSearch, GoogleSearchVideoSearch, GoogleSearchNewsSearch, GoogleSearchGetSearchTrends, GoogleSearchGetSearchHistory]
|
class WebBrowserNavigateTo(VirtualFunctionTool):
name = 'WebBrowserNavigateTo'
summary = 'Navigates to a specified URL.'
parameters: List[ArgParameter] = [{'name': 'url', 'type': 'string', 'description': 'The URL to navigate to.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'snippet', 'type': 'string', 'description': 'The snippet of the current webpage.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': 'The provided URL is not valid.'}]
|
class WebBrowserRetrieveElements(VirtualFunctionTool):
name = 'WebBrowserRetrieveElements'
summary = 'Retrieves elements in the current web page matching the given CSS selector.'
parameters: List[ArgParameter] = [{'name': 'css_selectors', 'type': 'array', 'description': 'The list of CSS selectors to match, each is a string.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'retrieve_results', 'type': 'array', 'description': "A list of array, each array contains elements matching the corresponding CSS selector, each element is an object includes 'id', 'tag_name', 'text'."}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': 'There is no current webpage.'}]
|
class WebBrowserGetElementsDetails(VirtualFunctionTool):
name = 'WebBrowserGetElementsDetails'
summary = 'Retrieves the details of a list of elements in the current web page.'
parameters: List[ArgParameter] = [{'name': 'element_ids', 'type': 'array', 'description': 'The ids of the element.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'element_details', 'type': 'array', 'description': "The details of the elements, each includes 'id', 'tag_name', 'text', 'attributes' and other possible fields."}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': 'There is no current webpage or the element does not exist.'}]
|
class WebBrowserInputText(VirtualFunctionTool):
name = 'WebBrowserInputText'
summary = 'Inputs multiple text into specified input fields.'
parameters: List[ArgParameter] = [{'name': 'elements_and_texts', 'type': 'array', 'description': "A list of objects, each includes 'element_id' (string, the id of the input field) and 'text' (string, the text to input).", 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the input was successful.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': 'At least one of the elements is not an input field or the text is not a string.'}, {'name': 'NotFoundException', 'description': 'There is no current webpage or at least one of the elements does not exist.'}]
|
class WebBrowserClickElement(VirtualFunctionTool):
name = 'WebBrowserClickElement'
summary = 'Clicks an element in the current web page.'
parameters: List[ArgParameter] = [{'name': 'element_id', 'type': 'string', 'description': 'The id of the element to click.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'result', 'type': 'object', 'description': "The result of the click action, including 'success' (boolean), 'current_url' (string, the URL of the new webpage if the click action triggers a page navigation), and 'snippet' (string, the snippet of the new webpage if the click action triggers a page navigation), 'download_file' (string, the file path of the downloaded file if the click action triggers a file download)."}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': 'The element does not exist or there is no current webpage.'}, {'name': 'InvalidRequestException', 'description': 'The element is not clickable.'}]
|
class WebBrowserSearchHistory(VirtualFunctionTool):
name = 'WebBrowserSearchHistory'
summary = 'Searches the browsing history.'
parameters: List[ArgParameter] = [{'name': 'query', 'type': 'string', 'description': 'The search query.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'history', 'type': 'array', 'description': "The matching history entries. Each history entry is an object with fields 'url' (string) and 'browse_time' (string, in the format of 'YYYY-MM-DD HH:MM:SS')."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': 'The provided query is not valid.'}]
|
class WebBrowserClearHistory(VirtualFunctionTool):
name = 'WebBrowserClearHistory'
summary = 'Clears the browsing history.'
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the operation was successful.'}]
exceptions: List[ArgException] = []
|
@register_toolkit()
class WebBrowser(FunctionToolkit):
name_for_human = 'Web Browser'
description_for_human = 'Toolkit for web browsing tasks.'
name_for_model = 'WebBrowser'
description_for_model = 'A toolkit that provides functionalities of a web browser, including navigating to a URL, retrieving elements matching a CSS selector, retrieving the element details, inputting text into an input field, clicking hyperlinks or buttons, and searching the browsing history. It also allows users to perform web browsing tasks such as filling out forms, downloading files, and clicking on hyperlinks or buttons.'
tool_classes = [WebBrowserNavigateTo, WebBrowserRetrieveElements, WebBrowserGetElementsDetails, WebBrowserInputText, WebBrowserClickElement, WebBrowserSearchHistory, WebBrowserClearHistory]
|
class NortonIdentitySafeStorePassword(VirtualFunctionTool):
name = 'NortonIdentitySafeStorePassword'
summary = 'Store a new password securely.'
parameters: List[ArgParameter] = [{'name': 'password', 'type': 'string', 'description': 'The password to store.', 'required': True}, {'name': 'website', 'type': 'string', 'description': 'The website associated with the password.', 'required': True}, {'name': 'username', 'type': 'string', 'description': 'The username associated with the password.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the operation was successful.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'password', 'website', or 'username' parameter is not provided or invalid."}]
|
class NortonIdentitySafeCheckPasswordStrength(VirtualFunctionTool):
name = 'NortonIdentitySafeCheckPasswordStrength'
summary = 'Check the strength of a password.'
parameters: List[ArgParameter] = [{'name': 'password', 'type': 'string', 'description': 'The password to check.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'strength', 'type': 'string', 'description': "The strength of the password, possible values: 'weak', 'medium', 'strong'."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'password' parameter is not provided or invalid."}]
|
class NortonIdentitySafeGeneratePassword(VirtualFunctionTool):
name = 'NortonIdentitySafeGeneratePassword'
summary = 'Generate a unique password.'
parameters: List[ArgParameter] = [{'name': 'length', 'type': 'integer', 'description': 'The length of the generated password. Default is 12.', 'required': False}, {'name': 'include_symbols', 'type': 'boolean', 'description': 'Whether to include symbols in the generated password. Default is true.', 'required': False}, {'name': 'include_numbers', 'type': 'boolean', 'description': 'Whether to include numbers in the generated password. Default is true.', 'required': False}, {'name': 'include_uppercase', 'type': 'boolean', 'description': 'Whether to include uppercase letters in the generated password. Default is true.', 'required': False}, {'name': 'include_lowercase', 'type': 'boolean', 'description': 'Whether to include lowercase letters in the generated password. Default is true.', 'required': False}, {'name': 'strength', 'type': 'string', 'description': "The strength of the generated password, must be one of ['weak', 'medium', 'strong'].", 'required': True}]
returns: List[ArgReturn] = [{'name': 'generated_password', 'type': 'string', 'description': 'The generated password.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'strength' parameter is not one of ['weak', 'medium', 'strong']."}]
|
class NortonIdentitySafeAutoFillPassword(VirtualFunctionTool):
name = 'NortonIdentitySafeAutoFillPassword'
summary = 'Auto-fill the password on a specified website.'
parameters: List[ArgParameter] = [{'name': 'website', 'type': 'string', 'description': 'The website to auto-fill the password on.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the operation was successful.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': 'The password for the specified website is not found.'}, {'name': 'InvalidRequestException', 'description': "The 'website' parameter is not provided or invalid."}]
|
class NortonIdentitySafeSearchPasswords(VirtualFunctionTool):
name = 'NortonIdentitySafeSearchPasswords'
summary = 'Search and retrieve stored passwords.'
parameters: List[ArgParameter] = [{'name': 'query', 'type': 'string', 'description': 'The search query.', 'required': True}, {'name': 'max_results', 'type': 'integer', 'description': 'The maximum number of search results to return. Default is 10.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'passwords', 'type': 'array', 'description': "A list of objects, each object contains 'website', 'username', and 'password'."}]
exceptions: List[ArgException] = []
|
class NortonIdentitySafeStorePersonalInfo(VirtualFunctionTool):
name = 'NortonIdentitySafeStorePersonalInfo'
summary = 'Store personal information such as addresses and payment details.'
parameters: List[ArgParameter] = [{'name': 'info_type', 'type': 'string', 'description': "The type of personal information, must be one of ['address', 'payment'].", 'required': True}, {'name': 'info_data', 'type': 'object', 'description': "The personal information data. For 'address', the object should contain 'street', 'city', 'state', 'zip_code'. For 'payment', the object should contain 'card_number', 'expiry_date', 'cvv'.", 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the operation was successful.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'info_type' parameter is not one of ['address', 'payment'] or the 'info_data' parameter is not provided or invalid."}]
|
class NortonIdentitySafeAutoFillPersonalInfo(VirtualFunctionTool):
name = 'NortonIdentitySafeAutoFillPersonalInfo'
summary = 'Auto-fill personal information on a specified website.'
parameters: List[ArgParameter] = [{'name': 'website', 'type': 'string', 'description': 'The website to auto-fill the personal information on.', 'required': True}, {'name': 'info_type', 'type': 'string', 'description': "The type of personal information, must be one of ['address', 'payment'].", 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the operation was successful.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': 'The personal information for the specified info_type is not found.'}, {'name': 'InvalidRequestException', 'description': "The 'website' or 'info_type' parameter is not provided or invalid."}]
|
class NortonIdentitySafeRetrievePersonalInfo(VirtualFunctionTool):
name = 'NortonIdentitySafeRetrievePersonalInfo'
summary = 'Retrieve stored personal information based on the info type.'
parameters: List[ArgParameter] = [{'name': 'info_type', 'type': 'string', 'description': "The type of personal information, must be one of ['address', 'payment'].", 'required': True}]
returns: List[ArgReturn] = [{'name': 'info_data', 'type': 'object', 'description': "The personal information data. For 'address', the object contains 'street', 'city', 'state', 'zip_code'. For 'payment', the object contains 'card_number', 'expiry_date', 'cvv'."}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': 'The personal information for the specified info_type is not found.'}, {'name': 'InvalidRequestException', 'description': "The 'info_type' parameter is not provided or invalid."}]
|
class NortonIdentitySafeSharePassword(VirtualFunctionTool):
name = 'NortonIdentitySafeSharePassword'
summary = 'Share a stored password securely with a trusted contact.'
parameters: List[ArgParameter] = [{'name': 'website', 'type': 'string', 'description': 'The website associated with the password to share.', 'required': True}, {'name': 'username', 'type': 'string', 'description': 'The username associated with the password to share.', 'required': True}, {'name': 'contact_email', 'type': 'string', 'description': 'The email address of the trusted contact.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the operation was successful.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': 'The password for the specified website and username is not found.'}, {'name': 'InvalidRequestException', 'description': "The 'website', 'username', or 'contact_email' parameter is not provided or invalid."}]
|
class NortonIdentitySafeImportPasswords(VirtualFunctionTool):
name = 'NortonIdentitySafeImportPasswords'
summary = 'Import password data from a file.'
parameters: List[ArgParameter] = [{'name': 'file_path', 'type': 'string', 'description': 'The local file path of the password data file.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the operation was successful.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'file_path' parameter is not provided or invalid."}]
|
class NortonIdentitySafeExportPasswords(VirtualFunctionTool):
name = 'NortonIdentitySafeExportPasswords'
summary = 'Export stored password data to a file.'
parameters: List[ArgParameter] = [{'name': 'file_path', 'type': 'string', 'description': 'The local file path to save the exported password data.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the operation was successful.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'file_path' parameter is not provided or invalid."}]
|
class NortonIdentitySafeEnableTwoFactorAuthentication(VirtualFunctionTool):
name = 'NortonIdentitySafeEnableTwoFactorAuthentication'
summary = 'Enable two-factor authentication for added security.'
parameters: List[ArgParameter] = [{'name': 'phone_number', 'type': 'string', 'description': 'The phone number to receive authentication codes.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the operation was successful.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'phone_number' parameter is not provided or invalid."}]
|
class NortonIdentitySafeDisableTwoFactorAuthentication(VirtualFunctionTool):
name = 'NortonIdentitySafeDisableTwoFactorAuthentication'
summary = 'Disable two-factor authentication.'
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the operation was successful.'}]
exceptions: List[ArgException] = []
|
@register_toolkit()
class NortonIdentitySafe(FunctionToolkit):
name_for_human = 'Norton Identity Safe'
description_for_human = 'Toolkit for managing and protecting online passwords and personal information.'
name_for_model = 'NortonIdentitySafe'
description_for_model = 'A toolkit for managing and protecting online passwords and personal information. It provides tools for storing, generating, auto-filling, searching, sharing, importing, and exporting passwords, as well as storing, auto-filling, and retrieving personal information. It also supports two-factor authentication for added security.'
tool_classes = [NortonIdentitySafeStorePassword, NortonIdentitySafeCheckPasswordStrength, NortonIdentitySafeGeneratePassword, NortonIdentitySafeAutoFillPassword, NortonIdentitySafeSearchPasswords, NortonIdentitySafeStorePersonalInfo, NortonIdentitySafeAutoFillPersonalInfo, NortonIdentitySafeRetrievePersonalInfo, NortonIdentitySafeSharePassword, NortonIdentitySafeImportPasswords, NortonIdentitySafeExportPasswords, NortonIdentitySafeEnableTwoFactorAuthentication, NortonIdentitySafeDisableTwoFactorAuthentication]
|
class AugustSmartLockCheckLockStatus(VirtualFunctionTool):
name = 'AugustSmartLockCheckLockStatus'
summary = 'Retrieves the current lock status of the door.'
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'lock_status', 'type': 'string', 'description': "The lock status of the door, either 'locked' or 'unlocked'."}]
exceptions: List[ArgException] = []
|
class AugustSmartLockLockDoor(VirtualFunctionTool):
name = 'AugustSmartLockLockDoor'
summary = 'Locks the door.'
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the door was locked successfully or not.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': 'The door is already locked.'}]
|
class AugustSmartLockUnlockDoor(VirtualFunctionTool):
name = 'AugustSmartLockUnlockDoor'
summary = 'Unlocks the door.'
parameters: List[ArgParameter] = []
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the door was unlocked successfully or not.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': 'The door is already unlocked.'}]
|
class AugustSmartLockSearchGuests(VirtualFunctionTool):
name = 'AugustSmartLockSearchGuests'
summary = 'Searches for guests by name in the system.'
parameters: List[ArgParameter] = [{'name': 'name_keyword', 'type': 'string', 'description': 'Keyword of the guest name to search for.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'guests', 'type': 'array', 'description': "An array of objects, each object contains 'guest_id' (string), 'guest_name' (string), and 'guest_email' (string)."}]
exceptions: List[ArgException] = []
|
class AugustSmartLockAddGuest(VirtualFunctionTool):
name = 'AugustSmartLockAddGuest'
summary = 'Adds a guest to the system.'
parameters: List[ArgParameter] = [{'name': 'guest_name', 'type': 'string', 'description': 'Name of the guest to add.', 'required': True}, {'name': 'guest_email', 'type': 'string', 'description': 'Email address of the guest to add.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'guest_id', 'type': 'string', 'description': 'Unique identifier of the added guest.'}]
exceptions: List[ArgException] = [{'name': 'ConflictException', 'description': 'The guest already exists.'}]
|
class AugustSmartLockDeleteGuest(VirtualFunctionTool):
name = 'AugustSmartLockDeleteGuest'
summary = 'Deletes a guest from the system.'
parameters: List[ArgParameter] = [{'name': 'guest_ids', 'type': 'array', 'description': 'An array of guest IDs to delete.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the guest was deleted successfully or not.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': 'At least one of the guest IDs does not exist.'}]
|
class AugustSmartLockGrantGuestAccess(VirtualFunctionTool):
name = 'AugustSmartLockGrantGuestAccess'
summary = "Grants permanent or temporary access to guests. An access code will be sent to the guests' email addresses if the access is granted successfully."
parameters: List[ArgParameter] = [{'name': 'guest_ids', 'type': 'array', 'description': 'An array of guest IDs to grant access to.', 'required': True}, {'name': 'permanent', 'type': 'boolean', 'description': 'Whether to grant permanent access or not.', 'required': True}, {'name': 'start_time', 'type': 'string', 'description': 'Start time of the access period in YYYY-MM-DD HH:mm format, required for granting temporary access.', 'required': False}, {'name': 'end_time', 'type': 'string', 'description': 'End time of the access period in YYYY-MM-DD HH:mm format, required for granting temporary access.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the access was granted successfully or not.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': 'At least one of the guest IDs does not exist.'}, {'name': 'ConflictException', 'description': 'The access has already been granted.'}, {'name': 'InvalidRequestException', 'description': 'The start_time and end_time are invalid or the start_time is later than the end_time, or the start_time and end_time are not provided when granting temporary access.'}]
|
class AugustSmartLockRevokeGuestAccess(VirtualFunctionTool):
name = 'AugustSmartLockRevokeGuestAccess'
summary = 'Revokes access for a guest.'
parameters: List[ArgParameter] = [{'name': 'guest_ids', 'type': 'array', 'description': 'An array of guest IDs to revoke access for.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the access was revoked successfully or not.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': 'At least one of the guest IDs does not exist.'}, {'name': 'InvalidRequestException', 'description': 'The access has not been granted.'}]
|
class AugustSmartLockGenerateTemporaryAccessCode(VirtualFunctionTool):
name = 'AugustSmartLockGenerateTemporaryAccessCode'
summary = 'Generates a temporary access code that can be used to unlock the door for a specified period of time.'
parameters: List[ArgParameter] = [{'name': 'start_time', 'type': 'string', 'description': 'Start time of the access period in YYYY-MM-DD HH:mm format.', 'required': True}, {'name': 'end_time', 'type': 'string', 'description': 'End time of the access period in YYYY-MM-DD HH:mm format.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'access_code', 'type': 'string', 'description': 'The generated temporary access code.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': 'The start_time and end_time are invalid or the start_time is later than the end_time.'}]
|
class AugustSmartLockRevokeTemporaryAccessCode(VirtualFunctionTool):
name = 'AugustSmartLockRevokeTemporaryAccessCode'
summary = 'Revokes a temporary access code.'
parameters: List[ArgParameter] = [{'name': 'access_code', 'type': 'string', 'description': 'The temporary access code to revoke.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the access code was revoked successfully or not.'}]
exceptions: List[ArgException] = [{'name': 'NotFoundException', 'description': 'The access code does not exist.'}]
|
class AugustSmartLockViewAccessHistory(VirtualFunctionTool):
name = 'AugustSmartLockViewAccessHistory'
summary = 'Retrieves access history.'
parameters: List[ArgParameter] = [{'name': 'start_time', 'type': 'string', 'description': 'Start time of the history period in YYYY-MM-DD HH:mm format.', 'required': True}, {'name': 'end_time', 'type': 'string', 'description': 'End time of the history period in YYYY-MM-DD HH:mm format.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'access_history', 'type': 'array', 'description': 'An array of access history events with details including guest id, guest name, guest email, access time.'}]
exceptions: List[ArgException] = []
|
@register_toolkit()
class AugustSmartLock(FunctionToolkit):
name_for_human = 'August Smart Lock'
description_for_human = 'Toolkit for controlling and managing August Smart Lock.'
name_for_model = 'AugustSmartLock'
description_for_model = "Used for controlling and managing the August Smart Lock, specifically installed on the front door of the user's residence. It provides tools to lock and unlock the door, check the lock status, add and delete guests, grant and revoke access for guests, generate and revoke access codes, and view access history."
tool_classes = [AugustSmartLockCheckLockStatus, AugustSmartLockLockDoor, AugustSmartLockUnlockDoor, AugustSmartLockSearchGuests, AugustSmartLockAddGuest, AugustSmartLockDeleteGuest, AugustSmartLockGrantGuestAccess, AugustSmartLockRevokeGuestAccess, AugustSmartLockGenerateTemporaryAccessCode, AugustSmartLockRevokeTemporaryAccessCode, AugustSmartLockViewAccessHistory]
|
class IFTTTSearchConnectedServices(VirtualFunctionTool):
name = 'IFTTTSearchConnectedServices'
summary = "Search services that are connected to the user's IFTTT account by keywords."
parameters: List[ArgParameter] = [{'name': 'keywords', 'type': 'string', 'description': "Keywords to search for connected services, e.g., 'Twitter', 'Gmail', 'Weather'.", 'required': True}, {'name': 'max_results', 'type': 'integer', 'description': 'Maximum number of results to return, default is 5.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'connected_services', 'type': 'array', 'description': "An array of connected services that match the keywords, each object contains 'service_name' and 'service_description'."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'keyword' is empty or invalid, or the 'max_results' is not a positive integer."}]
|
class IFTTTSearchTriggers(VirtualFunctionTool):
name = 'IFTTTSearchTriggers'
summary = 'Search for available triggers by keywords for a specific connected service. The triggers are something that happens on the service, e.g., a new tweet, a new email, a new weather forecast.'
parameters: List[ArgParameter] = [{'name': 'service_name', 'type': 'string', 'description': "The service to search for triggers, e.g., 'Twitter', 'Gmail', 'Weather'. Must be an existing connected service returned by ListConnectedServices.", 'required': True}, {'name': 'keywords', 'type': 'string', 'description': "Keywords to search for triggers, e.g., 'new tweet', 'received email', 'temperature'.", 'required': True}, {'name': 'max_results', 'type': 'integer', 'description': 'The maximum number of search results to return, default is 10.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'triggers', 'type': 'array', 'description': "An array of available triggers matching the keywords, each trigger includes 'service_name' (str, the service name, e.g., 'Twitter'), 'trigger_name' (str, the trigger name, e.g., 'new tweet from user'), 'trigger_description' (str, the trigger description), and 'trigger_parameters' (object, the description of the parameters required for the trigger, e.g., a key 'user_name' with value 'str, the user name', empty if no parameters are required)."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'service_name' or 'keywords' argument is not a valid string or the 'max_results' argument is not a valid integer."}, {'name': 'NotFoundException', 'description': "The 'service_name' argument is not an existing connected service."}]
|
class IFTTTSearchActions(VirtualFunctionTool):
name = 'IFTTTSearchActions'
summary = 'Search for available actions by keywords for a specific connected service. The actions are something that can be done on the service, e.g., post a tweet, send an email, turn on a light.'
parameters: List[ArgParameter] = [{'name': 'service_name', 'type': 'string', 'description': "The service to search for actions, e.g., 'Twitter', 'Gmail', 'Hue'. Must be an existing connected service returned by ListConnectedServices.", 'required': True}, {'name': 'keywords', 'type': 'string', 'description': "Keywords to search for actions, e.g., 'post tweet', 'send email', 'turn on light'.", 'required': True}, {'name': 'max_results', 'type': 'integer', 'description': 'The maximum number of search results to return, default is 10.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'actions', 'type': 'array', 'description': "An array of available actions matching the keywords, each action includes 'service_name' (str, the service name, e.g., 'Twitter'), 'action_name' (str, the action name, e.g., 'post tweet'), 'action_description' (str, the action description), and 'action_parameters' (object, the description of the parameters required for the action, e.g., a key 'tweet' with value 'str, the tweet content', empty if no parameters required)."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'service_name' or 'keywords' argument is not a valid string or the 'max_results' argument is not a valid integer."}, {'name': 'NotFoundException', 'description': "The 'service_name' argument is not an existing connected service."}]
|
class IFTTTCreateApplet(VirtualFunctionTool):
name = 'IFTTTCreateApplet'
summary = 'Create a new applet with a specified trigger and action. Once the trigger is activated, the action will be performed.'
parameters: List[ArgParameter] = [{'name': 'trigger_service_name', 'type': 'string', 'description': "The service of the trigger for the applet, e.g., 'Twitter'. Must be an existing connected service returned by ListConnectedServices.", 'required': True}, {'name': 'trigger_name', 'type': 'string', 'description': "The specific trigger from the service for the applet, e.g., 'new tweet from user'. Must be an existing trigger returned by SearchTriggers for the specified service.", 'required': True}, {'name': 'trigger_parameters', 'type': 'object', 'description': 'The parameters for the trigger. Must be a valid object matching the description returned by SearchTriggers for the specified trigger.', 'required': True}, {'name': 'action_service_name', 'type': 'string', 'description': "The service of the action for the applet, e.g., 'Gmail'. Must be an existing connected service returned by ListConnectedServices.", 'required': True}, {'name': 'action_name', 'type': 'string', 'description': "The specific action from the service to perform when the trigger is activated, e.g., 'send an email'. Must be an existing action returned by SearchActions for the specified service. ", 'required': True}, {'name': 'action_parameters', 'type': 'object', 'description': 'The parameters for the action. Must be a valid object matching the description returned by SearchActions for the specified action.', 'required': True}]
returns: List[ArgReturn] = [{'name': 'success', 'type': 'boolean', 'description': 'Whether the applet was successfully created.'}, {'name': 'applet_id', 'type': 'string', 'description': 'The unique identifier of the created applet. Empty if the applet was not successfully created.'}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The 'trigger_parameters' does not match the parameter required by the specified 'trigger_name' or the 'action_parameters' does not match the parameter required by the specified 'action_name'."}, {'name': 'NotFoundException', 'description': "The specified 'trigger_service_name', 'trigger_name', 'action_service_name', or 'action_name' does not exist."}]
|
class IFTTTSearchApplets(VirtualFunctionTool):
name = 'IFTTTSearchApplets'
summary = 'Search for applets matching the specified criteria.'
parameters: List[ArgParameter] = [{'name': 'trigger_keywords', 'type': 'string', 'description': 'The keywords to search for in the trigger name. If not specified, all triggers will be considered.', 'required': False}, {'name': 'action_keywords', 'type': 'string', 'description': 'The keywords to search for in the action name. If not specified, all actions will be considered.', 'required': False}, {'name': 'max_results', 'type': 'integer', 'description': 'The maximum number of applets to return.', 'required': False}]
returns: List[ArgReturn] = [{'name': 'applets', 'type': 'array', 'description': "The list of applets matching the specified criteria, each is an object containing 'applet_id', 'trigger_service_name', 'trigger_name', 'trigger_parameters', 'action_service_name', 'action_name', and 'action_parameters'."}]
exceptions: List[ArgException] = [{'name': 'InvalidRequestException', 'description': "The specified 'max_results' is not a positive integer."}]
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.