id stringlengths 14 15 | text stringlengths 35 2.51k | source stringlengths 61 154 |
|---|---|---|
407d88da65b2-0 | langchain.tools.arxiv.tool.ArxivQueryRun¶
class langchain.tools.arxiv.tool.ArxivQueryRun(*, name: str = 'arxiv', description: str = 'A wrapper around Arxiv.org Useful for when you need to answer questions about Physics, Mathematics, Computer Science, Quantitative Biology, Quantitative Finance, Statistics, Electrical En... | https://api.python.langchain.com/en/latest/tools/langchain.tools.arxiv.tool.ArxivQueryRun.html |
407d88da65b2-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 = 'arxiv'¶
The unique name of the tool that cl... | https://api.python.langchain.com/en/latest/tools/langchain.tools.arxiv.tool.ArxivQueryRun.html |
407d88da65b2-2 | Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | https://api.python.langchain.com/en/latest/tools/langchain.tools.arxiv.tool.ArxivQueryRun.html |
add186482fba-0 | langchain.tools.office365.base.O365BaseTool¶
class langchain.tools.office365.base.O365BaseTool(*, 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_ma... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.base.O365BaseTool.html |
add186482fba-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.office365.base.O365BaseTool.html |
f84c44ab5739-0 | langchain.tools.spark_sql.tool.QuerySparkSQLTool¶
class langchain.tools.spark_sql.tool.QuerySparkSQLTool(*, name: str = 'query_sql_db', description: str = '\n Input to this tool is a detailed and correct SQL query, output is a result from the Spark SQL.\n If the query is not correct, an error message will be retu... | https://api.python.langchain.com/en/latest/tools/langchain.tools.spark_sql.tool.QuerySparkSQLTool.html |
f84c44ab5739-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 = 'query_sql_db'¶
The unique name of the tool ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.spark_sql.tool.QuerySparkSQLTool.html |
f84c44ab5739-2 | Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | https://api.python.langchain.com/en/latest/tools/langchain.tools.spark_sql.tool.QuerySparkSQLTool.html |
f3f054b50afa-0 | langchain.tools.google_places.tool.GooglePlacesSchema¶
class langchain.tools.google_places.tool.GooglePlacesSchema(*, query: 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.
par... | https://api.python.langchain.com/en/latest/tools/langchain.tools.google_places.tool.GooglePlacesSchema.html |
079bf210ee6e-0 | langchain.tools.json.tool.JsonSpec¶
class langchain.tools.json.tool.JsonSpec(*, dict_: Dict, max_value_length: int = 200)[source]¶
Bases: BaseModel
Base class for JSON spec.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.json.tool.JsonSpec.html |
f7ff6aa88ebf-0 | langchain.tools.file_management.write.WriteFileTool¶
class langchain.tools.file_management.write.WriteFileTool(*, name: str = 'write_file', description: str = 'Write file to disk', args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'langchain.tools.file_management.write.WriteFileInput'>, return_direct: bool =... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.write.WriteFileTool.html |
f7ff6aa88ebf-1 | Handle the content of the ToolException thrown.
param name: str = 'write_file'¶
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 loopin... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.write.WriteFileTool.html |
a563c8c717a5-0 | langchain.tools.interaction.tool.StdInInquireTool¶
langchain.tools.interaction.tool.StdInInquireTool(*args: Any, **kwargs: Any) → HumanInputRun[source]¶
Tool for asking the user for input. | https://api.python.langchain.com/en/latest/tools/langchain.tools.interaction.tool.StdInInquireTool.html |
d0959c5dc470-0 | langchain.tools.office365.messages_search.O365SearchEmails¶
class langchain.tools.office365.messages_search.O365SearchEmails(*, name: str = 'messages_search', description: str = 'Use this tool to search for email messages. The input must be a valid Microsoft Graph v1.0 $search query. The output is a JSON list of the re... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.messages_search.O365SearchEmails.html |
d0959c5dc470-1 | param callbacks: Callbacks = None¶
Callbacks to be called during tool execution.
param description: str = 'Use this tool to search for email messages. The input must be a valid Microsoft Graph v1.0 $search query. The output is a JSON list of the requested resource.'¶
Used to tell the model how/when/why to use the tool.... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.messages_search.O365SearchEmails.html |
d0959c5dc470-2 | Run the tool.
property args: dict¶
property is_single_input: bool¶
Whether the tool only accepts a single input.
model Config[source]¶
Bases: object
Configuration for this pydantic object.
extra = 'forbid'¶ | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.messages_search.O365SearchEmails.html |
f10e58a397e9-0 | langchain.tools.sql_database.tool.QuerySQLDataBaseTool¶
class langchain.tools.sql_database.tool.QuerySQLDataBaseTool(*, name: str = 'sql_db_query', description: str = '\n Input to this tool is a detailed and correct SQL query, output is a result from the database.\n If the query is not correct, an error message w... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLDataBaseTool.html |
f10e58a397e9-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 = 'sql_db_query'¶
The unique name of the tool ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLDataBaseTool.html |
f10e58a397e9-2 | Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLDataBaseTool.html |
eba70dad06da-0 | langchain.tools.spark_sql.tool.InfoSparkSQLTool¶
class langchain.tools.spark_sql.tool.InfoSparkSQLTool(*, name: str = 'schema_sql_db', 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 Be sure that the tables actually exist by c... | https://api.python.langchain.com/en/latest/tools/langchain.tools.spark_sql.tool.InfoSparkSQLTool.html |
eba70dad06da-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 = 'schema_sql_db'¶
The unique name of the tool... | https://api.python.langchain.com/en/latest/tools/langchain.tools.spark_sql.tool.InfoSparkSQLTool.html |
eba70dad06da-2 | Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | https://api.python.langchain.com/en/latest/tools/langchain.tools.spark_sql.tool.InfoSparkSQLTool.html |
879d61af4c35-0 | langchain.tools.searx_search.tool.SearxSearchRun¶
class langchain.tools.searx_search.tool.SearxSearchRun(*, name: str = 'searx_search', description: str = 'A meta search engine.Useful for when you need to answer questions about current events.Input should be a search query.', args_schema: Optional[Type[BaseModel]] = No... | https://api.python.langchain.com/en/latest/tools/langchain.tools.searx_search.tool.SearxSearchRun.html |
879d61af4c35-1 | Handle the content of the ToolException thrown.
param kwargs: dict [Optional]¶
param name: str = 'searx_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, t... | https://api.python.langchain.com/en/latest/tools/langchain.tools.searx_search.tool.SearxSearchRun.html |
7e39345174dd-0 | langchain.tools.file_management.delete.DeleteFileTool¶
class langchain.tools.file_management.delete.DeleteFileTool(*, name: str = 'file_delete', description: str = 'Delete a file', args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'langchain.tools.file_management.delete.FileDeleteInput'>, return_direct: bool... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.delete.DeleteFileTool.html |
7e39345174dd-1 | Handle the content of the ToolException thrown.
param name: str = 'file_delete'¶
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.file_management.delete.DeleteFileTool.html |
e6ffc6963f97-0 | langchain.tools.zapier.tool.ZapierNLARunAction¶ | https://api.python.langchain.com/en/latest/tools/langchain.tools.zapier.tool.ZapierNLARunAction.html |
e6ffc6963f97-1 | class langchain.tools.zapier.tool.ZapierNLARunAction(*, 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[BaseCallbackMana... | https://api.python.langchain.com/en/latest/tools/langchain.tools.zapier.tool.ZapierNLARunAction.html |
e6ffc6963f97-2 | Bases: BaseTool
Executes an action that is identified by action_id, must be exposed(enabled) by the current user (associated with the set api_key). Change
your exposed actions here: https://nla.zapier.com/demo/start/
The return JSON is guaranteed to be less than ~500 words (350
tokens) making it safe to inject into the... | https://api.python.langchain.com/en/latest/tools/langchain.tools.zapier.tool.ZapierNLARunAction.html |
e6ffc6963f97-3 | Pydantic model class to validate and parse the tool’s input arguments.
param base_prompt: 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 params as... | https://api.python.langchain.com/en/latest/tools/langchain.tools.zapier.tool.ZapierNLARunAction.html |
e6ffc6963f97-4 | param params: Optional[dict] = None¶
param params_schema: Dict[str, str] [Optional]¶
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 prog... | https://api.python.langchain.com/en/latest/tools/langchain.tools.zapier.tool.ZapierNLARunAction.html |
30341d736689-0 | langchain.tools.wikipedia.tool.WikipediaQueryRun¶
class langchain.tools.wikipedia.tool.WikipediaQueryRun(*, name: str = 'Wikipedia', description: str = 'A wrapper around Wikipedia. Useful for when you need to answer general questions about people, places, companies, facts, historical events, or other subjects. Input sh... | https://api.python.langchain.com/en/latest/tools/langchain.tools.wikipedia.tool.WikipediaQueryRun.html |
30341d736689-1 | Handle the content of the ToolException thrown.
param name: str = 'Wikipedia'¶
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... | https://api.python.langchain.com/en/latest/tools/langchain.tools.wikipedia.tool.WikipediaQueryRun.html |
6409cc6e595b-0 | langchain.tools.requests.tool.RequestsPatchTool¶
class langchain.tools.requests.tool.RequestsPatchTool(*, name: str = 'requests_patch', description: str = 'Use this when you want to PATCH 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 th... | https://api.python.langchain.com/en/latest/tools/langchain.tools.requests.tool.RequestsPatchTool.html |
6409cc6e595b-1 | param callbacks: Callbacks = None¶
Callbacks to be called during tool execution.
param description: str = 'Use this when you want to PATCH 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 ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.requests.tool.RequestsPatchTool.html |
6409cc6e595b-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.RequestsPatchTool.html |
70c9ff85bfe7-0 | langchain.tools.playwright.utils.get_current_page¶
langchain.tools.playwright.utils.get_current_page(browser: SyncBrowser) → SyncPage[source]¶
Get the current page of the browser.
:param browser: The browser to get the current page from.
Returns
The current page.
Return type
SyncPage | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.utils.get_current_page.html |
c0df04529b0b-0 | langchain.tools.google_places.tool.GooglePlacesTool¶
class langchain.tools.google_places.tool.GooglePlacesTool(*, name: str = 'google_places', description: str = 'A wrapper around Google Places. Useful for when you need to validate or discover addressed from ambiguous text. Input should be a search query.', args_schema... | https://api.python.langchain.com/en/latest/tools/langchain.tools.google_places.tool.GooglePlacesTool.html |
c0df04529b0b-1 | param callbacks: Callbacks = None¶
Callbacks to be called during tool execution.
param description: str = 'A wrapper around Google Places. Useful for when you need to validate or discover addressed from ambiguous text. Input should be a search query.'¶
Used to tell the model how/when/why to use the tool.
You can provid... | https://api.python.langchain.com/en/latest/tools/langchain.tools.google_places.tool.GooglePlacesTool.html |
c0df04529b0b-2 | Run the tool.
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.google_places.tool.GooglePlacesTool.html |
bbb9b4819898-0 | langchain.tools.azure_cognitive_services.form_recognizer.AzureCogsFormRecognizerTool¶
class langchain.tools.azure_cognitive_services.form_recognizer.AzureCogsFormRecognizerTool(*, name: str = 'azure_cognitive_services_form_recognizer', description: str = 'A wrapper around Azure Cognitive Services Form Recognizer. Usefu... | https://api.python.langchain.com/en/latest/tools/langchain.tools.azure_cognitive_services.form_recognizer.AzureCogsFormRecognizerTool.html |
bbb9b4819898-1 | param callbacks: Callbacks = None¶
Callbacks to be called during tool execution.
param description: str = 'A wrapper around Azure Cognitive Services Form Recognizer. Useful for when you need to extract text, tables, and key-value pairs from documents. Input should be a url to a document.'¶
Used to tell the model how/wh... | https://api.python.langchain.com/en/latest/tools/langchain.tools.azure_cognitive_services.form_recognizer.AzureCogsFormRecognizerTool.html |
bbb9b4819898-2 | 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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool.
validator ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.azure_cognitive_services.form_recognizer.AzureCogsFormRecognizerTool.html |
78ba0f37aa7f-0 | langchain.tools.requests.tool.RequestsPostTool¶
class langchain.tools.requests.tool.RequestsPostTool(*, name: str = 'requests_post', description: str = 'Use this when you want to POST 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 va... | https://api.python.langchain.com/en/latest/tools/langchain.tools.requests.tool.RequestsPostTool.html |
78ba0f37aa7f-1 | param callbacks: Callbacks = None¶
Callbacks to be called during tool execution.
param description: str = 'Use this when you want to POST 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 ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.requests.tool.RequestsPostTool.html |
78ba0f37aa7f-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.RequestsPostTool.html |
64c85c1c39dc-0 | langchain.tools.office365.send_message.O365SendMessage¶
class langchain.tools.office365.send_message.O365SendMessage(*, name: str = 'send_email', description: str = 'Use this tool to send an email with the provided message fields.', args_schema: ~typing.Type[~langchain.tools.office365.send_message.SendMessageSchema] = ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.send_message.O365SendMessage.html |
64c85c1c39dc-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_email'¶
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_message.O365SendMessage.html |
f01e044cf7b9-0 | langchain.tools.gmail.search.Resource¶
class langchain.tools.gmail.search.Resource(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases: str, Enum
Enumerator of Resources to search.
Methods
__init__(*args, **kwds)
capitalize()
Return a capitalized version of the string.
ca... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.search.Resource.html |
f01e044cf7b9-1 | Return True if the string is a decimal string, False otherwise.
isdigit()
Return True if the string is a digit string, False otherwise.
isidentifier()
Return True if the string is a valid Python identifier, False otherwise.
islower()
Return True if the string is a lowercase string, False otherwise.
isnumeric()
Return T... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.search.Resource.html |
f01e044cf7b9-2 | rjust(width[, fillchar])
Return a right-justified string of length width.
rpartition(sep, /)
Partition the string into three parts using the given separator.
rsplit([sep, maxsplit])
Return a list of the substrings in the string, using sep as the separator string.
rstrip([chars])
Return a copy of the string with trailin... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.search.Resource.html |
f01e044cf7b9-3 | Return the number of non-overlapping occurrences of substring sub in
string S[start:end]. Optional arguments start and end are
interpreted as in slice notation.
encode(encoding='utf-8', errors='strict')¶
Encode the string using the codec registered for encoding.
encodingThe encoding in which to encode the string.
erro... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.search.Resource.html |
f01e044cf7b9-4 | Return the lowest index in S where substring sub is found,
such that sub is contained within S[start:end]. Optional
arguments start and end are interpreted as in slice notation.
Raises ValueError when the substring is not found.
isalnum()¶
Return True if the string is an alpha-numeric string, False otherwise.
A string... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.search.Resource.html |
f01e044cf7b9-5 | isnumeric()¶
Return True if the string is a numeric string, False otherwise.
A string is numeric if all characters in the string are numeric and there is at
least one character in the string.
isprintable()¶
Return True if the string is printable, False otherwise.
A string is printable if all of its characters are consi... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.search.Resource.html |
f01e044cf7b9-6 | static maketrans()¶
Return a translation table usable for str.translate().
If there is only one argument, it must be a dictionary mapping Unicode
ordinals (integers) or characters to Unicode ordinals, strings or None.
Character keys will be then converted to ordinals.
If there are two arguments, they must be strings of... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.search.Resource.html |
f01e044cf7b9-7 | replaced.
rfind(sub[, start[, end]]) → int¶
Return the highest index in S where substring sub is found,
such that sub is contained within S[start:end]. Optional
arguments start and end are interpreted as in slice notation.
Return -1 on failure.
rindex(sub[, start[, end]]) → int¶
Return the highest index in S where sub... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.search.Resource.html |
f01e044cf7b9-8 | rstrip(chars=None, /)¶
Return a copy of the string with trailing whitespace removed.
If chars is given and not None, remove characters in chars instead.
split(sep=None, maxsplit=- 1)¶
Return a list of the substrings in the string, using sep as the separator string.
sepThe separator used to split the string.
When set to... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.search.Resource.html |
f01e044cf7b9-9 | translate(table, /)¶
Replace each character in the string using the given translation table.
tableTranslation table, which must be a mapping of Unicode ordinals to
Unicode ordinals, strings, or None.
The table must implement lookup/indexing via __getitem__, for instance a
dictionary or list. If this operation raises L... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.search.Resource.html |
f126d52441c8-0 | langchain.tools.playwright.get_elements.GetElementsTool¶
class langchain.tools.playwright.get_elements.GetElementsTool(*, name: str = 'get_elements', description: str = 'Retrieve elements in the current web page matching the given CSS selector', args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'langchain.to... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.get_elements.GetElementsTool.html |
f126d52441c8-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 = 'get_elements'¶
The unique name of the tool that clearly communicates its purpose.
param return_d... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.get_elements.GetElementsTool.html |
f126d52441c8-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.get_elements.GetElementsTool.html |
322beb3674f0-0 | langchain.tools.gmail.utils.get_gmail_credentials¶
langchain.tools.gmail.utils.get_gmail_credentials(token_file: Optional[str] = None, client_secrets_file: Optional[str] = None, scopes: Optional[List[str]] = None) → Credentials[source]¶
Get credentials. | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.utils.get_gmail_credentials.html |
b610c073ab84-0 | langchain.tools.file_management.utils.is_relative_to¶
langchain.tools.file_management.utils.is_relative_to(path: Path, root: Path) → bool[source]¶
Check if path is relative to root. | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.utils.is_relative_to.html |
eb6f5c7bf062-0 | langchain.tools.office365.send_message.SendMessageSchema¶
class langchain.tools.office365.send_message.SendMessageSchema(*, body: 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 keyw... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.send_message.SendMessageSchema.html |
7ad9557d21e0-0 | langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool¶
class langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool(*, name: str = 'extract_hyperlinks', description: str = 'Extract all hyperlinks on the current webpage', args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'langchain.... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool.html |
7ad9557d21e0-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 = 'extract_hyperlinks'¶
The unique name of the... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool.html |
7ad9557d21e0-2 | 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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool.
static scr... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool.html |
212826fcdf0f-0 | langchain.tools.office365.events_search.O365SearchEvents¶
class langchain.tools.office365.events_search.O365SearchEvents(*, name: str = 'events_search', description: str = " Use this tool to search for the user's calendar events. The input must be the start and end datetimes for the search query. The output is a JSON l... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.events_search.O365SearchEvents.html |
212826fcdf0f-1 | param callback_manager: Optional[BaseCallbackManager] = None¶
Deprecated. Please use callbacks instead.
param callbacks: Callbacks = None¶
Callbacks to be called during tool execution.
param description: str = " Use this tool to search for the user's calendar events. The input must be the start and end datetimes for th... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.events_search.O365SearchEvents.html |
212826fcdf0f-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.office365.events_search.O365SearchEvents.html |
4d76b731c0b0-0 | langchain.tools.gmail.send_message.SendMessageSchema¶
class langchain.tools.gmail.send_message.SendMessageSchema(*, message: str, to: Union[str, List[str]], subject: str, cc: Optional[Union[str, List[str]]] = None, bcc: Optional[Union[str, List[str]]] = None)[source]¶
Bases: BaseModel
Create a new model by parsing and ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.send_message.SendMessageSchema.html |
3e2de549bc13-0 | langchain.tools.gmail.utils.import_googleapiclient_resource_builder¶
langchain.tools.gmail.utils.import_googleapiclient_resource_builder() → build_resource[source]¶
Import googleapiclient.discovery.build function.
Returns
googleapiclient.discovery.build function.
Return type
build_resource | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.utils.import_googleapiclient_resource_builder.html |
a3808a30335d-0 | langchain.tools.file_management.copy.FileCopyInput¶
class langchain.tools.file_management.copy.FileCopyInput(*, source_path: str, destination_path: str)[source]¶
Bases: BaseModel
Input for CopyFileTool.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input d... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.copy.FileCopyInput.html |
10346feac473-0 | langchain.tools.playwright.click.ClickToolInput¶
class langchain.tools.playwright.click.ClickToolInput(*, selector: str)[source]¶
Bases: BaseModel
Input for ClickTool.
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 vali... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.click.ClickToolInput.html |
049631c8c1c9-0 | langchain.tools.plugin.ApiConfig¶
class langchain.tools.plugin.ApiConfig(*, type: str, url: str, has_user_authentication: Optional[bool] = False)[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 ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.plugin.ApiConfig.html |
f22d07b7fdc3-0 | langchain.tools.file_management.copy.CopyFileTool¶
class langchain.tools.file_management.copy.CopyFileTool(*, name: str = 'copy_file', description: str = 'Create a copy of a file in a specified location', args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'langchain.tools.file_management.copy.FileCopyInput'>,... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.copy.CopyFileTool.html |
f22d07b7fdc3-1 | Handle the content of the ToolException thrown.
param name: str = 'copy_file'¶
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... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.copy.CopyFileTool.html |
abb3f2c66c2b-0 | langchain.tools.youtube.search.YouTubeSearchTool¶
class langchain.tools.youtube.search.YouTubeSearchTool(*, name: str = 'youtube_search', description: str = 'search for youtube videos associated with a person. the input to this tool should be a comma separated list, the first part contains a person name and the second ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.youtube.search.YouTubeSearchTool.html |
abb3f2c66c2b-1 | Handle the content of the ToolException thrown.
param name: str = 'youtube_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 lo... | https://api.python.langchain.com/en/latest/tools/langchain.tools.youtube.search.YouTubeSearchTool.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.