id stringlengths 14 15 | text stringlengths 35 2.51k | source stringlengths 61 154 |
|---|---|---|
90710128a3a4-1 | Handle the content of the ToolException thrown.
param name: str = 'bing_search'¶
The unique name of the tool that clearly communicates its purpose.
param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop loopi... | https://api.python.langchain.com/en/latest/tools/langchain.tools.bing_search.tool.BingSearchRun.html |
b9faaf82da57-0 | langchain.tools.google_search.tool.GoogleSearchRun¶
class langchain.tools.google_search.tool.GoogleSearchRun(*, name: str = 'google_search', description: str = 'A wrapper around Google Search. Useful for when you need to answer questions about current events. Input should be a search query.', args_schema: Optional[Type... | https://api.python.langchain.com/en/latest/tools/langchain.tools.google_search.tool.GoogleSearchRun.html |
b9faaf82da57-1 | param name: str = 'google_search'¶
The unique name of the tool that clearly communicates its purpose.
param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
param verbose: bool = False¶
Whether to lo... | https://api.python.langchain.com/en/latest/tools/langchain.tools.google_search.tool.GoogleSearchRun.html |
938c6c3f8c5b-0 | langchain.tools.google_serper.tool.GoogleSerperResults¶
class langchain.tools.google_serper.tool.GoogleSerperResults(*, name: str = 'Google Serrper Results JSON', description: str = 'A low-cost Google Search API.Useful for when you need to answer questions about current events.Input should be a search query. Output is ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.google_serper.tool.GoogleSerperResults.html |
938c6c3f8c5b-1 | You can provide few-shot examples as a part of the description.
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'Google Serrper Results JSON'¶
The unique name of the tool that clearly communicates its purpose.... | https://api.python.langchain.com/en/latest/tools/langchain.tools.google_serper.tool.GoogleSerperResults.html |
4f6a1896f065-0 | langchain.tools.openapi.utils.api_models.APIPropertyBase¶
class langchain.tools.openapi.utils.api_models.APIPropertyBase(*, name: str, required: bool, type: Union[str, Type, tuple, None, Enum] = None, default: Optional[Any] = None, description: Optional[str] = None)[source]¶
Bases: BaseModel
Base model for an API prope... | https://api.python.langchain.com/en/latest/tools/langchain.tools.openapi.utils.api_models.APIPropertyBase.html |
488dade076b4-0 | langchain.tools.steamship_image_generation.tool.SteamshipImageGenerationTool¶
class langchain.tools.steamship_image_generation.tool.SteamshipImageGenerationTool(*, name: str = 'GenerateImage', description: str = 'Useful for when you need to generate an image.Input: A detailed text-2-image prompt describing an imageOutp... | https://api.python.langchain.com/en/latest/tools/langchain.tools.steamship_image_generation.tool.SteamshipImageGenerationTool.html |
488dade076b4-1 | Handle the content of the ToolException thrown.
param model_name: ModelName [Required]¶
param name: str = 'GenerateImage'¶
The unique name of the tool that clearly communicates its purpose.
param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is... | https://api.python.langchain.com/en/latest/tools/langchain.tools.steamship_image_generation.tool.SteamshipImageGenerationTool.html |
488dade076b4-2 | Whether the tool only accepts a single input.
model Config¶
Bases: object
Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | https://api.python.langchain.com/en/latest/tools/langchain.tools.steamship_image_generation.tool.SteamshipImageGenerationTool.html |
190330a24023-0 | langchain.tools.openweathermap.tool.OpenWeatherMapQueryRun¶
class langchain.tools.openweathermap.tool.OpenWeatherMapQueryRun(*, name: str = 'OpenWeatherMap', description: str = 'A wrapper around OpenWeatherMap API. Useful for fetching current weather information for a specified location. Input should be a location stri... | https://api.python.langchain.com/en/latest/tools/langchain.tools.openweathermap.tool.OpenWeatherMapQueryRun.html |
190330a24023-1 | You can provide few-shot examples as a part of the description.
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'OpenWeatherMap'¶
The unique name of the tool that clearly communicates its purpose.
param return... | https://api.python.langchain.com/en/latest/tools/langchain.tools.openweathermap.tool.OpenWeatherMapQueryRun.html |
51eb97385e01-0 | langchain.tools.file_management.file_search.FileSearchInput¶
class langchain.tools.file_management.file_search.FileSearchInput(*, dir_path: str = '.', pattern: str)[source]¶
Bases: BaseModel
Input for FileSearchTool.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.file_search.FileSearchInput.html |
b5c790bcaa93-0 | langchain.tools.requests.tool.BaseRequestsTool¶
class langchain.tools.requests.tool.BaseRequestsTool(*, requests_wrapper: TextRequestsWrapper)[source]¶
Bases: BaseModel
Base class for requests tools.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data... | https://api.python.langchain.com/en/latest/tools/langchain.tools.requests.tool.BaseRequestsTool.html |
4b7ac8a9b05a-0 | langchain.tools.office365.send_event.O365SendEvent¶
class langchain.tools.office365.send_event.O365SendEvent(*, name: str = 'send_event', description: str = 'Use this tool to create and send an event with the provided event fields.', args_schema: ~typing.Type[~langchain.tools.office365.send_event.SendEventSchema] = <cl... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.send_event.O365SendEvent.html |
4b7ac8a9b05a-1 | You can provide few-shot examples as a part of the description.
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'send_event'¶
The unique name of the tool that clearly communicates its purpose.
param return_dir... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.send_event.O365SendEvent.html |
eacfe02f3c11-0 | langchain.tools.playwright.utils.run_async¶
langchain.tools.playwright.utils.run_async(coro: Coroutine[Any, Any, T]) → T[source]¶
Parameters
coro – The coroutine to run. Coroutine[Any, Any, T]
Returns
The result of the coroutine.
Return type
T | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.utils.run_async.html |
6007a3cc3a40-0 | langchain.tools.playwright.navigate.NavigateTool¶
class langchain.tools.playwright.navigate.NavigateTool(*, name: str = 'navigate_browser', description: str = 'Navigate a browser to the specified URL', args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'langchain.tools.playwright.navigate.NavigateToolInput'>,... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.navigate.NavigateTool.html |
6007a3cc3a40-1 | You can provide few-shot examples as a part of the description.
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'navigate_browser'¶
The unique name of the tool that clearly communicates its purpose.
param retu... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.navigate.NavigateTool.html |
6007a3cc3a40-2 | validator validate_browser_provided » all fields¶
Check that the arguments are valid.
property args: dict¶
property is_single_input: bool¶
Whether the tool only accepts a single input.
model Config¶
Bases: object
Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.navigate.NavigateTool.html |
31a306b5103f-0 | langchain.tools.gmail.utils.import_installed_app_flow¶
langchain.tools.gmail.utils.import_installed_app_flow() → InstalledAppFlow[source]¶
Import InstalledAppFlow class.
Returns
InstalledAppFlow class.
Return type
InstalledAppFlow | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.utils.import_installed_app_flow.html |
ecc0fb43a9bf-0 | langchain.tools.base.ToolMetaclass¶
class langchain.tools.base.ToolMetaclass(name: str, bases: Tuple[Type, ...], dct: dict)[source]¶
Bases: ModelMetaclass
Metaclass for BaseTool to ensure the provided args_schema
doesn’t silently ignored.
Create the definition of the new tool class.
Methods
__init__(*args, **kwargs)
mr... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.ToolMetaclass.html |
803beea72f00-0 | langchain.tools.plugin.AIPluginToolSchema¶
class langchain.tools.plugin.AIPluginToolSchema(*, tool_input: Optional[str] = '')[source]¶
Bases: BaseModel
AIPLuginToolSchema.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.plugin.AIPluginToolSchema.html |
56e437df12e9-0 | langchain.tools.vectorstore.tool.VectorStoreQAWithSourcesTool¶
class langchain.tools.vectorstore.tool.VectorStoreQAWithSourcesTool(*, name: str, description: str, args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseC... | https://api.python.langchain.com/en/latest/tools/langchain.tools.vectorstore.tool.VectorStoreQAWithSourcesTool.html |
56e437df12e9-1 | Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
param vectorstore: langchain.vectorstores.base.VectorStore [Required]¶
param verbose: bool = False¶
Whether to log the tool’s progress.
__call__(tool_input: str, callbacks: Option... | https://api.python.langchain.com/en/latest/tools/langchain.tools.vectorstore.tool.VectorStoreQAWithSourcesTool.html |
3cfa70e64490-0 | langchain.tools.plugin.AIPluginTool¶
class langchain.tools.plugin.AIPluginTool(*, name: str, description: str, args_schema: ~typing.Type[~langchain.tools.plugin.AIPluginToolSchema] = <class 'langchain.tools.plugin.AIPluginToolSchema'>, return_direct: bool = False, verbose: bool = False, callbacks: ~typing.Optional[~typ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.plugin.AIPluginTool.html |
3cfa70e64490-1 | Handle the content of the ToolException thrown.
param name: str [Required]¶
The unique name of the tool that clearly communicates its purpose.
param plugin: AIPlugin [Required]¶
param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the... | https://api.python.langchain.com/en/latest/tools/langchain.tools.plugin.AIPluginTool.html |
9f43a9d76fe1-0 | langchain.tools.openapi.utils.api_models.APIOperation¶
class langchain.tools.openapi.utils.api_models.APIOperation(*, operation_id: str, description: Optional[str] = None, base_url: str, path: str, method: HTTPVerb, properties: Sequence[APIProperty], request_body: Optional[APIRequestBody] = None)[source]¶
Bases: BaseMo... | https://api.python.langchain.com/en/latest/tools/langchain.tools.openapi.utils.api_models.APIOperation.html |
23ea98e22d55-0 | langchain.tools.office365.messages_search.SearchEmailsInput¶
class langchain.tools.office365.messages_search.SearchEmailsInput(*, folder: str = None, query: str, max_results: int = 10, truncate: bool = True)[source]¶
Bases: BaseModel
Input for SearchEmails Tool.
Create a new model by parsing and validating input data f... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.messages_search.SearchEmailsInput.html |
0e776462b4a5-0 | langchain.tools.sql_database.tool.ListSQLDatabaseTool¶
class langchain.tools.sql_database.tool.ListSQLDatabaseTool(*, name: str = 'sql_db_list_tables', description: str = 'Input is an empty string, output is a comma separated list of tables in the database.', args_schema: Optional[Type[BaseModel]] = None, return_direct... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.ListSQLDatabaseTool.html |
0e776462b4a5-1 | The unique name of the tool that clearly communicates its purpose.
param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
param verbose: bool = False¶
Whether to log the tool’s progress.
__call__(too... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.ListSQLDatabaseTool.html |
98c101bdddac-0 | langchain.tools.zapier.tool.ZapierNLAListActions¶
class langchain.tools.zapier.tool.ZapierNLAListActions(*, name: str = 'ZapierNLA_list_actions', description: str = 'A wrapper around Zapier NLA actions. The input to this tool is a natural language instruction, for example "get the latest email from my bank" or "send a ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.zapier.tool.ZapierNLAListActions.html |
98c101bdddac-1 | Bases: BaseTool
Returns a list of all exposed (enabled) actions associated withcurrent user (associated with the set api_key). Change your exposed
actions here: https://nla.zapier.com/demo/start/
The return list can be empty if no actions exposed. Else will contain
a list of action objects:
[{“id”: str,
“description”: ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.zapier.tool.ZapierNLAListActions.html |
98c101bdddac-2 | param callbacks: Callbacks = None¶
Callbacks to be called during tool execution.
param description: str = 'A wrapper around Zapier NLA actions. The input to this tool is a natural language instruction, for example "get the latest email from my bank" or "send a slack message to the #general channel". Each tool will have... | https://api.python.langchain.com/en/latest/tools/langchain.tools.zapier.tool.ZapierNLAListActions.html |
98c101bdddac-3 | Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
param verbose: bool = False¶
Whether to log the tool’s progress.
__call__(tool_input: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) → str... | https://api.python.langchain.com/en/latest/tools/langchain.tools.zapier.tool.ZapierNLAListActions.html |
cb54fa5a0a2a-0 | langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksToolInput¶
class langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksToolInput(*, absolute_urls: bool = False)[source]¶
Bases: BaseModel
Input for ExtractHyperlinksTool.
Create a new model by parsing and validating input data from keyword argumen... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksToolInput.html |
1ab44b617d21-0 | langchain.tools.base.SchemaAnnotationError¶
class langchain.tools.base.SchemaAnnotationError[source]¶
Bases: TypeError
Raised when ‘args_schema’ is missing or has an incorrect type annotation.
add_note()¶
Exception.add_note(note) –
add a note to the exception
with_traceback()¶
Exception.with_traceback(tb) –
set self.__... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.SchemaAnnotationError.html |
8ae8b3eff7b9-0 | langchain.tools.playwright.utils.create_sync_playwright_browser¶
langchain.tools.playwright.utils.create_sync_playwright_browser(headless: bool = True) → SyncBrowser[source]¶
Create a playwright browser.
Parameters
headless – Whether to run the browser in headless mode. Defaults to True.
Returns
The playwright browser.... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.utils.create_sync_playwright_browser.html |
96a40036e3e7-0 | langchain.tools.gmail.utils.clean_email_body¶
langchain.tools.gmail.utils.clean_email_body(body: str) → str[source]¶
Clean email body. | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.utils.clean_email_body.html |
5d622f6d8fb6-0 | langchain.tools.gmail.base.GmailBaseTool¶
class langchain.tools.gmail.base.GmailBaseTool(*, name: str, description: str, args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager:... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.base.GmailBaseTool.html |
5d622f6d8fb6-1 | param verbose: bool = False¶
Whether to log the tool’s progress.
__call__(tool_input: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) → str¶
Make tool callable.
async arun(tool_input: Union[str, Dict], verbose: Optional[bool] = None, start_color: Optional[str] = 'green', color: O... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.base.GmailBaseTool.html |
b0313a2e7a6a-0 | langchain.tools.human.tool.HumanInputRun¶
class langchain.tools.human.tool.HumanInputRun(*, name: str = 'human', description: str = 'You can ask a human for guidance when you think you got stuck or you are not sure what to do next. The input should be a question for the human.', args_schema: Optional[Type[BaseModel]] =... | https://api.python.langchain.com/en/latest/tools/langchain.tools.human.tool.HumanInputRun.html |
b0313a2e7a6a-1 | Handle the content of the ToolException thrown.
param input_func: Callable [Optional]¶
param name: str = 'human'¶
The unique name of the tool that clearly communicates its purpose.
param prompt_func: Callable[[str], None] [Optional]¶
param return_direct: bool = False¶
Whether to return the tool’s output directly. Setti... | https://api.python.langchain.com/en/latest/tools/langchain.tools.human.tool.HumanInputRun.html |
2fa19a069afd-0 | langchain.tools.gmail.utils.build_resource_service¶
langchain.tools.gmail.utils.build_resource_service(credentials: Optional[Credentials] = None, service_name: str = 'gmail', service_version: str = 'v1') → Resource[source]¶
Build a Gmail service. | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.utils.build_resource_service.html |
ecb6a96df1f2-0 | langchain.tools.base.StructuredTool¶
class langchain.tools.base.StructuredTool(*, name: str, description: str = '', args_schema: Type[BaseModel], return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallback... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.StructuredTool.html |
ecb6a96df1f2-1 | Handle the content of the ToolException thrown.
param name: str [Required]¶
The unique name of the tool that clearly communicates its purpose.
param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
p... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.StructuredTool.html |
ecb6a96df1f2-2 | Returns
The tool
Examples
… code-block:: python
def add(a: int, b: int) -> int:“””Add two numbers”””
return a + b
tool = StructuredTool.from_function(add)
tool.run(1, 2) # 3
validator raise_deprecation » all fields¶
Raise deprecation warning if callback_manager is used.
run(tool_input: Union[str, Dict], verbose: Opti... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.StructuredTool.html |
4470d5b7dcdc-0 | langchain.tools.gmail.create_draft.CreateDraftSchema¶
class langchain.tools.gmail.create_draft.CreateDraftSchema(*, message: str, to: List[str], subject: str, cc: Optional[List[str]] = None, bcc: Optional[List[str]] = None)[source]¶
Bases: BaseModel
Create a new model by parsing and validating input data from keyword a... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.create_draft.CreateDraftSchema.html |
20a0394d7bd4-0 | langchain.tools.azure_cognitive_services.utils.detect_file_src_type¶
langchain.tools.azure_cognitive_services.utils.detect_file_src_type(file_path: str) → str[source]¶
Detect if the file is local or remote. | https://api.python.langchain.com/en/latest/tools/langchain.tools.azure_cognitive_services.utils.detect_file_src_type.html |
1a1c9e05e029-0 | langchain.tools.wolfram_alpha.tool.WolframAlphaQueryRun¶
class langchain.tools.wolfram_alpha.tool.WolframAlphaQueryRun(*, name: str = 'wolfram_alpha', description: str = 'A wrapper around Wolfram Alpha. Useful for when you need to answer questions about Math, Science, Technology, Culture, Society and Everyday Life. Inp... | https://api.python.langchain.com/en/latest/tools/langchain.tools.wolfram_alpha.tool.WolframAlphaQueryRun.html |
1a1c9e05e029-1 | You can provide few-shot examples as a part of the description.
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'wolfram_alpha'¶
The unique name of the tool that clearly communicates its purpose.
param return_... | https://api.python.langchain.com/en/latest/tools/langchain.tools.wolfram_alpha.tool.WolframAlphaQueryRun.html |
7620d2f2deda-0 | langchain.tools.openapi.utils.api_models.APIPropertyLocation¶
class langchain.tools.openapi.utils.api_models.APIPropertyLocation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases: Enum
The location of the property.
Methods
from_str(location)
Parse an APIPropertyLocation... | https://api.python.langchain.com/en/latest/tools/langchain.tools.openapi.utils.api_models.APIPropertyLocation.html |
bafb77321141-0 | langchain.tools.base.Tool¶
class langchain.tools.base.Tool(name: str, func: Callable, description: str, *, args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[Base... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.Tool.html |
bafb77321141-1 | The unique name of the tool that clearly communicates its purpose.
param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
param verbose: bool = False¶
Whether to log the tool’s progress.
__call__(too... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.Tool.html |
35e37ebd50ec-0 | langchain.tools.plugin.AIPlugin¶
class langchain.tools.plugin.AIPlugin(*, schema_version: str, name_for_model: str, name_for_human: str, description_for_model: str, description_for_human: str, auth: Optional[dict] = None, api: ApiConfig, logo_url: Optional[str] = None, contact_email: Optional[str] = None, legal_info_ur... | https://api.python.langchain.com/en/latest/tools/langchain.tools.plugin.AIPlugin.html |
784d1b60f2f2-0 | langchain.tools.shell.tool.ShellInput¶
class langchain.tools.shell.tool.ShellInput(*, commands: Union[str, List[str]])[source]¶
Bases: BaseModel
Commands for the Bash Shell tool.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.shell.tool.ShellInput.html |
ee7bb5eb19d1-0 | langchain.tools.gmail.send_message.GmailSendMessage¶
class langchain.tools.gmail.send_message.GmailSendMessage(*, name: str = 'send_gmail_message', description: str = 'Use this tool to send email messages. The input is the message, recipents', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.send_message.GmailSendMessage.html |
ee7bb5eb19d1-1 | param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
param verbose: bool = False¶
Whether to log the tool’s progress.
__call__(tool_input: str, callbacks: Optional[Union[List[BaseCallbackHandler], ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.send_message.GmailSendMessage.html |
f2c71f6edc7e-0 | langchain.tools.file_management.utils.get_validated_relative_path¶
langchain.tools.file_management.utils.get_validated_relative_path(root: Path, user_path: str) → Path[source]¶
Resolve a relative path, raising an error if not within the root directory. | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.utils.get_validated_relative_path.html |
a3bd0f3e05ca-0 | langchain.tools.office365.events_search.SearchEventsInput¶
class langchain.tools.office365.events_search.SearchEventsInput(*, start_datetime: str, end_datetime: str, max_results: int = 10, truncate: bool = True)[source]¶
Bases: BaseModel
Input for SearchEmails Tool.
Create a new model by parsing and validating input da... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.events_search.SearchEventsInput.html |
68de6346f386-0 | langchain.tools.json.tool.JsonListKeysTool¶
class langchain.tools.json.tool.JsonListKeysTool(*, name: str = 'json_spec_list_keys', description: str = '\n Can be used to list all keys at a given path. \n Before calling this you should be SURE that the path to this exists.\n The input is a text representation of... | https://api.python.langchain.com/en/latest/tools/langchain.tools.json.tool.JsonListKeysTool.html |
68de6346f386-1 | Used to tell the model how/when/why to use the tool.
You can provide few-shot examples as a part of the description.
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'json_spec_list_keys'¶
The unique name of th... | https://api.python.langchain.com/en/latest/tools/langchain.tools.json.tool.JsonListKeysTool.html |
68de6346f386-2 | model Config¶
Bases: object
Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | https://api.python.langchain.com/en/latest/tools/langchain.tools.json.tool.JsonListKeysTool.html |
313567219375-0 | langchain.tools.gmail.get_message.SearchArgsSchema¶
class langchain.tools.gmail.get_message.SearchArgsSchema(*, message_id: str)[source]¶
Bases: BaseModel
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
para... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.get_message.SearchArgsSchema.html |
ced770a0ba43-0 | langchain.tools.base.BaseTool¶
class langchain.tools.base.BaseTool(*, name: str, description: str, args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallback... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.BaseTool.html |
ced770a0ba43-1 | param verbose: bool = False¶
Whether to log the tool’s progress.
__call__(tool_input: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) → str[source]¶
Make tool callable.
async arun(tool_input: Union[str, Dict], verbose: Optional[bool] = None, start_color: Optional[str] = 'green', ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.BaseTool.html |
820800f79564-0 | langchain.tools.office365.send_event.SendEventSchema¶
class langchain.tools.office365.send_event.SendEventSchema(*, body: str, attendees: List[str], subject: str, start_datetime: str, end_datetime: str)[source]¶
Bases: BaseModel
Input for CreateEvent Tool.
Create a new model by parsing and validating input data from ke... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.send_event.SendEventSchema.html |
8db9b961220a-0 | langchain.tools.google_search.tool.GoogleSearchResults¶
class langchain.tools.google_search.tool.GoogleSearchResults(*, name: str = 'Google Search Results JSON', description: str = 'A wrapper around Google Search. Useful for when you need to answer questions about current events. Input should be a search query. Output ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.google_search.tool.GoogleSearchResults.html |
8db9b961220a-1 | You can provide few-shot examples as a part of the description.
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'Google Search Results JSON'¶
The unique name of the tool that clearly communicates its purpose.
... | https://api.python.langchain.com/en/latest/tools/langchain.tools.google_search.tool.GoogleSearchResults.html |
aca3deae3d40-0 | langchain.tools.playwright.base.lazy_import_playwright_browsers¶
langchain.tools.playwright.base.lazy_import_playwright_browsers() → Tuple[Type[AsyncBrowser], Type[SyncBrowser]][source]¶
Lazy import playwright browsers.
Returns
AsyncBrowser and SyncBrowser classes.
Return type
Tuple[Type[AsyncBrowser], Type[SyncBrowser... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.base.lazy_import_playwright_browsers.html |
3acafb1dcc5f-0 | langchain.tools.spark_sql.tool.ListSparkSQLTool¶
class langchain.tools.spark_sql.tool.ListSparkSQLTool(*, name: str = 'list_tables_sql_db', description: str = 'Input is an empty string, output is a comma separated list of tables in the Spark SQL.', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = Fa... | https://api.python.langchain.com/en/latest/tools/langchain.tools.spark_sql.tool.ListSparkSQLTool.html |
3acafb1dcc5f-1 | The unique name of the tool that clearly communicates its purpose.
param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
param verbose: bool = False¶
Whether to log the tool’s progress.
__call__(too... | https://api.python.langchain.com/en/latest/tools/langchain.tools.spark_sql.tool.ListSparkSQLTool.html |
d5778bb9b95b-0 | langchain.tools.playwright.get_elements.GetElementsToolInput¶
class langchain.tools.playwright.get_elements.GetElementsToolInput(*, selector: str, attributes: List[str] = None)[source]¶
Bases: BaseModel
Input for GetElementsTool.
Create a new model by parsing and validating input data from keyword arguments.
Raises Val... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.get_elements.GetElementsToolInput.html |
e2c6732b9747-0 | langchain.tools.base.create_schema_from_function¶
langchain.tools.base.create_schema_from_function(model_name: str, func: Callable) → Type[BaseModel][source]¶
Create a pydantic schema from a function’s signature.
:param model_name: Name to assign to the generated pydandic schema
:param func: Function to generate the sc... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.create_schema_from_function.html |
cadb816ad37f-0 | langchain.tools.office365.create_draft_message.O365CreateDraftMessage¶
class langchain.tools.office365.create_draft_message.O365CreateDraftMessage(*, name: str = 'create_email_draft', description: str = 'Use this tool to create a draft email with the provided message fields.', args_schema: ~typing.Type[~langchain.tools... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.create_draft_message.O365CreateDraftMessage.html |
cadb816ad37f-1 | Used to tell the model how/when/why to use the tool.
You can provide few-shot examples as a part of the description.
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'create_email_draft'¶
The unique name of the... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.create_draft_message.O365CreateDraftMessage.html |
cadb816ad37f-2 | Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.create_draft_message.O365CreateDraftMessage.html |
f5a1e3f40825-0 | langchain.tools.file_management.list_dir.ListDirectoryTool¶
class langchain.tools.file_management.list_dir.ListDirectoryTool(*, name: str = 'list_directory', description: str = 'List files and directories in a specified folder', args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'langchain.tools.file_manageme... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.list_dir.ListDirectoryTool.html |
f5a1e3f40825-1 | Handle the content of the ToolException thrown.
param name: str = 'list_directory'¶
The unique name of the tool that clearly communicates its purpose.
param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop lo... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.list_dir.ListDirectoryTool.html |
641072d21f79-0 | langchain.tools.convert_to_openai.FunctionDescription¶
class langchain.tools.convert_to_openai.FunctionDescription[source]¶
Bases: TypedDict
Representation of a callable function to the OpenAI API.
Methods
__init__(*args, **kwargs)
clear()
copy()
fromkeys([value])
Create a new dictionary with keys from iterable and val... | https://api.python.langchain.com/en/latest/tools/langchain.tools.convert_to_openai.FunctionDescription.html |
641072d21f79-1 | items() → a set-like object providing a view on D's items¶
keys() → a set-like object providing a view on D's keys¶
pop(k[, d]) → v, remove specified key and return the corresponding value.¶
If the key is not found, return the default if given; otherwise,
raise a KeyError.
popitem()¶
Remove and return a (key, value) pa... | https://api.python.langchain.com/en/latest/tools/langchain.tools.convert_to_openai.FunctionDescription.html |
de3fd1cfd05b-0 | langchain.tools.requests.tool.RequestsPutTool¶
class langchain.tools.requests.tool.RequestsPutTool(*, name: str = 'requests_put', description: str = 'Use this when you want to PUT to a website.\n Input should be a json string with two keys: "url" and "data".\n The value of "url" should be a string, and the value ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.requests.tool.RequestsPutTool.html |
de3fd1cfd05b-1 | param callbacks: Callbacks = None¶
Callbacks to be called during tool execution.
param description: str = 'Use this when you want to PUT to a website.\n Input should be a json string with two keys: "url" and "data".\n The value of "url" should be a string, and the value of "data" should be a dictionary of \n k... | https://api.python.langchain.com/en/latest/tools/langchain.tools.requests.tool.RequestsPutTool.html |
de3fd1cfd05b-2 | Run the tool asynchronously.
validator raise_deprecation » all fields¶
Raise deprecation warning if callback_manager is used.
run(tool_input: Union[str, Dict], verbose: Optional[bool] = None, start_color: Optional[str] = 'green', color: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], Bas... | https://api.python.langchain.com/en/latest/tools/langchain.tools.requests.tool.RequestsPutTool.html |
78d30178399e-0 | langchain.tools.sql_database.tool.InfoSQLDatabaseTool¶
class langchain.tools.sql_database.tool.InfoSQLDatabaseTool(*, name: str = 'sql_db_schema', description: str = '\n Input to this tool is a comma-separated list of tables, output is the schema and sample rows for those tables. \n\n Example Input: "table1, t... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.InfoSQLDatabaseTool.html |
78d30178399e-1 | You can provide few-shot examples as a part of the description.
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'sql_db_schema'¶
The unique name of the tool that clearly communicates its purpose.
param return_... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.InfoSQLDatabaseTool.html |
257e8d119af6-0 | langchain.tools.gmail.get_message.GmailGetMessage¶
class langchain.tools.gmail.get_message.GmailGetMessage(*, name: str = 'get_gmail_message', description: str = 'Use this tool to fetch an email by message ID. Returns the thread ID, snipet, body, subject, and sender.', args_schema: ~typing.Type[~langchain.tools.gmail.g... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.get_message.GmailGetMessage.html |
257e8d119af6-1 | Used to tell the model how/when/why to use the tool.
You can provide few-shot examples as a part of the description.
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'get_gmail_message'¶
The unique name of the ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.get_message.GmailGetMessage.html |
257e8d119af6-2 | Whether the tool only accepts a single input.
model Config¶
Bases: object
Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.get_message.GmailGetMessage.html |
2769f9cfe857-0 | langchain.tools.file_management.delete.FileDeleteInput¶
class langchain.tools.file_management.delete.FileDeleteInput(*, file_path: str)[source]¶
Bases: BaseModel
Input for DeleteFileTool.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be p... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.delete.FileDeleteInput.html |
383b14e0ac25-0 | langchain.tools.graphql.tool.BaseGraphQLTool¶
class langchain.tools.graphql.tool.BaseGraphQLTool(*, name: str = 'query_graphql', description: str = " Input to this tool is a detailed and correct GraphQL query, output is a result from the API.\n If the query is not correct, an error message will be returned.\n ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.graphql.tool.BaseGraphQLTool.html |
383b14e0ac25-1 | param callbacks: Callbacks = None¶
Callbacks to be called during tool execution.
param description: str = " Input to this tool is a detailed and correct GraphQL query, output is a result from the API.\n If the query is not correct, an error message will be returned.\n If an error is returned with 'Bad request'... | https://api.python.langchain.com/en/latest/tools/langchain.tools.graphql.tool.BaseGraphQLTool.html |
383b14e0ac25-2 | Run the tool asynchronously.
validator raise_deprecation » all fields¶
Raise deprecation warning if callback_manager is used.
run(tool_input: Union[str, Dict], verbose: Optional[bool] = None, start_color: Optional[str] = 'green', color: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], Bas... | https://api.python.langchain.com/en/latest/tools/langchain.tools.graphql.tool.BaseGraphQLTool.html |
f77ca96df516-0 | langchain.tools.file_management.list_dir.DirectoryListingInput¶
class langchain.tools.file_management.list_dir.DirectoryListingInput(*, dir_path: str = '.')[source]¶
Bases: BaseModel
Input for ListDirectoryTool.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if th... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.list_dir.DirectoryListingInput.html |
be24ee64c191-0 | langchain.tools.requests.tool.RequestsGetTool¶
class langchain.tools.requests.tool.RequestsGetTool(*, name: str = 'requests_get', description: str = 'A portal to the internet. Use this when you need to get specific content from a website. Input should be a url (i.e. https://www.google.com). The output will be the text... | https://api.python.langchain.com/en/latest/tools/langchain.tools.requests.tool.RequestsGetTool.html |
be24ee64c191-1 | You can provide few-shot examples as a part of the description.
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'requests_get'¶
The unique name of the tool that clearly communicates its purpose.
param requests... | https://api.python.langchain.com/en/latest/tools/langchain.tools.requests.tool.RequestsGetTool.html |
5b6d8fc7adaa-0 | langchain.tools.base.ToolException¶
class langchain.tools.base.ToolException[source]¶
Bases: Exception
An optional exception that tool throws when execution error occurs.
When this exception is thrown, the agent will not stop working,
but will handle the exception according to the handle_tool_error
variable of the tool... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.ToolException.html |
19927ce71ff9-0 | langchain.tools.ifttt.IFTTTWebhook¶
class langchain.tools.ifttt.IFTTTWebhook(*, name: str, description: str, args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[Ba... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ifttt.IFTTTWebhook.html |
19927ce71ff9-1 | that after the tool is called, the AgentExecutor will stop looping.
param url: str [Required]¶
param verbose: bool = False¶
Whether to log the tool’s progress.
__call__(tool_input: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) → str¶
Make tool callable.
async arun(tool_input: U... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ifttt.IFTTTWebhook.html |
74dde3e2deb2-0 | langchain.tools.sql_database.tool.QuerySQLCheckerTool¶
class langchain.tools.sql_database.tool.QuerySQLCheckerTool(*, name: str = 'sql_db_query_checker', description: str = '\n Use this tool to double check if your query is correct before executing it.\n Always use this tool before executing a query with query_sq... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLCheckerTool.html |
74dde3e2deb2-1 | param args_schema: Optional[Type[BaseModel]] = None¶
Pydantic model class to validate and parse the tool’s input arguments.
param callback_manager: Optional[BaseCallbackManager] = None¶
Deprecated. Please use callbacks instead.
param callbacks: Callbacks = None¶
Callbacks to be called during tool execution.
param db: S... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLCheckerTool.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.