tools
#
Tools are classes that an Agent uses to interact with the world.
Each tool has a description. Agent uses the description to choose the right tool for the job.
Class hierarchy:
ToolMetaclass --> BaseTool --> <name>Tool # Examples: AIPluginTool, BaseGraphQLTool
<name> # Examples: BraveSearch, HumanInputRun
Main helpers:
CallbackManagerForToolRun, AsyncCallbackManagerForToolRun
Classes
Tool for app operations. |
|
Type of app operation as enumerator. |
|
Schema for app operations. |
|
Base class for the AINetwork tools. |
|
|
Type of operation as enumerator. |
Tool for owner operations. |
|
Schema for owner operations. |
|
Tool for owner operations. |
|
Schema for owner operations. |
|
Tool for transfer operations. |
|
Schema for transfer operations. |
|
Tool for value operations. |
|
Schema for value operations. |
|
Base Tool for Amadeus. |
|
Tool for finding the closest airport to a particular location. |
|
Schema for the AmadeusClosestAirport tool. |
|
Tool for searching for a single flight between two airports. |
|
Schema for the AmadeusFlightSearch tool. |
|
Input for the Arxiv tool. |
|
Tool that searches the Arxiv API. |
|
Tool that searches the AskNews API. |
|
Input for the AskNews Search tool. |
|
|
HuggingFace Text-to-Speech Model Inference. |
|
Tool that queries the Azure AI Services Document Intelligence API. |
|
Tool that queries the Azure AI Services Image Analysis API. |
|
Tool that queries the Azure AI Services Speech to Text API. |
|
Tool that queries the Azure AI Services Text Analytics for Health API. |
|
Tool that queries the Azure AI Services Text to Speech API. |
|
Tool that queries the Azure Cognitive Services Form Recognizer API. |
|
Tool that queries the Azure Cognitive Services Image Analysis API. |
|
Tool that queries the Azure Cognitive Services Speech2Text API. |
|
Tool that queries the Azure Cognitive Services Text2Speech API. |
|
Tool that queries the Azure Cognitive Services Text Analytics for Health API. |
Tool for evaluating python code in a sandbox environment. |
|
Arguments for the BearlyInterpreterTool. |
|
Information about a file to be uploaded. |
|
Bing Search tool. |
|
Tool that queries the Bing search API. |
|
Tool that queries the BraveSearch. |
|
Base tool for interacting with an Apache Cassandra database. |
|
|
Tool for getting the schema of a keyspace in an Apache Cassandra database. |
|
Tool for getting data from a table in an Apache Cassandra database. |
Tool for querying an Apache Cassandra database with provided CQL. |
|
Tool that queries the Clickup API. |
|
Tool that uses the Cogniswitch service to answer questions. |
|
Tool that uses the Cogniswitch services to store data from file. |
|
Tool that uses the Cogniswitch services to store data from a URL. |
|
Tool that uses the Cogniswitch services to get the |
|
Connery Action model. |
|
Connery Action parameter model. |
|
Connery Action parameter validation model. |
|
Service for interacting with the Connery Runner API. |
|
Connery Action tool. |
|
Create a new model by parsing and validating input data from keyword arguments. |
|
Tool that queries the DataForSeo Google Search API and get back json. |
|
Tool that queries the DataForSeo Google search API. |
|
Tool that queries using the Dataherald SDK. |
|
Create a new model by parsing and validating input data from keyword arguments. |
|
Input for the DuckDuckGo search tool. |
|
Tool that queries the DuckDuckGo search API and gets back json string. |
|
DuckDuckGo tool. |
|
Tool for running python code in a sandboxed environment for data analysis. |
|
Arguments for the E2BDataAnalysisTool. |
|
Description of the uploaded path with its remote path. |
|
Traverse an AST and output source code for the abstract syntax; original formatting is disregarded. |
|
Tool that queries the Eden AI Speech To Text API. |
|
Create a new model by parsing and validating input data from keyword arguments. |
|
Tool that queries the Eden AI Text to speech API. |
|
Create a new model by parsing and validating input data from keyword arguments. |
|
the base tool for all the EdenAI Tools . |
|
Tool that queries the Eden AI Explicit image detection. |
|
Create a new model by parsing and validating input data from keyword arguments. |
|
|
Tool that queries the Eden AI Object detection API. |
Create a new model by parsing and validating input data from keyword arguments. |
|
Tool that queries the Eden AI Identity parsing API. |
|
Create a new model by parsing and validating input data from keyword arguments. |
|
Tool that queries the Eden AI Invoice parsing API. |
|
Create a new model by parsing and validating input data from keyword arguments. |
|
Tool that queries the Eden AI Explicit text detection. |
|
Create a new model by parsing and validating input data from keyword arguments. |
|
Models available for Eleven Labs Text2Speech. |
|
Models available for Eleven Labs Text2Speech. |
|
Tool that queries the Eleven Labs Text2Speech API. |
|
Tool that copies a file. |
|
Input for CopyFileTool. |
|
Tool that deletes a file. |
|
Input for DeleteFileTool. |
|
Input for FileSearchTool. |
|
Tool that searches for files in a subdirectory that match a regex pattern. |
|
Input for ListDirectoryTool. |
|
Tool that lists files and directories in a specified folder. |
|
Input for MoveFileTool. |
|
Tool that moves a file. |
|
Input for ReadFileTool. |
|
Tool that reads a file. |
|
Mixin for file system tools. |
|
Error for paths outside the root directory. |
|
Input for WriteFileTool. |
|
Tool that writes a file to disk. |
|
Tool that gets balance sheets for a given ticker over a given period. |
|
Input for BalanceSheets. |
|
|
Tool that gets cash flow statements for a given ticker over a given period. |
|
Input for CashFlowStatements. |
Tool that gets income statements for a given ticker over a given period. |
|
|
Input for IncomeStatements. |
Tool for interacting with the GitHub API. |
|
Tool for interacting with the GitLab API. |
|
Base class for Gmail tools. |
|
Input for CreateDraftTool. |
|
Tool that creates a draft email for Gmail. |
|
Tool that gets a message by ID from Gmail. |
|
Input for GetMessageTool. |
|
Input for GetMessageTool. |
|
Tool that gets a thread by ID from Gmail. |
|
Tool that searches for messages or threads in Gmail. |
|
|
Enumerator of Resources to search. |
Input for SearchGmailTool. |
|
Tool that sends a message to Gmail. |
|
Input for SendMessageTool. |
|
Tool that adds the capability to query using the Golden API and get back JSON. |
|
Tool that queries the Google Finance API. |
|
Tool that queries the Google Jobs API. |
|
Tool that queries the Google Lens API. |
|
Input for GooglePlacesTool. |
|
Tool that queries the Google search API. |
|
Tool that queries the Serper.dev Google Search API and get back json. |
|
Tool that queries the Serper.dev Google search API. |
|
Tool that queries the Google trends API. |
|
Base tool for querying a GraphQL API. |
|
Tool that asks user for input. |
|
IFTTT Webhook. |
|
Input for the Jina search tool. |
|
Tool that queries the JinaSearch. |
|
Tool that queries the Atlassian Jira API. |
|
Tool for getting a value in a JSON spec. |
|
Tool for listing keys in a JSON spec. |
|
Base class for JSON spec. |
|
Tool that trains a language model. |
|
|
Protocol for trainable language models. |
Tool that searches the Merriam-Webster API. |
|
Initialize the tool. |
|
Input for UpdateSessionTool. |
|
Tool that closes an existing Multion Browser Window with provided fields. |
|
Input for CreateSessionTool. |
|
Tool that creates a new Multion Browser Window with provided fields. |
|
Tool that updates an existing Multion Browser Window with provided fields. |
|
Input for UpdateSessionTool. |
|
Tool that queries the Atlassian Jira API. |
|
Input for Nuclia Understanding API. |
|
Tool to process files with the Nuclia Understanding API. |
|
Base class for the Office 365 tools. |
|
|
Input for SendMessageTool. |
Tool for creating a draft email in Office 365. |
|
Search calendar events in Office 365. |
|
Input for SearchEmails Tool. |
|
Search email messages in Office 365. |
|
Input for SearchEmails Tool. |
|
Tool for sending calendar events in Office 365. |
|
Input for CreateEvent Tool. |
|
Send an email in Office 365. |
|
Input for SendMessageTool. |
|
|
Tool that generates an image using OpenAI DALLE. |
A model for a single API operation. |
|
A model for a property in the query, path, header, or cookie params. |
|
Base model for an API property. |
|
The location of the property. |
|
A model for a request body. |
|
A model for a request body property. |
|
Tool that queries the OpenWeatherMap API. |
|
Tool that queries the Passio Nutrition AI API. |
|
Inputs to the Passio Nutrition AI tool. |
|
Base class for browser tools. |
|
Tool for clicking on an element with the given CSS selector. |
|
Input for ClickTool. |
|
Tool for getting the URL of the current webpage. |
|
Extract all hyperlinks on the page. |
|
|
Input for ExtractHyperlinksTool. |
Tool for extracting all the text on the current webpage. |
|
Tool for getting elements in the current web page matching a CSS selector. |
|
Input for GetElementsTool. |
|
Tool for navigating a browser to a URL. |
|
Input for NavigateToolInput. |
|
Navigate back to the previous page in the browser history. |
|
AI Plugin Definition. |
|
Tool for getting the OpenAPI spec for an AI Plugin. |
|
Schema for AIPluginTool. |
|
API Configuration. |
|
Tool that gets aggregate bars (stock prices) over a given date range for a given ticker from Polygon. |
|
Input for PolygonAggregates. |
|
Inputs for Polygon's Financials API |
|
Tool that gets the financials of a ticker from Polygon |
|
Inputs for Polygon's Last Quote API |
|
Tool that gets the last quote of a ticker from Polygon |
|
Inputs for Polygon's Ticker News API |
|
Tool that gets the latest news for a given ticker from Polygon |
|
Tool for getting metadata about a PowerBI Dataset. |
|
Tool for getting tables names. |
|
Tool for querying a Power BI Dataset. |
|
Tool that searches the PubMed API. |
|
Tool that queries for posts on a subreddit. |
|
Input for Reddit search. |
|
Base class for requests tools. |
|
Tool for making a DELETE request to an API endpoint. |
|
Tool for making a GET request to an API endpoint. |
|
Tool for making a PATCH request to an API endpoint. |
|
Tool for making a POST request to an API endpoint. |
|
Tool for making a PUT request to an API endpoint. |
|
A tool implementation to execute JavaScript via Riza's Code Interpreter API. |
|
Create a new model by parsing and validating input data from keyword arguments. |
|
Riza Code tool. |
|
Create a new model by parsing and validating input data from keyword arguments. |
|
Input for SceneXplain. |
|
Tool that explains images. |
|
Tool that queries the SearchApi.io search API and returns JSON. |
|
Tool that queries the SearchApi.io search API. |
|
Input for the SearxSearch tool. |
|
Tool that queries a Searx instance and gets back json. |
|
Tool that queries a Searx instance. |
|
Tool that searches the semanticscholar API. |
|
Input for the SemanticScholar tool. |
|
Commands for the Bash Shell tool. |
|
Tool to run shell commands. |
|
Base class for Slack tools. |
|
Tool that gets Slack channel information. |
|
Tool that gets Slack messages. |
|
Input schema for SlackGetMessages. |
|
Input for ScheduleMessageTool. |
|
Tool for scheduling a message in Slack. |
|
Input for SendMessageTool. |
|
Tool for sending a message in Slack. |
|
Input for CopyFileTool. |
|
Tool that adds the capability to sleep. |
|
Base tool for interacting with Spark SQL. |
|
Tool for getting metadata about a Spark SQL. |
|
Tool for getting tables names. |
|
Use an LLM to check if a query is correct. |
|
Tool for querying a Spark SQL. |
|
Base tool for interacting with a SQL database. |
|
Tool for getting metadata about a SQL database. |
|
Tool for getting tables names. |
|
Use an LLM to check if a query is correct. |
|
Tool for querying a SQL database. |
|
Tool that uses StackExchange |
|
Tool that searches the Steam Web API. |
|
Supported Image Models for generation. |
|
|
Tool used to generate images from a text-prompt. |
Tool that queries the Tavily Search API and gets back an answer. |
|
Input for the Tavily tool. |
|
Tool that queries the Tavily Search API and gets back json. |
|
Base class for tools that use a VectorStore. |
|
Tool for the VectorDBQA chain. |
|
Tool for the VectorDBQAWithSources chain. |
|
Tool that searches the Wikidata API. |
|
Input for the WikipediaQuery tool. |
|
Tool that searches the Wikipedia API. |
|
Tool that queries using the Wolfram Alpha SDK. |
|
Input for the YahooFinanceNews tool. |
|
Tool that searches financial news on Yahoo Finance. |
|
Input schema for the you.com tool. |
|
Tool that searches the you.com API. |
|
Tool that queries YouTube. |
|
Returns a list of all exposed (enabled) actions associated with current user (associated with the set api_key). |
|
Executes an action that is identified by action_id, must be exposed |
|
|
|
|
|
Create a new model by parsing and validating input data from keyword arguments. |
|
Initialize the tool. |
Functions
|
Authenticate using the AIN Blockchain |
Authenticate using the Amadeus API |
|
Detect if the file is local or remote. |
|
Download audio from url to local. |
|
|
Detect if the file is local or remote. |
|
Download audio from url to local. |
Convert a file to base64. |
|
|
Get the first n lines of a file. |
|
Strip markdown code from a string. |
Deprecated. |
|
Add print statement to the last line if it's missing. |
|
Call f on each item in seq, calling inter() in between. |
|
Parse a file and pretty-print it to output. |
|
|
Resolve a relative path, raising an error if not within the root directory. |
Check if path is relative to root. |
|
Build a Gmail service. |
|
Clean email body. |
|
Get credentials. |
|
Import google libraries. |
|
Import googleapiclient.discovery.build function. |
|
Import InstalledAppFlow class. |
|
Tool for asking the user for input. |
|
Authenticate using the Microsoft Graph API |
|
Clean body of a message or event. |
|
Lazy import playwright browsers. |
|
Asynchronously get the current page of the browser. |
|
|
Create an async playwright browser. |
|
Create a playwright browser. |
Get the current page of the browser. |
|
Run an async coroutine. |
|
Convert the yaml or json serialized spec to a dict. |
|
Authenticate using the Slack API. |
|
|
Upload a block to a signed URL and return the public URL. |
Deprecated classes
Deprecated since version 0.0.33: Use |
|
Deprecated since version 0.0.33: Use |
|
Deprecated since version 0.0.33: Use |
|
Deprecated since version 0.0.33: Use |
|
Deprecated since version 0.0.15: Use |