id
stringlengths 14
15
| text
stringlengths 35
2.07k
| embedding
sequence | source
stringlengths 61
154
|
|---|---|---|---|
9bc3c10c10d1-0 | langchain.tools.playwright.navigate_back.NavigateBackTool¶
class langchain.tools.playwright.navigate_back.NavigateBackTool(*, name: str = 'previous_webpage', description: str = 'Navigate back to the previous page in the browser history', args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'pydantic.main.BaseModel'>, return_direct: bool = False, verbose: bool = False, callbacks: ~typing.Optional[~typing.Union[~typing.List[~langchain.callbacks.base.BaseCallbackHandler], ~langchain.callbacks.base.BaseCallbackManager]] = None, callback_manager: ~typing.Optional[~langchain.callbacks.base.BaseCallbackManager] = None, handle_tool_error: ~typing.Optional[~typing.Union[bool, str, ~typing.Callable[[~langchain.tools.base.ToolException], str]]] = False, sync_browser: Optional['SyncBrowser'] = None, async_browser: Optional['AsyncBrowser'] = None)[source]¶
Bases: BaseBrowserTool
Navigate back to the previous page in the browser history.
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.
param args_schema: Type[BaseModel] = <class 'pydantic.main.BaseModel'>¶
Pydantic model class to validate and parse the tool’s input arguments.
param async_browser: Optional['AsyncBrowser'] = None¶
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 = 'Navigate back to the previous page in the browser history'¶
Used to tell the model how/when/why to use the tool.
You can provide few-shot examples as a part of the description. | [
5317,
8995,
24029,
13269,
53852,
19452,
3982,
74794,
3792,
7896,
55609,
198,
1058,
8859,
8995,
24029,
13269,
53852,
19452,
3982,
74794,
3792,
7896,
4163,
11,
836,
25,
610,
284,
364,
20281,
27050,
2964,
518,
4096,
25,
610,
284,
364,
74382,
1203,
311,
279,
3766,
2199,
304,
279,
7074,
3925,
518,
2897,
26443,
25,
4056,
90902,
10394,
58,
93,
3368,
67,
8322,
9056,
13316,
1747,
60,
284,
366,
1058,
364,
3368,
67,
8322,
9056,
13316,
1747,
6404,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
93,
90902,
5937,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
3126,
1145,
4056,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
4056,
90902,
37464,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
2707,
11,
610,
11,
4056,
90902,
28115,
481,
15873,
93,
5317,
8995,
24029,
9105,
25443,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
13105,
54514,
25,
12536,
681,
12430,
18360,
663,
284,
2290,
11,
3393,
54514,
25,
12536,
681,
6662,
18360,
663,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
18360,
7896,
198,
74382,
1203,
311,
279,
3766,
2199,
304,
279,
7074,
3925,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
4078,
58,
4066,
1747,
60,
284,
366,
1058,
364,
3368,
67,
8322,
9056,
13316,
1747,
6404,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
3393,
54514,
25,
12536,
681,
6662,
18360,
663,
284,
2290,
55609,
198,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
74382,
1203,
311,
279,
3766,
2199,
304,
279,
7074,
3925,
6,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.navigate_back.NavigateBackTool.html |
9bc3c10c10d1-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 = 'previous_webpage'¶
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 sync_browser: Optional['SyncBrowser'] = None¶
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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool asynchronously.
classmethod from_browser(sync_browser: Optional[SyncBrowser] = None, async_browser: Optional[AsyncBrowser] = None) → BaseBrowserTool¶
Instantiate the tool.
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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool.
validator validate_browser_provided » all fields¶
Check that the arguments are valid. | [
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
20281,
27050,
2964,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
13105,
54514,
25,
12536,
681,
12430,
18360,
663,
284,
2290,
55609,
198,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
27853,
505,
54514,
98333,
54514,
25,
12536,
58,
12430,
18360,
60,
284,
2290,
11,
3393,
54514,
25,
12536,
58,
6662,
18360,
60,
284,
2290,
8,
11651,
5464,
18360,
7896,
55609,
198,
81651,
279,
5507,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
16503,
9788,
54514,
2602,
44057,
4194,
8345,
4194,
682,
5151,
55609,
198,
4061,
430,
279,
6105,
527,
2764,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.navigate_back.NavigateBackTool.html |
9bc3c10c10d1-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'¶ | [
16503,
9788,
54514,
2602,
44057,
4194,
8345,
4194,
682,
5151,
55609,
198,
4061,
430,
279,
6105,
527,
2764,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.navigate_back.NavigateBackTool.html |
35570cca15a6-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[~typing.Union[~typing.List[~langchain.callbacks.base.BaseCallbackHandler], ~langchain.callbacks.base.BaseCallbackManager]] = None, callback_manager: ~typing.Optional[~langchain.callbacks.base.BaseCallbackManager] = None, handle_tool_error: ~typing.Optional[~typing.Union[bool, str, ~typing.Callable[[~langchain.tools.base.ToolException], str]]] = False, plugin: ~langchain.tools.plugin.AIPlugin, api_spec: str)[source]¶
Bases: BaseTool
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.
param api_spec: str [Required]¶
param args_schema: Type[AIPluginToolSchema] = <class 'langchain.tools.plugin.AIPluginToolSchema'>¶
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 description: str [Required]¶
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 [Required]¶ | [
5317,
8995,
24029,
28067,
89878,
11807,
7896,
55609,
198,
1058,
8859,
8995,
24029,
28067,
89878,
11807,
7896,
4163,
11,
836,
25,
610,
11,
4096,
25,
610,
11,
2897,
26443,
25,
4056,
90902,
10394,
58,
93,
5317,
8995,
24029,
28067,
89878,
11807,
7896,
8802,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
28067,
89878,
11807,
7896,
8802,
6404,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
93,
90902,
5937,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
3126,
1145,
4056,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
4056,
90902,
37464,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
2707,
11,
610,
11,
4056,
90902,
28115,
481,
15873,
93,
5317,
8995,
24029,
9105,
25443,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
9183,
25,
4056,
5317,
8995,
24029,
28067,
89878,
11807,
11,
6464,
13908,
25,
610,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
6464,
13908,
25,
610,
510,
8327,
60,
55609,
198,
913,
2897,
26443,
25,
4078,
58,
15836,
11807,
7896,
8802,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
28067,
89878,
11807,
7896,
8802,
6404,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
510,
8327,
60,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
510,
8327,
60,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.plugin.AIPluginTool.html |
35570cca15a6-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 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¶
Make tool callable.
async arun(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 asynchronously.
classmethod from_plugin_url(url: str) → AIPluginTool[source]¶
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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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'¶ | [
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
510,
8327,
60,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
9183,
25,
15592,
11807,
510,
8327,
60,
55609,
198,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
27853,
505,
23982,
2975,
6659,
25,
610,
8,
11651,
15592,
11807,
7896,
76747,
60,
55609,
198,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.plugin.AIPluginTool.html |
33cf8050cbd1-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.tools.playwright.get_elements.GetElementsToolInput'>, return_direct: bool = False, verbose: bool = False, callbacks: ~typing.Optional[~typing.Union[~typing.List[~langchain.callbacks.base.BaseCallbackHandler], ~langchain.callbacks.base.BaseCallbackManager]] = None, callback_manager: ~typing.Optional[~langchain.callbacks.base.BaseCallbackManager] = None, handle_tool_error: ~typing.Optional[~typing.Union[bool, str, ~typing.Callable[[~langchain.tools.base.ToolException], str]]] = False, sync_browser: Optional['SyncBrowser'] = None, async_browser: Optional['AsyncBrowser'] = None)[source]¶
Bases: BaseBrowserTool
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.
param args_schema: Type[BaseModel] = <class 'langchain.tools.playwright.get_elements.GetElementsToolInput'>¶
Pydantic model class to validate and parse the tool’s input arguments.
param async_browser: Optional['AsyncBrowser'] = None¶
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 = 'Retrieve elements in the current web page matching the given CSS selector'¶
Used to tell the model how/when/why to use the tool. | [
5317,
8995,
24029,
13269,
53852,
673,
23646,
2283,
12132,
7896,
55609,
198,
1058,
8859,
8995,
24029,
13269,
53852,
673,
23646,
2283,
12132,
7896,
4163,
11,
836,
25,
610,
284,
364,
456,
23646,
518,
4096,
25,
610,
284,
364,
88765,
5540,
304,
279,
1510,
3566,
2199,
12864,
279,
2728,
15533,
9551,
518,
2897,
26443,
25,
4056,
90902,
10394,
58,
93,
3368,
67,
8322,
9056,
13316,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
13269,
53852,
673,
23646,
2283,
12132,
7896,
2566,
6404,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
93,
90902,
5937,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
3126,
1145,
4056,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
4056,
90902,
37464,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
2707,
11,
610,
11,
4056,
90902,
28115,
481,
15873,
93,
5317,
8995,
24029,
9105,
25443,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
13105,
54514,
25,
12536,
681,
12430,
18360,
663,
284,
2290,
11,
3393,
54514,
25,
12536,
681,
6662,
18360,
663,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
18360,
7896,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
4078,
58,
4066,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
13269,
53852,
673,
23646,
2283,
12132,
7896,
2566,
6404,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
3393,
54514,
25,
12536,
681,
6662,
18360,
663,
284,
2290,
55609,
198,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
88765,
5540,
304,
279,
1510,
3566,
2199,
12864,
279,
2728,
15533,
9551,
6,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.get_elements.GetElementsTool.html |
33cf8050cbd1-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_elements'¶
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 sync_browser: Optional['SyncBrowser'] = None¶
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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool asynchronously.
classmethod from_browser(sync_browser: Optional[SyncBrowser] = None, async_browser: Optional[AsyncBrowser] = None) → BaseBrowserTool¶
Instantiate the tool.
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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool. | [
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
456,
23646,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
13105,
54514,
25,
12536,
681,
12430,
18360,
663,
284,
2290,
55609,
198,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
27853,
505,
54514,
98333,
54514,
25,
12536,
58,
12430,
18360,
60,
284,
2290,
11,
3393,
54514,
25,
12536,
58,
6662,
18360,
60,
284,
2290,
8,
11651,
5464,
18360,
7896,
55609,
198,
81651,
279,
5507,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.get_elements.GetElementsTool.html |
33cf8050cbd1-2 | Run the tool.
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'¶ | [
6869,
279,
5507,
627,
16503,
9788,
54514,
2602,
44057,
4194,
8345,
4194,
682,
5151,
55609,
198,
4061,
430,
279,
6105,
527,
2764,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.get_elements.GetElementsTool.html |
afb39de2f776-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 is a JSON array of the query results', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, num_results: int = 4, api_wrapper: GoogleSearchAPIWrapper)[source]¶
Bases: BaseTool
Tool that has capability to query the Google Search API and get back json.
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.
param api_wrapper: langchain.utilities.google_search.GoogleSearchAPIWrapper [Required]¶
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 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 is a JSON array of the query results'¶
Used to tell the model how/when/why to use the tool.
You can provide few-shot examples as a part of the description. | [
5317,
8995,
24029,
5831,
10947,
21966,
61493,
6014,
10001,
55609,
198,
1058,
8859,
8995,
24029,
5831,
10947,
21966,
61493,
6014,
10001,
4163,
11,
836,
25,
610,
284,
364,
14783,
7694,
18591,
4823,
518,
4096,
25,
610,
284,
364,
32,
13564,
2212,
5195,
7694,
13,
51612,
369,
994,
499,
1205,
311,
4320,
4860,
922,
1510,
4455,
13,
5688,
1288,
387,
264,
2778,
3319,
13,
9442,
374,
264,
4823,
1358,
315,
279,
3319,
3135,
518,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
1661,
13888,
25,
528,
284,
220,
19,
11,
6464,
24474,
25,
5195,
6014,
7227,
11803,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
7896,
430,
706,
23099,
311,
3319,
279,
5195,
7694,
5446,
323,
636,
1203,
3024,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
6464,
24474,
25,
8859,
8995,
63795,
5831,
10947,
61493,
6014,
7227,
11803,
510,
8327,
60,
55609,
198,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
32,
13564,
2212,
5195,
7694,
13,
51612,
369,
994,
499,
1205,
311,
4320,
4860,
922,
1510,
4455,
13,
5688,
1288,
387,
264,
2778,
3319,
13,
9442,
374,
264,
4823,
1358,
315,
279,
3319,
3135,
6,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.google_search.tool.GoogleSearchResults.html |
afb39de2f776-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.
param num_results: int = 4¶
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], BaseCallbackManager]] = None) → str¶
Make tool callable.
async arun(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 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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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'¶ | [
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
14783,
7694,
18591,
4823,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
1661,
13888,
25,
528,
284,
220,
19,
55609,
198,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.google_search.tool.GoogleSearchResults.html |
862cfb14bdcf-0 | langchain.tools.base.tool¶
langchain.tools.base.tool(*args: Union[str, Callable], return_direct: bool = False, args_schema: Optional[Type[BaseModel]] = None, infer_schema: bool = True) → Callable[source]¶
Make tools out of functions, can be used with or without arguments.
Parameters
*args – The arguments to the tool.
return_direct – Whether to return directly from the tool rather
than continuing the agent loop.
args_schema – optional argument schema for user to specify
infer_schema – Whether to infer the schema of the arguments from
the function’s signature. This also makes the resultant tool
accept a dictionary input to its run() function.
Requires:
Function must be of type (str) -> str
Function must have a docstring
Examples
@tool
def search_api(query: str) -> str:
# Searches the API for the query.
return
@tool("search", return_direct=True)
def search_api(query: str) -> str:
# Searches the API for the query.
return | [
5317,
8995,
24029,
9105,
21966,
55609,
198,
5317,
8995,
24029,
9105,
21966,
4163,
2164,
25,
9323,
17752,
11,
54223,
1145,
471,
33971,
25,
1845,
284,
3641,
11,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
24499,
26443,
25,
1845,
284,
3082,
8,
11651,
54223,
76747,
60,
55609,
198,
8238,
7526,
704,
315,
5865,
11,
649,
387,
1511,
449,
477,
2085,
6105,
627,
9905,
198,
9,
2164,
1389,
578,
6105,
311,
279,
5507,
627,
693,
33971,
1389,
13440,
311,
471,
6089,
505,
279,
5507,
4856,
198,
54895,
14691,
279,
8479,
6471,
627,
2164,
26443,
1389,
10309,
5811,
11036,
369,
1217,
311,
14158,
198,
90659,
26443,
1389,
13440,
311,
24499,
279,
11036,
315,
279,
6105,
505,
198,
1820,
734,
753,
12223,
13,
1115,
1101,
3727,
279,
84913,
5507,
198,
10543,
264,
11240,
1988,
311,
1202,
1629,
368,
734,
627,
48061,
512,
5263,
2011,
387,
315,
955,
320,
496,
8,
1492,
610,
198,
5263,
2011,
617,
264,
4733,
928,
198,
41481,
198,
31,
14506,
198,
755,
2778,
11959,
10974,
25,
610,
8,
1492,
610,
512,
262,
674,
82269,
279,
5446,
369,
279,
3319,
627,
262,
471,
198,
31,
14506,
446,
1874,
498,
471,
33971,
3702,
340,
755,
2778,
11959,
10974,
25,
610,
8,
1492,
610,
512,
262,
674,
82269,
279,
5446,
369,
279,
3319,
627,
262,
471
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.base.Tool.html |
fc5d90d088bb-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 arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
param absolute_urls: bool = False¶
Return absolute URLs instead of relative URLs | [
5317,
8995,
24029,
13269,
53852,
38458,
94516,
16259,
5231,
2193,
75046,
16259,
7896,
2566,
55609,
198,
1058,
8859,
8995,
24029,
13269,
53852,
38458,
94516,
16259,
5231,
2193,
75046,
16259,
7896,
2566,
4163,
11,
10973,
33922,
25,
1845,
284,
3641,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
2566,
369,
23673,
75046,
16259,
7896,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
10973,
33922,
25,
1845,
284,
3641,
55609,
198,
5715,
10973,
36106,
4619,
315,
8844,
36106
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksToolInput.html |
e9bc2e436dbe-0 | langchain.tools.azure_cognitive_services.text2speech.AzureCogsText2SpeechTool¶
class langchain.tools.azure_cognitive_services.text2speech.AzureCogsText2SpeechTool(*, name: str = 'azure_cognitive_services_text2speech', description: str = 'A wrapper around Azure Cognitive Services Text2Speech. Useful for when you need to convert text to speech. ', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, azure_cogs_key: str = '', azure_cogs_region: str = '', speech_language: str = 'en-US', speech_config: Any = None)[source]¶
Bases: BaseTool
Tool that queries the Azure Cognitive Services Text2Speech API.
In order to set this up, follow instructions at:
https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/get-started-text-to-speech?pivots=programming-language-python
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.
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 description: str = 'A wrapper around Azure Cognitive Services Text2Speech. Useful for when you need to convert text to speech. '¶ | [
5317,
8995,
24029,
71340,
669,
51549,
40946,
2858,
17,
89325,
58927,
34,
27403,
1199,
17,
56725,
7896,
55609,
198,
1058,
8859,
8995,
24029,
71340,
669,
51549,
40946,
2858,
17,
89325,
58927,
34,
27403,
1199,
17,
56725,
7896,
4163,
11,
836,
25,
610,
284,
364,
40595,
669,
51549,
40946,
4424,
17,
89325,
518,
4096,
25,
610,
284,
364,
32,
13564,
2212,
35219,
73235,
8471,
2991,
17,
56725,
13,
51612,
369,
994,
499,
1205,
311,
5625,
1495,
311,
8982,
13,
6752,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
77630,
669,
27403,
3173,
25,
610,
284,
9158,
77630,
669,
27403,
21276,
25,
610,
284,
9158,
8982,
30121,
25,
610,
284,
364,
268,
33440,
518,
8982,
5445,
25,
5884,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
7896,
430,
20126,
279,
35219,
73235,
8471,
2991,
17,
56725,
5446,
627,
644,
2015,
311,
743,
420,
709,
11,
1833,
11470,
520,
512,
2485,
1129,
12964,
28719,
916,
13920,
26766,
14,
40595,
2971,
51549,
59392,
2754,
40686,
24358,
24183,
19471,
291,
9529,
4791,
1355,
40686,
91242,
344,
2469,
28,
92726,
44658,
73029,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
32,
13564,
2212,
35219,
73235,
8471,
2991,
17,
56725,
13,
51612,
369,
994,
499,
1205,
311,
5625,
1495,
311,
8982,
13,
364,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.azure_cognitive_services.text2speech.AzureCogsText2SpeechTool.html |
e9bc2e436dbe-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 = 'azure_cognitive_services_text2speech'¶
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__(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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool.
validator validate_environment » all fields[source]¶
Validate that api key and endpoint exists in environment.
property args: dict¶
property is_single_input: bool¶
Whether the tool only accepts a single input.
model Config¶ | [
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
40595,
669,
51549,
40946,
4424,
17,
89325,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
16503,
9788,
52874,
4194,
8345,
4194,
682,
5151,
76747,
60,
55609,
198,
18409,
430,
6464,
1401,
323,
15233,
6866,
304,
4676,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.azure_cognitive_services.text2speech.AzureCogsText2SpeechTool.html |
e9bc2e436dbe-2 | Whether the tool only accepts a single input.
model Config¶
Bases: object
Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | [
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.azure_cognitive_services.text2speech.AzureCogsText2SpeechTool.html |
09471c93feee-0 | langchain.tools.file_management.read.ReadFileInput¶
class langchain.tools.file_management.read.ReadFileInput(*, file_path: str)[source]¶
Bases: BaseModel
Input for ReadFileTool.
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.
param file_path: str [Required]¶
name of file | [
5317,
8995,
24029,
9914,
46463,
4217,
80076,
2566,
55609,
198,
1058,
8859,
8995,
24029,
9914,
46463,
4217,
80076,
2566,
4163,
11,
1052,
2703,
25,
610,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
2566,
369,
4557,
1738,
7896,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
1052,
2703,
25,
610,
510,
8327,
60,
55609,
198,
609,
315,
1052
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.file_management.read.ReadFileInput.html |
e476c6a98a61-0 | langchain.tools.zapier.tool.ZapierNLARunAction¶ | [
5317,
8995,
24029,
4025,
391,
1291,
21966,
13784,
391,
1291,
31142,
946,
359,
2573,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.zapier.tool.ZapierNLARunAction.html |
e476c6a98a61-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[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, api_wrapper: ZapierNLAWrapper = None, action_id: str, params: Optional[dict] = None, 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 associated with it that are specified as a list. You MUST take into account the params when creating the instruction. For example, if the params are [\'Message_Text\', \'Channel\'], your instruction should be something like \'send a slack message to the #general channel with the text hello world\'. Another example: if the params are [\'Calendar\', \'Search_Term\'], your instruction should be something like \'find the meeting in my personal calendar at 3pm\'. Do not make up params, they will be explicitly specified in the tool description. If you do not have enough information to fill in the params, just say \'not enough information provided in the instruction, missing <param>\'. If you get a none or null response, STOP EXECUTION, do not try to another tool!This tool specifically used for: {zapier_description}, and has params: {params}', zapier_description: str, params_schema: Dict[str, str] = None)[source]¶
Bases: BaseTool | [
1058,
8859,
8995,
24029,
4025,
391,
1291,
21966,
13784,
391,
1291,
31142,
946,
359,
2573,
4163,
11,
836,
25,
610,
284,
9158,
4096,
25,
610,
284,
9158,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
6464,
24474,
25,
70331,
1291,
45,
18326,
11803,
284,
2290,
11,
1957,
851,
25,
610,
11,
3712,
25,
12536,
58,
8644,
60,
284,
2290,
11,
2385,
62521,
25,
610,
284,
364,
32,
13564,
2212,
70331,
1291,
452,
18326,
6299,
13,
578,
1988,
311,
420,
5507,
374,
264,
5933,
4221,
7754,
11,
369,
3187,
330,
456,
279,
5652,
2613,
505,
856,
6201,
1,
477,
330,
6820,
264,
46719,
1984,
311,
279,
674,
25615,
5613,
3343,
9062,
5507,
690,
617,
3712,
5938,
449,
433,
430,
527,
5300,
439,
264,
1160,
13,
1472,
28832,
1935,
1139,
2759,
279,
3712,
994,
6968,
279,
7754,
13,
1789,
3187,
11,
422,
279,
3712,
527,
510,
10379,
2097,
21192,
55387,
28251,
9826,
59,
4181,
701,
7754,
1288,
387,
2555,
1093,
28251,
6820,
264,
46719,
1984,
311,
279,
674,
25615,
5613,
449,
279,
1495,
24748,
1917,
59,
4527,
13596,
3187,
25,
422,
279,
3712,
527,
510,
10379,
20475,
55387,
28251,
6014,
1159,
4289,
59,
4181,
701,
7754,
1288,
387,
2555,
1093,
28251,
3990,
279,
6574,
304,
856,
4443,
13470,
520,
220,
18,
5298,
59,
4527,
3234,
539,
1304,
709,
3712,
11,
814,
690,
387,
21650,
5300,
304,
279,
5507,
4096,
13,
1442,
499,
656,
539,
617,
3403,
2038,
311,
5266,
304,
279,
3712,
11,
1120,
2019,
28251,
1962,
3403,
2038,
3984,
304,
279,
7754,
11,
7554,
366,
913,
8616,
4527,
1442,
499,
636,
264,
7000,
477,
854,
2077,
11,
46637,
63347,
29717,
11,
656,
539,
1456,
311,
2500,
5507,
0,
2028,
5507,
11951,
1511,
369,
25,
314,
93471,
1291,
11703,
2186,
323,
706,
3712,
25,
314,
3603,
17266,
34078,
1291,
11703,
25,
610,
11,
3712,
26443,
25,
30226,
17752,
11,
610,
60,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.zapier.tool.ZapierNLARunAction.html |
e476c6a98a61-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 prompt of another LLM
call.
Parameters
action_id – a specific action ID (from list actions) of the action to execute
(the set api_key must be associated with the action owner)
instructions – a natural language instruction string for using the action
(eg. “get the latest email from Mike Knoop” for “Gmail: find email” action)
params – a dict, optional. Any params provided will override AI guesses
from instructions (see “understanding the AI guessing flow” here:
https://nla.zapier.com/docs/using-the-api#ai-guessing)
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.
param action_id: str [Required]¶
param api_wrapper: langchain.utilities.zapier.ZapierNLAWrapper [Optional]¶
param args_schema: Optional[Type[BaseModel]] = None¶
Pydantic model class to validate and parse the tool’s input arguments. | [
33,
2315,
25,
5464,
7896,
198,
10427,
2142,
459,
1957,
430,
374,
11054,
555,
1957,
851,
11,
2011,
387,
15246,
88854,
8,
555,
279,
1510,
1217,
320,
50187,
449,
279,
743,
6464,
3173,
570,
10604,
198,
22479,
15246,
6299,
1618,
25,
3788,
1129,
77,
4355,
4025,
391,
1291,
916,
56260,
71076,
6018,
791,
471,
4823,
374,
19883,
311,
387,
2753,
1109,
4056,
2636,
4339,
320,
8652,
198,
31666,
8,
3339,
433,
6220,
311,
15921,
1139,
279,
10137,
315,
2500,
445,
11237,
198,
6797,
627,
9905,
198,
1335,
851,
1389,
264,
3230,
1957,
3110,
320,
1527,
1160,
6299,
8,
315,
279,
1957,
311,
9203,
198,
31524,
743,
6464,
3173,
2011,
387,
5938,
449,
279,
1957,
6506,
340,
63395,
1389,
264,
5933,
4221,
7754,
925,
369,
1701,
279,
1957,
198,
7,
797,
13,
1054,
456,
279,
5652,
2613,
505,
11519,
735,
41262,
863,
369,
1054,
38,
3796,
25,
1505,
2613,
863,
1957,
340,
3603,
1389,
264,
6587,
11,
10309,
13,
5884,
3712,
3984,
690,
2882,
15592,
61637,
198,
1527,
11470,
320,
4151,
1054,
8154,
10276,
279,
15592,
47576,
6530,
863,
1618,
512,
2485,
1129,
77,
4355,
4025,
391,
1291,
916,
27057,
14,
985,
10826,
24851,
2,
2192,
2427,
34401,
287,
340,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
1957,
851,
25,
610,
510,
8327,
60,
55609,
198,
913,
6464,
24474,
25,
8859,
8995,
63795,
4025,
391,
1291,
13784,
391,
1291,
45,
18326,
11803,
510,
15669,
60,
55609,
198,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.zapier.tool.ZapierNLARunAction.html |
e476c6a98a61-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 associated with it that are specified as a list. You MUST take into account the params when creating the instruction. For example, if the params are [\'Message_Text\', \'Channel\'], your instruction should be something like \'send a slack message to the #general channel with the text hello world\'. Another example: if the params are [\'Calendar\', \'Search_Term\'], your instruction should be something like \'find the meeting in my personal calendar at 3pm\'. Do not make up params, they will be explicitly specified in the tool description. If you do not have enough information to fill in the params, just say \'not enough information provided in the instruction, missing <param>\'. If you get a none or null response, STOP EXECUTION, do not try to another tool!This tool specifically used for: {zapier_description}, and has params: {params}'¶
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 = ''¶
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 = ''¶
The unique name of the tool that clearly communicates its purpose.
param params: Optional[dict] = None¶ | [
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
2385,
62521,
25,
610,
284,
364,
32,
13564,
2212,
70331,
1291,
452,
18326,
6299,
13,
578,
1988,
311,
420,
5507,
374,
264,
5933,
4221,
7754,
11,
369,
3187,
330,
456,
279,
5652,
2613,
505,
856,
6201,
1,
477,
330,
6820,
264,
46719,
1984,
311,
279,
674,
25615,
5613,
3343,
9062,
5507,
690,
617,
3712,
5938,
449,
433,
430,
527,
5300,
439,
264,
1160,
13,
1472,
28832,
1935,
1139,
2759,
279,
3712,
994,
6968,
279,
7754,
13,
1789,
3187,
11,
422,
279,
3712,
527,
510,
10379,
2097,
21192,
55387,
28251,
9826,
59,
4181,
701,
7754,
1288,
387,
2555,
1093,
28251,
6820,
264,
46719,
1984,
311,
279,
674,
25615,
5613,
449,
279,
1495,
24748,
1917,
59,
4527,
13596,
3187,
25,
422,
279,
3712,
527,
510,
10379,
20475,
55387,
28251,
6014,
1159,
4289,
59,
4181,
701,
7754,
1288,
387,
2555,
1093,
28251,
3990,
279,
6574,
304,
856,
4443,
13470,
520,
220,
18,
5298,
59,
4527,
3234,
539,
1304,
709,
3712,
11,
814,
690,
387,
21650,
5300,
304,
279,
5507,
4096,
13,
1442,
499,
656,
539,
617,
3403,
2038,
311,
5266,
304,
279,
3712,
11,
1120,
2019,
28251,
1962,
3403,
2038,
3984,
304,
279,
7754,
11,
7554,
366,
913,
8616,
4527,
1442,
499,
636,
264,
7000,
477,
854,
2077,
11,
46637,
63347,
29717,
11,
656,
539,
1456,
311,
2500,
5507,
0,
2028,
5507,
11951,
1511,
369,
25,
314,
93471,
1291,
11703,
2186,
323,
706,
3712,
25,
314,
3603,
11923,
55609,
198,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
3436,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
3436,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
3712,
25,
12536,
58,
8644,
60,
284,
2290,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.zapier.tool.ZapierNLARunAction.html |
e476c6a98a61-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 progress.
param zapier_description: str [Required]¶
__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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool.
validator set_name_description » all fields[source]¶
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'¶ | [
913,
3712,
25,
12536,
58,
8644,
60,
284,
2290,
55609,
198,
913,
3712,
26443,
25,
30226,
17752,
11,
610,
60,
510,
15669,
60,
55609,
198,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
913,
34078,
1291,
11703,
25,
610,
510,
8327,
60,
55609,
198,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
16503,
743,
1292,
11703,
4194,
8345,
4194,
682,
5151,
76747,
60,
55609,
198,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.zapier.tool.ZapierNLARunAction.html |
ba3d802ad2ba-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 cannot be parsed to form a valid model.
param requests_wrapper: langchain.requests.TextRequestsWrapper [Required]¶ | [
5317,
8995,
24029,
68771,
21966,
13316,
36395,
7896,
55609,
198,
1058,
8859,
8995,
24029,
68771,
21966,
13316,
36395,
7896,
4163,
11,
7540,
24474,
25,
2991,
36395,
11803,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
4066,
538,
369,
7540,
7526,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
7540,
24474,
25,
8859,
8995,
68771,
2021,
36395,
11803,
510,
8327,
60,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.requests.tool.BaseRequestsTool.html |
36b9cb195f22-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 requested resource.', args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'langchain.tools.office365.messages_search.SearchEmailsInput'>, return_direct: bool = False, verbose: bool = False, callbacks: ~typing.Optional[~typing.Union[~typing.List[~langchain.callbacks.base.BaseCallbackHandler], ~langchain.callbacks.base.BaseCallbackManager]] = None, callback_manager: ~typing.Optional[~langchain.callbacks.base.BaseCallbackManager] = None, handle_tool_error: ~typing.Optional[~typing.Union[bool, str, ~typing.Callable[[~langchain.tools.base.ToolException], str]]] = False, account: Account = None)[source]¶
Bases: O365BaseTool
Class for searching email messages in Office 365
Free, but setup is required
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.
param account: Account [Optional]¶
param args_schema: Type[pydantic.main.BaseModel] = <class 'langchain.tools.office365.messages_search.SearchEmailsInput'>¶
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. | [
5317,
8995,
24029,
100193,
12676,
26381,
10947,
8548,
12676,
6014,
4886,
82,
55609,
198,
1058,
8859,
8995,
24029,
100193,
12676,
26381,
10947,
8548,
12676,
6014,
4886,
82,
4163,
11,
836,
25,
610,
284,
364,
16727,
10947,
518,
4096,
25,
610,
284,
364,
10464,
420,
5507,
311,
2778,
369,
2613,
6743,
13,
578,
1988,
2011,
387,
264,
2764,
5210,
12441,
348,
16,
13,
15,
400,
1874,
3319,
13,
578,
2612,
374,
264,
4823,
1160,
315,
279,
11472,
5211,
16045,
2897,
26443,
25,
4056,
90902,
10394,
58,
93,
3368,
67,
8322,
9056,
13316,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
100193,
12676,
26381,
10947,
33003,
4886,
82,
2566,
6404,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
93,
90902,
5937,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
3126,
1145,
4056,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
4056,
90902,
37464,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
2707,
11,
610,
11,
4056,
90902,
28115,
481,
15873,
93,
5317,
8995,
24029,
9105,
25443,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
2759,
25,
8785,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
507,
12676,
4066,
7896,
198,
1999,
369,
15389,
2613,
6743,
304,
8410,
220,
12676,
198,
11180,
11,
719,
6642,
374,
2631,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2759,
25,
8785,
510,
15669,
60,
55609,
198,
913,
2897,
26443,
25,
4078,
58,
3368,
67,
8322,
9056,
13316,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
100193,
12676,
26381,
10947,
33003,
4886,
82,
2566,
6404,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.office365.messages_search.O365SearchEmails.html |
36b9cb195f22-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.
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 = 'messages_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 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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶ | [
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
10464,
420,
5507,
311,
2778,
369,
2613,
6743,
13,
578,
1988,
2011,
387,
264,
2764,
5210,
12441,
348,
16,
13,
15,
400,
1874,
3319,
13,
578,
2612,
374,
264,
4823,
1160,
315,
279,
11472,
5211,
3238,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
16727,
10947,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.office365.messages_search.O365SearchEmails.html |
36b9cb195f22-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'¶ | [
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
76747,
60,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.office365.messages_search.O365SearchEmails.html |
cb7a0c0c8569-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 list of all the events in the user's calendar between the start and end times. You can assume that the user can not schedule any meeting over existing meetings, and that the user is busy during meetings. Any times without events are free for the user. ", args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'langchain.tools.office365.events_search.SearchEventsInput'>, return_direct: bool = False, verbose: bool = False, callbacks: ~typing.Optional[~typing.Union[~typing.List[~langchain.callbacks.base.BaseCallbackHandler], ~langchain.callbacks.base.BaseCallbackManager]] = None, callback_manager: ~typing.Optional[~langchain.callbacks.base.BaseCallbackManager] = None, handle_tool_error: ~typing.Optional[~typing.Union[bool, str, ~typing.Callable[[~langchain.tools.base.ToolException], str]]] = False, account: Account = None)[source]¶
Bases: O365BaseTool
Class for searching calendar events in Office 365
Free, but setup is required
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.
param account: Account [Optional]¶
param args_schema: Type[pydantic.main.BaseModel] = <class 'langchain.tools.office365.events_search.SearchEventsInput'>¶
Pydantic model class to validate and parse the tool’s input arguments.
param callback_manager: Optional[BaseCallbackManager] = None¶ | [
5317,
8995,
24029,
100193,
12676,
18626,
10947,
8548,
12676,
6014,
8059,
55609,
198,
1058,
8859,
8995,
24029,
100193,
12676,
18626,
10947,
8548,
12676,
6014,
8059,
4163,
11,
836,
25,
610,
284,
364,
12670,
10947,
518,
4096,
25,
610,
284,
330,
5560,
420,
5507,
311,
2778,
369,
279,
1217,
596,
13470,
4455,
13,
578,
1988,
2011,
387,
279,
1212,
323,
842,
3338,
7034,
369,
279,
2778,
3319,
13,
578,
2612,
374,
264,
4823,
1160,
315,
682,
279,
4455,
304,
279,
1217,
596,
13470,
1990,
279,
1212,
323,
842,
3115,
13,
1472,
649,
9855,
430,
279,
1217,
649,
4194,
539,
9899,
904,
6574,
927,
6484,
16659,
11,
323,
430,
279,
1217,
374,
13326,
2391,
16659,
13,
5884,
3115,
2085,
4455,
527,
1949,
369,
279,
1217,
13,
3755,
2897,
26443,
25,
4056,
90902,
10394,
58,
93,
3368,
67,
8322,
9056,
13316,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
100193,
12676,
18626,
10947,
33003,
8059,
2566,
6404,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
93,
90902,
5937,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
3126,
1145,
4056,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
4056,
90902,
37464,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
2707,
11,
610,
11,
4056,
90902,
28115,
481,
15873,
93,
5317,
8995,
24029,
9105,
25443,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
2759,
25,
8785,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
507,
12676,
4066,
7896,
198,
1999,
369,
15389,
13470,
4455,
304,
8410,
220,
12676,
198,
11180,
11,
719,
6642,
374,
2631,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2759,
25,
8785,
510,
15669,
60,
55609,
198,
913,
2897,
26443,
25,
4078,
58,
3368,
67,
8322,
9056,
13316,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
100193,
12676,
18626,
10947,
33003,
8059,
2566,
6404,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.office365.events_search.O365SearchEvents.html |
cb7a0c0c8569-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 the search query. The output is a JSON list of all the events in the user's calendar between the start and end times. You can assume that the user can not schedule any meeting over existing meetings, and that the user is busy during meetings. Any times without events are free for the user. "¶
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 = 'events_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 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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool asynchronously.
validator raise_deprecation » all fields¶ | [
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
330,
5560,
420,
5507,
311,
2778,
369,
279,
1217,
596,
13470,
4455,
13,
578,
1988,
2011,
387,
279,
1212,
323,
842,
3338,
7034,
369,
279,
2778,
3319,
13,
578,
2612,
374,
264,
4823,
1160,
315,
682,
279,
4455,
304,
279,
1217,
596,
13470,
1990,
279,
1212,
323,
842,
3115,
13,
1472,
649,
9855,
430,
279,
1217,
649,
4194,
539,
9899,
904,
6574,
927,
6484,
16659,
11,
323,
430,
279,
1217,
374,
13326,
2391,
16659,
13,
5884,
3115,
2085,
4455,
527,
1949,
369,
279,
1217,
13,
330,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
12670,
10947,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.office365.events_search.O365SearchEvents.html |
cb7a0c0c8569-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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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'¶ | [
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
76747,
60,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.office365.events_search.O365SearchEvents.html |
293525a56f2d-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 If an error is returned with 'Bad request' in it, rewrite the query and try again.\n If an error is returned with 'Unauthorized' in it, do not try again, but tell the user to change their authentication.\n\n Example Input: query {{ allUsers {{ id, name, email }} }} ", args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, graphql_wrapper: GraphQLAPIWrapper)[source]¶
Bases: BaseTool
Base tool for querying a GraphQL API.
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.
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. | [
5317,
8995,
24029,
10996,
1498,
21966,
13316,
89737,
7896,
55609,
198,
1058,
8859,
8995,
24029,
10996,
1498,
21966,
13316,
89737,
7896,
4163,
11,
836,
25,
610,
284,
364,
1663,
15080,
1498,
518,
4096,
25,
610,
284,
330,
46493,
5688,
311,
420,
5507,
374,
264,
11944,
323,
4495,
36187,
3319,
11,
2612,
374,
264,
1121,
505,
279,
5446,
7255,
77,
46493,
1442,
279,
3319,
374,
539,
4495,
11,
459,
1493,
1984,
690,
387,
6052,
7255,
77,
46493,
1442,
459,
1493,
374,
6052,
449,
364,
17519,
1715,
6,
304,
433,
11,
18622,
279,
3319,
323,
1456,
1578,
7255,
77,
46493,
1442,
459,
1493,
374,
6052,
449,
364,
52281,
6,
304,
433,
11,
656,
539,
1456,
1578,
11,
719,
3371,
279,
1217,
311,
2349,
872,
17066,
7255,
77,
1734,
46493,
13688,
5688,
25,
3319,
5991,
682,
7283,
5991,
887,
11,
836,
11,
2613,
3954,
3954,
46493,
3755,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
49965,
24474,
25,
36187,
7227,
11803,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
4066,
5507,
369,
82198,
264,
36187,
5446,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.graphql.tool.BaseGraphQLTool.html |
293525a56f2d-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' in it, rewrite the query and try again.\n If an error is returned with 'Unauthorized' in it, do not try again, but tell the user to change their authentication.\n\n Example Input: query {{ allUsers {{ id, name, email }} }} "¶
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 graphql_wrapper: langchain.utilities.graphql.GraphQLAPIWrapper [Required]¶
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'query_graphql'¶
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__(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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶ | [
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
330,
46493,
5688,
311,
420,
5507,
374,
264,
11944,
323,
4495,
36187,
3319,
11,
2612,
374,
264,
1121,
505,
279,
5446,
7255,
77,
46493,
1442,
279,
3319,
374,
539,
4495,
11,
459,
1493,
1984,
690,
387,
6052,
7255,
77,
46493,
1442,
459,
1493,
374,
6052,
449,
364,
17519,
1715,
6,
304,
433,
11,
18622,
279,
3319,
323,
1456,
1578,
7255,
77,
46493,
1442,
459,
1493,
374,
6052,
449,
364,
52281,
6,
304,
433,
11,
656,
539,
1456,
1578,
11,
719,
3371,
279,
1217,
311,
2349,
872,
17066,
7255,
77,
1734,
46493,
13688,
5688,
25,
3319,
5991,
682,
7283,
5991,
887,
11,
836,
11,
2613,
3954,
3954,
46493,
330,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
49965,
24474,
25,
8859,
8995,
63795,
10996,
1498,
41337,
3672,
7227,
11803,
510,
8327,
60,
55609,
198,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
1663,
15080,
1498,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.graphql.tool.BaseGraphQLTool.html |
293525a56f2d-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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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.
arbitrary_types_allowed = True¶ | [
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
76747,
60,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.graphql.tool.BaseGraphQLTool.html |
d4c07a0cbffd-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'>, return_direct: bool = False, verbose: bool = False, callbacks: ~typing.Optional[~typing.Union[~typing.List[~langchain.callbacks.base.BaseCallbackHandler], ~langchain.callbacks.base.BaseCallbackManager]] = None, callback_manager: ~typing.Optional[~langchain.callbacks.base.BaseCallbackManager] = None, handle_tool_error: ~typing.Optional[~typing.Union[bool, str, ~typing.Callable[[~langchain.tools.base.ToolException], str]]] = False, sync_browser: Optional['SyncBrowser'] = None, async_browser: Optional['AsyncBrowser'] = None)[source]¶
Bases: BaseBrowserTool
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.
param args_schema: Type[BaseModel] = <class 'langchain.tools.playwright.navigate.NavigateToolInput'>¶
Pydantic model class to validate and parse the tool’s input arguments.
param async_browser: Optional['AsyncBrowser'] = None¶
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 = 'Navigate a browser to the specified URL'¶
Used to tell the model how/when/why to use the tool.
You can provide few-shot examples as a part of the description. | [
5317,
8995,
24029,
13269,
53852,
19452,
74794,
7896,
55609,
198,
1058,
8859,
8995,
24029,
13269,
53852,
19452,
74794,
7896,
4163,
11,
836,
25,
610,
284,
364,
71939,
54514,
518,
4096,
25,
610,
284,
364,
74382,
264,
7074,
311,
279,
5300,
5665,
518,
2897,
26443,
25,
4056,
90902,
10394,
58,
93,
3368,
67,
8322,
9056,
13316,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
13269,
53852,
19452,
74794,
7896,
2566,
6404,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
93,
90902,
5937,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
3126,
1145,
4056,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
4056,
90902,
37464,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
2707,
11,
610,
11,
4056,
90902,
28115,
481,
15873,
93,
5317,
8995,
24029,
9105,
25443,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
13105,
54514,
25,
12536,
681,
12430,
18360,
663,
284,
2290,
11,
3393,
54514,
25,
12536,
681,
6662,
18360,
663,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
18360,
7896,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
4078,
58,
4066,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
13269,
53852,
19452,
74794,
7896,
2566,
6404,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
3393,
54514,
25,
12536,
681,
6662,
18360,
663,
284,
2290,
55609,
198,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
74382,
264,
7074,
311,
279,
5300,
5665,
6,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.navigate.NavigateTool.html |
d4c07a0cbffd-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 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 sync_browser: Optional['SyncBrowser'] = None¶
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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool asynchronously.
classmethod from_browser(sync_browser: Optional[SyncBrowser] = None, async_browser: Optional[AsyncBrowser] = None) → BaseBrowserTool¶
Instantiate the tool.
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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool.
validator validate_browser_provided » all fields¶
Check that the arguments are valid. | [
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
71939,
54514,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
13105,
54514,
25,
12536,
681,
12430,
18360,
663,
284,
2290,
55609,
198,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
27853,
505,
54514,
98333,
54514,
25,
12536,
58,
12430,
18360,
60,
284,
2290,
11,
3393,
54514,
25,
12536,
58,
6662,
18360,
60,
284,
2290,
8,
11651,
5464,
18360,
7896,
55609,
198,
81651,
279,
5507,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
16503,
9788,
54514,
2602,
44057,
4194,
8345,
4194,
682,
5151,
55609,
198,
4061,
430,
279,
6105,
527,
2764,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.navigate.NavigateTool.html |
d4c07a0cbffd-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'¶ | [
16503,
9788,
54514,
2602,
44057,
4194,
8345,
4194,
682,
5151,
55609,
198,
4061,
430,
279,
6105,
527,
2764,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.navigate.NavigateTool.html |
42c77074f8bb-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 the value of "data" should be a dictionary of \n key-value pairs you want to PATCH to the url.\n Be careful to always use double quotes for strings in the json string\n The output will be the text response of the PATCH request.\n ', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, requests_wrapper: TextRequestsWrapper)[source]¶
Bases: BaseRequestsTool, BaseTool
Tool for making a PATCH request to an API endpoint.
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.
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. | [
5317,
8995,
24029,
68771,
21966,
9856,
82,
44722,
7896,
55609,
198,
1058,
8859,
8995,
24029,
68771,
21966,
9856,
82,
44722,
7896,
4163,
11,
836,
25,
610,
284,
364,
37342,
40743,
518,
4096,
25,
610,
284,
364,
10464,
420,
994,
499,
1390,
311,
60445,
311,
264,
3997,
7255,
77,
46493,
5688,
1288,
387,
264,
3024,
925,
449,
1403,
7039,
25,
330,
1103,
1,
323,
330,
695,
3343,
59,
77,
46493,
578,
907,
315,
330,
1103,
1,
1288,
387,
264,
925,
11,
323,
279,
907,
315,
330,
695,
1,
1288,
387,
264,
11240,
315,
1144,
77,
46493,
1401,
19625,
13840,
499,
1390,
311,
60445,
311,
279,
2576,
7255,
77,
46493,
2893,
16994,
311,
2744,
1005,
2033,
17637,
369,
9246,
304,
279,
3024,
925,
1734,
46493,
578,
2612,
690,
387,
279,
1495,
2077,
315,
279,
60445,
1715,
7255,
77,
46493,
6752,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
7540,
24474,
25,
2991,
36395,
11803,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
36395,
7896,
11,
5464,
7896,
198,
7896,
369,
3339,
264,
60445,
1715,
311,
459,
5446,
15233,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.requests.tool.RequestsPatchTool.html |
42c77074f8bb-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 key-value pairs you want to PATCH to the url.\n Be careful to always use double quotes for strings in the json string\n The output will be the text response of the PATCH request.\n '¶
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 = 'requests_patch'¶
The unique name of the tool that clearly communicates its purpose.
param requests_wrapper: langchain.requests.TextRequestsWrapper [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 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¶
Make tool callable.
async arun(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 asynchronously. | [
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
10464,
420,
994,
499,
1390,
311,
60445,
311,
264,
3997,
7255,
77,
46493,
5688,
1288,
387,
264,
3024,
925,
449,
1403,
7039,
25,
330,
1103,
1,
323,
330,
695,
3343,
59,
77,
46493,
578,
907,
315,
330,
1103,
1,
1288,
387,
264,
925,
11,
323,
279,
907,
315,
330,
695,
1,
1288,
387,
264,
11240,
315,
1144,
77,
46493,
1401,
19625,
13840,
499,
1390,
311,
60445,
311,
279,
2576,
7255,
77,
46493,
2893,
16994,
311,
2744,
1005,
2033,
17637,
369,
9246,
304,
279,
3024,
925,
1734,
46493,
578,
2612,
690,
387,
279,
1495,
2077,
315,
279,
60445,
1715,
7255,
77,
46493,
364,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
37342,
40743,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
7540,
24474,
25,
8859,
8995,
68771,
2021,
36395,
11803,
510,
8327,
60,
55609,
198,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.requests.tool.RequestsPatchTool.html |
42c77074f8bb-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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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'¶ | [
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.requests.tool.RequestsPatchTool.html |
c6e85ab85135-0 | langchain.tools.ddg_search.tool.DuckDuckGoSearchRun¶
class langchain.tools.ddg_search.tool.DuckDuckGoSearchRun(*, name: str = 'duckduckgo_search', description: str = 'A wrapper around DuckDuckGo Search. Useful for when you need to answer questions about current events. Input should be a search query.', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, api_wrapper: DuckDuckGoSearchAPIWrapper = None)[source]¶
Bases: BaseTool
Tool that adds the capability to query the DuckDuckGo search API.
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.
param api_wrapper: langchain.utilities.duckduckgo_search.DuckDuckGoSearchAPIWrapper [Optional]¶
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 description: str = 'A wrapper around DuckDuckGo Search. Useful for when you need to answer questions about current events. Input should be a search query.'¶
Used to tell the model how/when/why to use the tool.
You can provide few-shot examples as a part of the description. | [
5317,
8995,
24029,
57742,
70,
10947,
21966,
920,
1983,
35,
1983,
11087,
6014,
6869,
55609,
198,
1058,
8859,
8995,
24029,
57742,
70,
10947,
21966,
920,
1983,
35,
1983,
11087,
6014,
6869,
4163,
11,
836,
25,
610,
284,
364,
74070,
74070,
3427,
10947,
518,
4096,
25,
610,
284,
364,
32,
13564,
2212,
46870,
35,
1983,
11087,
7694,
13,
51612,
369,
994,
499,
1205,
311,
4320,
4860,
922,
1510,
4455,
13,
5688,
1288,
387,
264,
2778,
3319,
16045,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
6464,
24474,
25,
46870,
35,
1983,
11087,
6014,
7227,
11803,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
7896,
430,
11621,
279,
23099,
311,
3319,
279,
46870,
35,
1983,
11087,
2778,
5446,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
6464,
24474,
25,
8859,
8995,
63795,
962,
1983,
74070,
3427,
10947,
920,
1983,
35,
1983,
11087,
6014,
7227,
11803,
510,
15669,
60,
55609,
198,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
32,
13564,
2212,
46870,
35,
1983,
11087,
7694,
13,
51612,
369,
994,
499,
1205,
311,
4320,
4860,
922,
1510,
4455,
13,
5688,
1288,
387,
264,
2778,
3319,
3238,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.ddg_search.tool.DuckDuckGoSearchRun.html |
c6e85ab85135-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 = 'duckduckgo_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 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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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'¶ | [
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
74070,
74070,
3427,
10947,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.ddg_search.tool.DuckDuckGoSearchRun.html |
670e29d1cf07-0 | langchain.tools.playwright.utils.create_async_playwright_browser¶
langchain.tools.playwright.utils.create_async_playwright_browser(headless: bool = True) → AsyncBrowser[source]¶
Create a async playwright browser.
Parameters
headless – Whether to run the browser in headless mode. Defaults to True.
Returns
The playwright browser.
Return type
AsyncBrowser | [
5317,
8995,
24029,
13269,
53852,
8576,
2581,
29446,
22932,
53852,
54514,
55609,
198,
5317,
8995,
24029,
13269,
53852,
8576,
2581,
29446,
22932,
53852,
54514,
26408,
1752,
25,
1845,
284,
3082,
8,
11651,
22149,
18360,
76747,
60,
55609,
198,
4110,
264,
3393,
99468,
7074,
627,
9905,
198,
2025,
1752,
1389,
13440,
311,
1629,
279,
7074,
304,
2010,
1752,
3941,
13,
37090,
311,
3082,
627,
16851,
198,
791,
99468,
7074,
627,
5715,
955,
198,
6662,
18360
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.utils.create_async_playwright_browser.html |
a7e7a9b67bc4-0 | langchain.tools.file_management.move.FileMoveInput¶
class langchain.tools.file_management.move.FileMoveInput(*, source_path: str, destination_path: str)[source]¶
Bases: BaseModel
Input for MoveFileTool.
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.
param destination_path: str [Required]¶
New path for the moved file
param source_path: str [Required]¶
Path of the file to move | [
5317,
8995,
24029,
9914,
46463,
13949,
8744,
10061,
2566,
55609,
198,
1058,
8859,
8995,
24029,
9914,
46463,
13949,
8744,
10061,
2566,
4163,
11,
2592,
2703,
25,
610,
11,
9284,
2703,
25,
610,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
2566,
369,
14903,
1738,
7896,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
9284,
2703,
25,
610,
510,
8327,
60,
55609,
198,
3648,
1853,
369,
279,
7882,
1052,
198,
913,
2592,
2703,
25,
610,
510,
8327,
60,
55609,
198,
1858,
315,
279,
1052,
311,
3351
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.file_management.move.FileMoveInput.html |
d36c0cb5269b-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 values set to value.
get(key[, default])
Return the value for key if key is in the dictionary, else default.
items()
keys()
pop(k[,d])
If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem()
Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])
Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)
If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()
Attributes
name
The name of the function.
description
A description of the function.
parameters
The parameters of the function.
clear() → None. Remove all items from D.¶
copy() → a shallow copy of D¶
fromkeys(value=None, /)¶
Create a new dictionary with keys from iterable and values set to value.
get(key, default=None, /)¶
Return the value for key if key is in the dictionary, else default.
items() → a set-like object providing a view on D's items¶ | [
5317,
8995,
24029,
24973,
2401,
11563,
2192,
31647,
5116,
55609,
198,
1058,
8859,
8995,
24029,
24973,
2401,
11563,
2192,
31647,
5116,
76747,
60,
55609,
198,
33,
2315,
25,
51654,
13755,
198,
57003,
315,
264,
42022,
734,
311,
279,
5377,
15836,
5446,
627,
18337,
198,
565,
2381,
69106,
2164,
11,
4194,
334,
9872,
340,
7574,
746,
8728,
746,
1527,
10786,
2625,
970,
2608,
4110,
264,
502,
11240,
449,
7039,
505,
51934,
323,
2819,
743,
311,
907,
627,
456,
4962,
38372,
4194,
2309,
2608,
5715,
279,
907,
369,
1401,
422,
1401,
374,
304,
279,
11240,
11,
775,
1670,
627,
3699,
746,
10786,
746,
8539,
6097,
38372,
67,
2608,
2746,
279,
1401,
374,
539,
1766,
11,
471,
279,
1670,
422,
2728,
26,
6062,
11,
4933,
264,
39194,
627,
8539,
1224,
746,
13319,
323,
471,
264,
320,
798,
11,
907,
8,
6857,
439,
264,
220,
17,
2442,
6189,
627,
751,
2309,
4962,
38372,
4194,
2309,
2608,
14099,
1401,
449,
264,
907,
315,
1670,
422,
1401,
374,
539,
304,
279,
11240,
627,
2443,
2625,
36,
11,
4194,
79441,
37,
340,
2746,
469,
374,
3118,
323,
706,
264,
662,
10786,
368,
1749,
11,
1243,
1587,
25,
220,
369,
597,
304,
469,
25,
423,
6874,
60,
284,
469,
6874,
60,
1442,
469,
374,
3118,
323,
37856,
264,
662,
10786,
368,
1749,
11,
1243,
1587,
25,
220,
369,
597,
11,
348,
304,
469,
25,
423,
6874,
60,
284,
348,
763,
3060,
1162,
11,
420,
374,
8272,
555,
25,
369,
597,
304,
435,
25,
220,
423,
6874,
60,
284,
435,
6874,
933,
3745,
746,
10738,
198,
609,
198,
791,
836,
315,
279,
734,
627,
4789,
198,
32,
4096,
315,
279,
734,
627,
14105,
198,
791,
5137,
315,
279,
734,
627,
7574,
368,
11651,
2290,
13,
4194,
11016,
682,
3673,
505,
423,
13,
55609,
198,
8728,
368,
11651,
264,
26682,
3048,
315,
423,
55609,
198,
1527,
10786,
3764,
5980,
11,
611,
8,
55609,
198,
4110,
264,
502,
11240,
449,
7039,
505,
51934,
323,
2819,
743,
311,
907,
627,
456,
4962,
11,
1670,
5980,
11,
611,
8,
55609,
198,
5715,
279,
907,
369,
1401,
422,
1401,
374,
304,
279,
11240,
11,
775,
1670,
627,
3699,
368,
11651,
264,
743,
12970,
1665,
8405,
264,
1684,
389,
423,
596,
3673,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.convert_to_openai.FunctionDescription.html |
d36c0cb5269b-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) pair as a 2-tuple.
Pairs are returned in LIFO (last-in, first-out) order.
Raises KeyError if the dict is empty.
setdefault(key, default=None, /)¶
Insert key with a value of default if key is not in the dictionary.
Return the value for key if key is in the dictionary, else default.
update([E, ]**F) → None. Update D from dict/iterable E and F.¶
If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
In either case, this is followed by: for k in F: D[k] = F[k]
values() → an object providing a view on D's values¶
description: str¶
A description of the function.
name: str¶
The name of the function.
parameters: dict¶
The parameters of the function. | [
3699,
368,
11651,
264,
743,
12970,
1665,
8405,
264,
1684,
389,
423,
596,
3673,
55609,
198,
10786,
368,
11651,
264,
743,
12970,
1665,
8405,
264,
1684,
389,
423,
596,
7039,
55609,
198,
8539,
6097,
38372,
294,
2526,
11651,
348,
11,
4148,
5300,
1401,
323,
471,
279,
12435,
907,
13,
55609,
198,
2746,
279,
1401,
374,
539,
1766,
11,
471,
279,
1670,
422,
2728,
26,
6062,
345,
19223,
264,
39194,
627,
8539,
1224,
368,
55609,
198,
13319,
323,
471,
264,
320,
798,
11,
907,
8,
6857,
439,
264,
220,
17,
2442,
6189,
627,
55328,
527,
6052,
304,
445,
27088,
320,
4354,
3502,
11,
1176,
9994,
8,
2015,
627,
36120,
39194,
422,
279,
6587,
374,
4384,
627,
751,
2309,
4962,
11,
1670,
5980,
11,
611,
8,
55609,
198,
14099,
1401,
449,
264,
907,
315,
1670,
422,
1401,
374,
539,
304,
279,
11240,
627,
5715,
279,
907,
369,
1401,
422,
1401,
374,
304,
279,
11240,
11,
775,
1670,
627,
2443,
2625,
36,
11,
2331,
334,
37,
8,
11651,
2290,
13,
4194,
5666,
423,
505,
6587,
14,
2058,
481,
469,
323,
435,
13,
55609,
198,
2746,
469,
374,
3118,
323,
706,
264,
662,
10786,
368,
1749,
11,
1243,
1587,
25,
220,
369,
597,
304,
469,
25,
423,
6874,
60,
284,
469,
6874,
933,
2746,
469,
374,
3118,
323,
37856,
264,
662,
10786,
368,
1749,
11,
1243,
1587,
25,
220,
369,
597,
11,
348,
304,
469,
25,
423,
6874,
60,
284,
348,
198,
644,
3060,
1162,
11,
420,
374,
8272,
555,
25,
369,
597,
304,
435,
25,
220,
423,
6874,
60,
284,
435,
6874,
933,
3745,
368,
11651,
459,
1665,
8405,
264,
1684,
389,
423,
596,
2819,
55609,
198,
4789,
25,
610,
55609,
198,
32,
4096,
315,
279,
734,
627,
609,
25,
610,
55609,
198,
791,
836,
315,
279,
734,
627,
14105,
25,
6587,
55609,
198,
791,
5137,
315,
279,
734,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.convert_to_openai.FunctionDescription.html |
b9204158cd5b-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 a valid model.
param dict_: Dict [Required]¶
param max_value_length: int = 200¶
classmethod from_file(path: Path) → JsonSpec[source]¶
Create a JsonSpec from a file.
keys(text: str) → str[source]¶
Return the keys of the dict at the given path.
Parameters
text – Python representation of the path to the dict (e.g. data[“key1”][0][“key2”]).
value(text: str) → str[source]¶
Return the value of the dict at the given path.
Parameters
text – Python representation of the path to the dict (e.g. data[“key1”][0][“key2”]). | [
5317,
8995,
24029,
4421,
21966,
13874,
8491,
55609,
198,
1058,
8859,
8995,
24029,
4421,
21966,
13874,
8491,
4163,
11,
6587,
24089,
30226,
11,
1973,
3220,
5228,
25,
528,
284,
220,
1049,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
4066,
538,
369,
4823,
1424,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
6587,
24089,
30226,
510,
8327,
60,
55609,
198,
913,
1973,
3220,
5228,
25,
528,
284,
220,
1049,
55609,
198,
27853,
505,
2517,
5698,
25,
8092,
8,
11651,
8472,
8491,
76747,
60,
55609,
198,
4110,
264,
8472,
8491,
505,
264,
1052,
627,
10786,
7383,
25,
610,
8,
11651,
610,
76747,
60,
55609,
198,
5715,
279,
7039,
315,
279,
6587,
520,
279,
2728,
1853,
627,
9905,
198,
1342,
1389,
13325,
13340,
315,
279,
1853,
311,
279,
6587,
320,
68,
1326,
13,
828,
58,
2118,
798,
16,
863,
1483,
15,
1483,
2118,
798,
17,
863,
62361,
970,
7383,
25,
610,
8,
11651,
610,
76747,
60,
55609,
198,
5715,
279,
907,
315,
279,
6587,
520,
279,
2728,
1853,
627,
9905,
198,
1342,
1389,
13325,
13340,
315,
279,
1853,
311,
279,
6587,
320,
68,
1326,
13,
828,
58,
2118,
798,
16,
863,
1483,
15,
1483,
2118,
798,
17,
863,
10927
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.json.tool.JsonSpec.html |
b0674a61b141-0 | langchain.tools.powerbi.tool.InfoPowerBITool¶
class langchain.tools.powerbi.tool.InfoPowerBITool(*, name: str = 'schema_powerbi', 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 calling list_tables_powerbi first!\n\n Example Input: "table1, table2, table3"\n ', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, powerbi: PowerBIDataset)[source]¶
Bases: BaseTool
Tool for getting metadata about a PowerBI Dataset.
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.
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 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 calling list_tables_powerbi first!\n\n Example Input: "table1, table2, table3"\n '¶
Used to tell the model how/when/why to use the tool. | [
5317,
8995,
24029,
40645,
8385,
21966,
20736,
15335,
21587,
1786,
55609,
198,
1058,
8859,
8995,
24029,
40645,
8385,
21966,
20736,
15335,
21587,
1786,
4163,
11,
836,
25,
610,
284,
364,
17801,
21052,
8385,
518,
4096,
25,
610,
284,
5307,
77,
46493,
5688,
311,
420,
5507,
374,
264,
32783,
73792,
1160,
315,
12920,
11,
2612,
374,
279,
11036,
323,
6205,
7123,
369,
1884,
12920,
7255,
77,
46493,
2893,
2771,
430,
279,
12920,
3604,
3073,
555,
8260,
1160,
36732,
21052,
8385,
1176,
15114,
77,
1734,
46493,
13688,
5688,
25,
330,
2048,
16,
11,
2007,
17,
11,
2007,
18,
12200,
77,
46493,
6752,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
2410,
8385,
25,
7572,
33,
926,
8534,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
7896,
369,
3794,
11408,
922,
264,
7572,
8768,
40283,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
5307,
77,
46493,
5688,
311,
420,
5507,
374,
264,
32783,
73792,
1160,
315,
12920,
11,
2612,
374,
279,
11036,
323,
6205,
7123,
369,
1884,
12920,
7255,
77,
46493,
2893,
2771,
430,
279,
12920,
3604,
3073,
555,
8260,
1160,
36732,
21052,
8385,
1176,
15114,
77,
1734,
46493,
13688,
5688,
25,
330,
2048,
16,
11,
2007,
17,
11,
2007,
18,
12200,
77,
46493,
364,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.InfoPowerBITool.html |
b0674a61b141-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_powerbi'¶
The unique name of the tool that clearly communicates its purpose.
param powerbi: langchain.utilities.powerbi.PowerBIDataset [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 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¶
Make tool callable.
async arun(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 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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool.
property args: dict¶
property is_single_input: bool¶
Whether the tool only accepts a single input.
model Config[source]¶
Bases: object | [
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
17801,
21052,
8385,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
2410,
8385,
25,
8859,
8995,
63795,
40645,
8385,
55186,
33,
926,
8534,
510,
8327,
60,
55609,
198,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
76747,
60,
55609,
198,
33,
2315,
25,
1665
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.InfoPowerBITool.html |
b0674a61b141-2 | model Config[source]¶
Bases: object
Configuration for this pydantic object.
arbitrary_types_allowed = True¶ | [
2590,
5649,
76747,
60,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.InfoPowerBITool.html |
94c936bbf5b7-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 the path to the dict in Python syntax (e.g. data["key1"][0]["key2"]).\n ', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, spec: JsonSpec)[source]¶
Bases: BaseTool
Tool for listing keys in a 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 a valid model.
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 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 the path to the dict in Python syntax (e.g. data["key1"][0]["key2"]).\n '¶ | [
5317,
8995,
24029,
4421,
21966,
13874,
861,
9026,
7896,
55609,
198,
1058,
8859,
8995,
24029,
4421,
21966,
13874,
861,
9026,
7896,
4163,
11,
836,
25,
610,
284,
364,
2285,
13908,
2062,
12919,
518,
4096,
25,
610,
284,
5307,
77,
46493,
3053,
387,
1511,
311,
1160,
682,
7039,
520,
264,
2728,
1853,
13,
1144,
77,
46493,
13538,
8260,
420,
499,
1288,
387,
328,
4622,
430,
279,
1853,
311,
420,
6866,
7255,
77,
46493,
578,
1988,
374,
264,
1495,
13340,
315,
279,
1853,
311,
279,
6587,
304,
13325,
20047,
320,
68,
1326,
13,
828,
1204,
798,
16,
18613,
15,
10069,
798,
17,
46114,
59,
77,
46493,
6752,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
1424,
25,
8472,
8491,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
7896,
369,
15182,
7039,
304,
264,
4823,
1424,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
5307,
77,
46493,
3053,
387,
1511,
311,
1160,
682,
7039,
520,
264,
2728,
1853,
13,
1144,
77,
46493,
13538,
8260,
420,
499,
1288,
387,
328,
4622,
430,
279,
1853,
311,
420,
6866,
7255,
77,
46493,
578,
1988,
374,
264,
1495,
13340,
315,
279,
1853,
311,
279,
6587,
304,
13325,
20047,
320,
68,
1326,
13,
828,
1204,
798,
16,
18613,
15,
10069,
798,
17,
46114,
59,
77,
46493,
364,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.json.tool.JsonListKeysTool.html |
94c936bbf5b7-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 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 spec: JsonSpec [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: 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 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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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. | [
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
2285,
13908,
2062,
12919,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
1424,
25,
8472,
8491,
510,
8327,
60,
55609,
198,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.json.tool.JsonListKeysTool.html |
94c936bbf5b7-2 | model Config¶
Bases: object
Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | [
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.json.tool.JsonListKeysTool.html |
b6e7d22167f6-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_sql_db!\n ', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, db: SQLDatabase, template: str = '\n{query}\nDouble check the {dialect} query above for common mistakes, including:\n- Using NOT IN with NULL values\n- Using UNION when UNION ALL should have been used\n- Using BETWEEN for exclusive ranges\n- Data type mismatch in predicates\n- Properly quoting identifiers\n- Using the correct number of arguments for functions\n- Casting to the correct data type\n- Using the proper columns for joins\n\nIf there are any of the above mistakes, rewrite the query. If there are no mistakes, just reproduce the original query.', llm: BaseLanguageModel, llm_chain: LLMChain)[source]¶
Bases: BaseSQLDatabaseTool, BaseTool
Use an LLM to check if a query is correct.
Adapted from https://www.patterns.app/blog/2023/01/18/crunchbot-sql-analyst-gpt/
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.
param args_schema: Optional[Type[BaseModel]] = None¶ | [
5317,
8995,
24029,
10251,
28441,
21966,
16060,
6827,
36288,
7896,
55609,
198,
1058,
8859,
8995,
24029,
10251,
28441,
21966,
16060,
6827,
36288,
7896,
4163,
11,
836,
25,
610,
284,
364,
3628,
8856,
5857,
63815,
518,
4096,
25,
610,
284,
5307,
77,
46493,
5560,
420,
5507,
311,
2033,
1817,
422,
701,
3319,
374,
4495,
1603,
31320,
433,
7255,
77,
46493,
24119,
1005,
420,
5507,
1603,
31320,
264,
3319,
449,
3319,
18554,
8856,
15114,
77,
46493,
6752,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
3000,
25,
8029,
6116,
11,
3896,
25,
610,
284,
5307,
77,
90,
1663,
11281,
77,
7530,
1817,
279,
314,
32106,
772,
92,
3319,
3485,
369,
4279,
21294,
11,
2737,
7338,
77,
12,
12362,
4276,
2006,
449,
1808,
2819,
1734,
12,
12362,
78653,
994,
78653,
13398,
1288,
617,
1027,
1511,
1734,
12,
12362,
57739,
369,
14079,
21986,
1734,
12,
2956,
955,
36401,
304,
81127,
1734,
12,
65658,
398,
57618,
48316,
1734,
12,
12362,
279,
4495,
1396,
315,
6105,
369,
5865,
1734,
12,
66848,
311,
279,
4495,
828,
955,
1734,
12,
12362,
279,
6300,
8310,
369,
29782,
1734,
1734,
2746,
1070,
527,
904,
315,
279,
3485,
21294,
11,
18622,
279,
3319,
13,
1442,
1070,
527,
912,
21294,
11,
1120,
23645,
279,
4113,
3319,
16045,
9507,
76,
25,
5464,
14126,
1747,
11,
9507,
76,
31683,
25,
445,
11237,
19368,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
6827,
6116,
7896,
11,
5464,
7896,
198,
10464,
459,
445,
11237,
311,
1817,
422,
264,
3319,
374,
4495,
627,
2654,
2756,
291,
505,
3788,
1129,
2185,
40209,
82,
1632,
38562,
14,
2366,
18,
14,
1721,
14,
972,
2971,
81,
3265,
6465,
1355,
1498,
19415,
278,
599,
2427,
418,
6018,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLCheckerTool.html |
b6e7d22167f6-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: SQLDatabase [Required]¶
param 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_sql_db!\n '¶
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 llm: langchain.base_language.BaseLanguageModel [Required]¶
param llm_chain: langchain.chains.llm.LLMChain [Required]¶
param name: str = 'sql_db_query_checker'¶
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. | [
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
3000,
25,
8029,
6116,
510,
8327,
60,
55609,
198,
913,
4096,
25,
610,
284,
5307,
77,
46493,
5560,
420,
5507,
311,
2033,
1817,
422,
701,
3319,
374,
4495,
1603,
31320,
433,
7255,
77,
46493,
24119,
1005,
420,
5507,
1603,
31320,
264,
3319,
449,
3319,
18554,
8856,
15114,
77,
46493,
364,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
9507,
76,
25,
8859,
8995,
9105,
30121,
13316,
14126,
1747,
510,
8327,
60,
55609,
198,
913,
9507,
76,
31683,
25,
8859,
8995,
5442,
1771,
60098,
76,
1236,
11237,
19368,
510,
8327,
60,
55609,
198,
913,
836,
25,
610,
284,
364,
3628,
8856,
5857,
63815,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLCheckerTool.html |
b6e7d22167f6-2 | that after the tool is called, the AgentExecutor will stop looping.
param template: str = '\n{query}\nDouble check the {dialect} query above for common mistakes, including:\n- Using NOT IN with NULL values\n- Using UNION when UNION ALL should have been used\n- Using BETWEEN for exclusive ranges\n- Data type mismatch in predicates\n- Properly quoting identifiers\n- Using the correct number of arguments for functions\n- Casting to the correct data type\n- Using the proper columns for joins\n\nIf there are any of the above mistakes, rewrite the query. If there are no mistakes, just reproduce the original query.'¶
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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool asynchronously.
validator initialize_llm_chain » all fields[source]¶
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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool.
property args: dict¶
property is_single_input: bool¶
Whether the tool only accepts a single input.
model Config¶
Bases: Config | [
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
3896,
25,
610,
284,
5307,
77,
90,
1663,
11281,
77,
7530,
1817,
279,
314,
32106,
772,
92,
3319,
3485,
369,
4279,
21294,
11,
2737,
7338,
77,
12,
12362,
4276,
2006,
449,
1808,
2819,
1734,
12,
12362,
78653,
994,
78653,
13398,
1288,
617,
1027,
1511,
1734,
12,
12362,
57739,
369,
14079,
21986,
1734,
12,
2956,
955,
36401,
304,
81127,
1734,
12,
65658,
398,
57618,
48316,
1734,
12,
12362,
279,
4495,
1396,
315,
6105,
369,
5865,
1734,
12,
66848,
311,
279,
4495,
828,
955,
1734,
12,
12362,
279,
6300,
8310,
369,
29782,
1734,
1734,
2746,
1070,
527,
904,
315,
279,
3485,
21294,
11,
18622,
279,
3319,
13,
1442,
1070,
527,
912,
21294,
11,
1120,
23645,
279,
4113,
3319,
3238,
55609,
198,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
9656,
44095,
76,
31683,
4194,
8345,
4194,
682,
5151,
76747,
60,
55609,
198,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
5649
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLCheckerTool.html |
b6e7d22167f6-3 | Whether the tool only accepts a single input.
model Config¶
Bases: Config
Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | [
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
5649,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLCheckerTool.html |
f6ba0f6406f6-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 property.
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.
param default: Optional[Any] = None¶
The default value of the property.
param description: Optional[str] = None¶
The description of the property.
param name: str [Required]¶
The name of the property.
param required: bool [Required]¶
Whether the property is required.
param type: Union[str, Type, tuple, None, enum.Enum] = None¶
The type of the property.
Either a primitive type, a component/parameter type,
or an array or ‘object’ (dict) of the above. | [
5317,
8995,
24029,
59920,
8576,
6314,
31892,
25967,
3128,
4066,
55609,
198,
1058,
8859,
8995,
24029,
59920,
8576,
6314,
31892,
25967,
3128,
4066,
4163,
11,
836,
25,
610,
11,
2631,
25,
1845,
11,
955,
25,
9323,
17752,
11,
4078,
11,
14743,
11,
2290,
11,
14416,
60,
284,
2290,
11,
1670,
25,
12536,
71401,
60,
284,
2290,
11,
4096,
25,
12536,
17752,
60,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
4066,
1646,
369,
459,
5446,
3424,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
1670,
25,
12536,
71401,
60,
284,
2290,
55609,
198,
791,
1670,
907,
315,
279,
3424,
627,
913,
4096,
25,
12536,
17752,
60,
284,
2290,
55609,
198,
791,
4096,
315,
279,
3424,
627,
913,
836,
25,
610,
510,
8327,
60,
55609,
198,
791,
836,
315,
279,
3424,
627,
913,
2631,
25,
1845,
510,
8327,
60,
55609,
198,
25729,
279,
3424,
374,
2631,
627,
913,
955,
25,
9323,
17752,
11,
4078,
11,
14743,
11,
2290,
11,
7773,
44325,
60,
284,
2290,
55609,
198,
791,
955,
315,
279,
3424,
627,
50344,
264,
28694,
955,
11,
264,
3777,
14,
16577,
955,
345,
269,
459,
1358,
477,
3451,
1735,
529,
320,
8644,
8,
315,
279,
3485,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.openapi.utils.api_models.APIPropertyBase.html |
d3bec6605cf2-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 arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
param bcc: Optional[List[str]] = None¶
The list of BCC recipients.
param cc: Optional[List[str]] = None¶
The list of CC recipients.
param message: str [Required]¶
The message to include in the draft.
param subject: str [Required]¶
The subject of the message.
param to: List[str] [Required]¶
The list of recipients. | [
5317,
8995,
24029,
73054,
2581,
92439,
7399,
51186,
8802,
55609,
198,
1058,
8859,
8995,
24029,
73054,
2581,
92439,
7399,
51186,
8802,
4163,
11,
1984,
25,
610,
11,
311,
25,
1796,
17752,
1145,
3917,
25,
610,
11,
12810,
25,
12536,
53094,
17752,
5163,
284,
2290,
11,
293,
641,
25,
12536,
53094,
17752,
5163,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
293,
641,
25,
12536,
53094,
17752,
5163,
284,
2290,
55609,
198,
791,
1160,
315,
426,
3791,
34876,
627,
913,
12810,
25,
12536,
53094,
17752,
5163,
284,
2290,
55609,
198,
791,
1160,
315,
13844,
34876,
627,
913,
1984,
25,
610,
510,
8327,
60,
55609,
198,
791,
1984,
311,
2997,
304,
279,
10165,
627,
913,
3917,
25,
610,
510,
8327,
60,
55609,
198,
791,
3917,
315,
279,
1984,
627,
913,
311,
25,
1796,
17752,
60,
510,
8327,
60,
55609,
198,
791,
1160,
315,
34876,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.gmail.create_draft.CreateDraftSchema.html |
2774c27e49e3-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 keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
param bcc: Optional[List[str]] = None¶
The list of BCC recipients.
param body: str [Required]¶
The message body to be sent.
param cc: Optional[List[str]] = None¶
The list of CC recipients.
param subject: str [Required]¶
The subject of the message.
param to: List[str] [Required]¶
The list of recipients. | [
5317,
8995,
24029,
100193,
12676,
5331,
6598,
67430,
8802,
55609,
198,
1058,
8859,
8995,
24029,
100193,
12676,
5331,
6598,
67430,
8802,
4163,
11,
2547,
25,
610,
11,
311,
25,
1796,
17752,
1145,
3917,
25,
610,
11,
12810,
25,
12536,
53094,
17752,
5163,
284,
2290,
11,
293,
641,
25,
12536,
53094,
17752,
5163,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
293,
641,
25,
12536,
53094,
17752,
5163,
284,
2290,
55609,
198,
791,
1160,
315,
426,
3791,
34876,
627,
913,
2547,
25,
610,
510,
8327,
60,
55609,
198,
791,
1984,
2547,
311,
387,
3288,
627,
913,
12810,
25,
12536,
53094,
17752,
5163,
284,
2290,
55609,
198,
791,
1160,
315,
13844,
34876,
627,
913,
3917,
25,
610,
510,
8327,
60,
55609,
198,
791,
3917,
315,
279,
1984,
627,
913,
311,
25,
1796,
17752,
60,
510,
8327,
60,
55609,
198,
791,
1160,
315,
34876,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.office365.send_message.SendMessageSchema.html |
7f47d6749346-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[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, url: str)[source]¶
Bases: BaseTool
IFTTT Webhook.
Parameters
name – name of the tool
description – description of the tool
url – url to hit with the json event.
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.
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 description: str [Required]¶
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 [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 | [
5317,
8995,
24029,
13,
2130,
5683,
2506,
4082,
15249,
6109,
21543,
55609,
198,
1058,
8859,
8995,
24029,
13,
2130,
5683,
2506,
4082,
15249,
6109,
21543,
4163,
11,
836,
25,
610,
11,
4096,
25,
610,
11,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
2576,
25,
610,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
14627,
15249,
5000,
21543,
627,
9905,
198,
609,
1389,
836,
315,
279,
5507,
198,
4789,
1389,
4096,
315,
279,
5507,
198,
1103,
1389,
2576,
311,
4295,
449,
279,
3024,
1567,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
510,
8327,
60,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
510,
8327,
60,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.ifttt.IFTTTWebhook.html |
7f47d6749346-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 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: 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 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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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'¶ | [
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
2576,
25,
610,
510,
8327,
60,
55609,
198,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.ifttt.IFTTTWebhook.html |
6665769ea8ce-0 | langchain.tools.spark_sql.tool.QueryCheckerTool¶
class langchain.tools.spark_sql.tool.QueryCheckerTool(*, name: str = 'query_checker_sql_db', 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_sql_db!\n ', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, db: SparkSQL, template: str = '\n{query}\nDouble check the Spark SQL query above for common mistakes, including:\n- Using NOT IN with NULL values\n- Using UNION when UNION ALL should have been used\n- Using BETWEEN for exclusive ranges\n- Data type mismatch in predicates\n- Properly quoting identifiers\n- Using the correct number of arguments for functions\n- Casting to the correct data type\n- Using the proper columns for joins\n\nIf there are any of the above mistakes, rewrite the query. If there are no mistakes, just reproduce the original query.', llm: BaseLanguageModel, llm_chain: LLMChain)[source]¶
Bases: BaseSparkSQLTool, BaseTool
Use an LLM to check if a query is correct.
Adapted from https://www.patterns.app/blog/2023/01/18/crunchbot-sql-analyst-gpt/
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.
param args_schema: Optional[Type[BaseModel]] = None¶ | [
5317,
8995,
24029,
33646,
18554,
21966,
16060,
36288,
7896,
55609,
198,
1058,
8859,
8995,
24029,
33646,
18554,
21966,
16060,
36288,
7896,
4163,
11,
836,
25,
610,
284,
364,
1663,
63815,
18554,
8856,
518,
4096,
25,
610,
284,
5307,
77,
46493,
5560,
420,
5507,
311,
2033,
1817,
422,
701,
3319,
374,
4495,
1603,
31320,
433,
7255,
77,
46493,
24119,
1005,
420,
5507,
1603,
31320,
264,
3319,
449,
3319,
18554,
8856,
15114,
77,
46493,
6752,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
3000,
25,
27565,
6827,
11,
3896,
25,
610,
284,
5307,
77,
90,
1663,
11281,
77,
7530,
1817,
279,
27565,
8029,
3319,
3485,
369,
4279,
21294,
11,
2737,
7338,
77,
12,
12362,
4276,
2006,
449,
1808,
2819,
1734,
12,
12362,
78653,
994,
78653,
13398,
1288,
617,
1027,
1511,
1734,
12,
12362,
57739,
369,
14079,
21986,
1734,
12,
2956,
955,
36401,
304,
81127,
1734,
12,
65658,
398,
57618,
48316,
1734,
12,
12362,
279,
4495,
1396,
315,
6105,
369,
5865,
1734,
12,
66848,
311,
279,
4495,
828,
955,
1734,
12,
12362,
279,
6300,
8310,
369,
29782,
1734,
1734,
2746,
1070,
527,
904,
315,
279,
3485,
21294,
11,
18622,
279,
3319,
13,
1442,
1070,
527,
912,
21294,
11,
1120,
23645,
279,
4113,
3319,
16045,
9507,
76,
25,
5464,
14126,
1747,
11,
9507,
76,
31683,
25,
445,
11237,
19368,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
68583,
6827,
7896,
11,
5464,
7896,
198,
10464,
459,
445,
11237,
311,
1817,
422,
264,
3319,
374,
4495,
627,
2654,
2756,
291,
505,
3788,
1129,
2185,
40209,
82,
1632,
38562,
14,
2366,
18,
14,
1721,
14,
972,
2971,
81,
3265,
6465,
1355,
1498,
19415,
278,
599,
2427,
418,
6018,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.spark_sql.tool.QueryCheckerTool.html |
6665769ea8ce-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: SparkSQL [Required]¶
param 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_sql_db!\n '¶
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 llm: langchain.base_language.BaseLanguageModel [Required]¶
param llm_chain: langchain.chains.llm.LLMChain [Required]¶
param name: str = 'query_checker_sql_db'¶
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. | [
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
3000,
25,
27565,
6827,
510,
8327,
60,
55609,
198,
913,
4096,
25,
610,
284,
5307,
77,
46493,
5560,
420,
5507,
311,
2033,
1817,
422,
701,
3319,
374,
4495,
1603,
31320,
433,
7255,
77,
46493,
24119,
1005,
420,
5507,
1603,
31320,
264,
3319,
449,
3319,
18554,
8856,
15114,
77,
46493,
364,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
9507,
76,
25,
8859,
8995,
9105,
30121,
13316,
14126,
1747,
510,
8327,
60,
55609,
198,
913,
9507,
76,
31683,
25,
8859,
8995,
5442,
1771,
60098,
76,
1236,
11237,
19368,
510,
8327,
60,
55609,
198,
913,
836,
25,
610,
284,
364,
1663,
63815,
18554,
8856,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.spark_sql.tool.QueryCheckerTool.html |
6665769ea8ce-2 | that after the tool is called, the AgentExecutor will stop looping.
param template: str = '\n{query}\nDouble check the Spark SQL query above for common mistakes, including:\n- Using NOT IN with NULL values\n- Using UNION when UNION ALL should have been used\n- Using BETWEEN for exclusive ranges\n- Data type mismatch in predicates\n- Properly quoting identifiers\n- Using the correct number of arguments for functions\n- Casting to the correct data type\n- Using the proper columns for joins\n\nIf there are any of the above mistakes, rewrite the query. If there are no mistakes, just reproduce the original query.'¶
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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool asynchronously.
validator initialize_llm_chain » all fields[source]¶
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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool.
property args: dict¶
property is_single_input: bool¶
Whether the tool only accepts a single input.
model Config¶
Bases: Config | [
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
3896,
25,
610,
284,
5307,
77,
90,
1663,
11281,
77,
7530,
1817,
279,
27565,
8029,
3319,
3485,
369,
4279,
21294,
11,
2737,
7338,
77,
12,
12362,
4276,
2006,
449,
1808,
2819,
1734,
12,
12362,
78653,
994,
78653,
13398,
1288,
617,
1027,
1511,
1734,
12,
12362,
57739,
369,
14079,
21986,
1734,
12,
2956,
955,
36401,
304,
81127,
1734,
12,
65658,
398,
57618,
48316,
1734,
12,
12362,
279,
4495,
1396,
315,
6105,
369,
5865,
1734,
12,
66848,
311,
279,
4495,
828,
955,
1734,
12,
12362,
279,
6300,
8310,
369,
29782,
1734,
1734,
2746,
1070,
527,
904,
315,
279,
3485,
21294,
11,
18622,
279,
3319,
13,
1442,
1070,
527,
912,
21294,
11,
1120,
23645,
279,
4113,
3319,
3238,
55609,
198,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
9656,
44095,
76,
31683,
4194,
8345,
4194,
682,
5151,
76747,
60,
55609,
198,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
5649
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.spark_sql.tool.QueryCheckerTool.html |
6665769ea8ce-3 | Whether the tool only accepts a single input.
model Config¶
Bases: Config
Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | [
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
5649,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.spark_sql.tool.QueryCheckerTool.html |
b2be7a617147-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 | [
5317,
8995,
24029,
13269,
53852,
8576,
673,
11327,
6257,
55609,
198,
5317,
8995,
24029,
13269,
53852,
8576,
673,
11327,
6257,
52920,
25,
30037,
18360,
8,
11651,
30037,
2732,
76747,
60,
55609,
198,
1991,
279,
1510,
2199,
315,
279,
7074,
627,
68416,
7074,
25,
578,
7074,
311,
636,
279,
1510,
2199,
505,
627,
16851,
198,
791,
1510,
2199,
627,
5715,
955,
198,
12430,
2732
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.utils.get_current_page.html |
4eb6aeeaafa4-0 | langchain.tools.plugin.marshal_spec¶
langchain.tools.plugin.marshal_spec(txt: str) → dict[source]¶
Convert the yaml or json serialized spec to a dict.
Parameters
txt – The yaml or json serialized spec.
Returns
The spec as a dict.
Return type
dict | [
5317,
8995,
24029,
28067,
749,
29523,
13908,
55609,
198,
5317,
8995,
24029,
28067,
749,
29523,
13908,
27174,
25,
610,
8,
11651,
6587,
76747,
60,
55609,
198,
12281,
279,
33346,
477,
3024,
34016,
1424,
311,
264,
6587,
627,
9905,
198,
8754,
1389,
578,
33346,
477,
3024,
34016,
1424,
627,
16851,
198,
791,
1424,
439,
264,
6587,
627,
5715,
955,
198,
8644
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.plugin.marshal_spec.html |
e9826a9f200b-0 | langchain.tools.playwright.click.ClickTool¶
class langchain.tools.playwright.click.ClickTool(*, name: str = 'click_element', description: str = 'Click on an element with the given CSS selector', args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'langchain.tools.playwright.click.ClickToolInput'>, return_direct: bool = False, verbose: bool = False, callbacks: ~typing.Optional[~typing.Union[~typing.List[~langchain.callbacks.base.BaseCallbackHandler], ~langchain.callbacks.base.BaseCallbackManager]] = None, callback_manager: ~typing.Optional[~langchain.callbacks.base.BaseCallbackManager] = None, handle_tool_error: ~typing.Optional[~typing.Union[bool, str, ~typing.Callable[[~langchain.tools.base.ToolException], str]]] = False, sync_browser: Optional['SyncBrowser'] = None, async_browser: Optional['AsyncBrowser'] = None, visible_only: bool = True, playwright_strict: bool = False, playwright_timeout: float = 1000)[source]¶
Bases: BaseBrowserTool
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.
param args_schema: Type[BaseModel] = <class 'langchain.tools.playwright.click.ClickToolInput'>¶
Pydantic model class to validate and parse the tool’s input arguments.
param async_browser: Optional['AsyncBrowser'] = None¶
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 = 'Click on an element with the given CSS selector'¶
Used to tell the model how/when/why to use the tool. | [
5317,
8995,
24029,
13269,
53852,
14798,
11566,
7896,
55609,
198,
1058,
8859,
8995,
24029,
13269,
53852,
14798,
11566,
7896,
4163,
11,
836,
25,
610,
284,
364,
3763,
8053,
518,
4096,
25,
610,
284,
364,
2677,
389,
459,
2449,
449,
279,
2728,
15533,
9551,
518,
2897,
26443,
25,
4056,
90902,
10394,
58,
93,
3368,
67,
8322,
9056,
13316,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
13269,
53852,
14798,
11566,
7896,
2566,
6404,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
93,
90902,
5937,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
3126,
1145,
4056,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
4056,
90902,
37464,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
2707,
11,
610,
11,
4056,
90902,
28115,
481,
15873,
93,
5317,
8995,
24029,
9105,
25443,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
13105,
54514,
25,
12536,
681,
12430,
18360,
663,
284,
2290,
11,
3393,
54514,
25,
12536,
681,
6662,
18360,
663,
284,
2290,
11,
9621,
18917,
25,
1845,
284,
3082,
11,
99468,
2966,
858,
25,
1845,
284,
3641,
11,
99468,
21179,
25,
2273,
284,
220,
1041,
15,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
18360,
7896,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
4078,
58,
4066,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
13269,
53852,
14798,
11566,
7896,
2566,
6404,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
3393,
54514,
25,
12536,
681,
6662,
18360,
663,
284,
2290,
55609,
198,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
2677,
389,
459,
2449,
449,
279,
2728,
15533,
9551,
6,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.click.ClickTool.html |
e9826a9f200b-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 = 'click_element'¶
The unique name of the tool that clearly communicates its purpose.
param playwright_strict: bool = False¶
Whether to employ Playwright’s strict mode when clicking on elements.
param playwright_timeout: float = 1000¶
Timeout (in ms) for Playwright to wait for element to be ready.
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 sync_browser: Optional['SyncBrowser'] = None¶
param verbose: bool = False¶
Whether to log the tool’s progress.
param visible_only: bool = True¶
Whether to consider only visible elements.
__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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool asynchronously.
classmethod from_browser(sync_browser: Optional[SyncBrowser] = None, async_browser: Optional[AsyncBrowser] = None) → BaseBrowserTool¶
Instantiate the tool.
validator raise_deprecation » all fields¶
Raise deprecation warning if callback_manager is used. | [
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
3763,
8053,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
99468,
2966,
858,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
3539,
7199,
53852,
753,
7452,
3941,
994,
18965,
389,
5540,
627,
913,
99468,
21179,
25,
2273,
284,
220,
1041,
15,
55609,
198,
7791,
320,
258,
10030,
8,
369,
7199,
53852,
311,
3868,
369,
2449,
311,
387,
5644,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
13105,
54514,
25,
12536,
681,
12430,
18360,
663,
284,
2290,
55609,
198,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
913,
9621,
18917,
25,
1845,
284,
3082,
55609,
198,
25729,
311,
2980,
1193,
9621,
5540,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
27853,
505,
54514,
98333,
54514,
25,
12536,
58,
12430,
18360,
60,
284,
2290,
11,
3393,
54514,
25,
12536,
58,
6662,
18360,
60,
284,
2290,
8,
11651,
5464,
18360,
7896,
55609,
198,
81651,
279,
5507,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.click.ClickTool.html |
e9826a9f200b-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 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'¶ | [
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
16503,
9788,
54514,
2602,
44057,
4194,
8345,
4194,
682,
5151,
55609,
198,
4061,
430,
279,
6105,
527,
2764,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.click.ClickTool.html |
9b667da0b95e-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 valid model.
param selector: str [Required]¶
CSS selector for the element to click | [
5317,
8995,
24029,
13269,
53852,
14798,
11566,
7896,
2566,
55609,
198,
1058,
8859,
8995,
24029,
13269,
53852,
14798,
11566,
7896,
2566,
4163,
11,
9551,
25,
610,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
2566,
369,
9369,
7896,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
9551,
25,
610,
510,
8327,
60,
55609,
198,
34758,
9551,
369,
279,
2449,
311,
4299
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.click.ClickToolInput.html |
57874508081d-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.
param message_id: str [Required]¶
The unique ID of the email message, retrieved from a search. | [
5317,
8995,
24029,
73054,
673,
6598,
33003,
4209,
8802,
55609,
198,
1058,
8859,
8995,
24029,
73054,
673,
6598,
33003,
4209,
8802,
4163,
11,
1984,
851,
25,
610,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
1984,
851,
25,
610,
510,
8327,
60,
55609,
198,
791,
5016,
3110,
315,
279,
2613,
1984,
11,
31503,
505,
264,
2778,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.gmail.get_message.SearchArgsSchema.html |
fbd7a69cd096-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 ValidationError if the input data cannot be parsed to form a valid model.
param attributes: List[str] [Optional]¶
Set of attributes to retrieve for each element
param selector: str [Required]¶
CSS selector, such as ‘*’, ‘div’, ‘p’, ‘a’, #id, .classname | [
5317,
8995,
24029,
13269,
53852,
673,
23646,
2283,
12132,
7896,
2566,
55609,
198,
1058,
8859,
8995,
24029,
13269,
53852,
673,
23646,
2283,
12132,
7896,
2566,
4163,
11,
9551,
25,
610,
11,
8365,
25,
1796,
17752,
60,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
2566,
369,
2175,
12132,
7896,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
8365,
25,
1796,
17752,
60,
510,
15669,
60,
55609,
198,
1681,
315,
8365,
311,
17622,
369,
1855,
2449,
198,
913,
9551,
25,
610,
510,
8327,
60,
55609,
198,
34758,
9551,
11,
1778,
439,
3451,
9,
20182,
3451,
614,
20182,
3451,
79,
20182,
3451,
64,
20182,
674,
307,
11,
662,
63906
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.get_elements.GetElementsToolInput.html |
1766a8551f88-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 valid model.
param tool_input: Optional[str] = ''¶ | [
5317,
8995,
24029,
28067,
89878,
11807,
7896,
8802,
55609,
198,
1058,
8859,
8995,
24029,
28067,
89878,
11807,
7896,
8802,
4163,
11,
5507,
6022,
25,
12536,
17752,
60,
284,
364,
13588,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
15836,
2989,
3715,
7896,
8802,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
5507,
6022,
25,
12536,
17752,
60,
284,
3436,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.plugin.AIPluginToolSchema.html |
f2db9be1f4e7-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]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, prompt_func: Callable[[str], None] = None, input_func: Callable = None)[source]¶
Bases: BaseTool
Tool that adds the capability to ask user for input.
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.
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 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.'¶
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¶ | [
5317,
8995,
24029,
870,
7282,
21966,
3924,
7282,
2566,
6869,
55609,
198,
1058,
8859,
8995,
24029,
870,
7282,
21966,
3924,
7282,
2566,
6869,
4163,
11,
836,
25,
610,
284,
364,
26380,
518,
4096,
25,
610,
284,
364,
2675,
649,
2610,
264,
3823,
369,
19351,
994,
499,
1781,
499,
2751,
16075,
477,
499,
527,
539,
2771,
1148,
311,
656,
1828,
13,
578,
1988,
1288,
387,
264,
3488,
369,
279,
3823,
16045,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
10137,
9791,
25,
54223,
15873,
496,
1145,
2290,
60,
284,
2290,
11,
1988,
9791,
25,
54223,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
7896,
430,
11621,
279,
23099,
311,
2610,
1217,
369,
1988,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
2675,
649,
2610,
264,
3823,
369,
19351,
994,
499,
1781,
499,
2751,
16075,
477,
499,
527,
539,
2771,
1148,
311,
656,
1828,
13,
578,
1988,
1288,
387,
264,
3488,
369,
279,
3823,
3238,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.human.tool.HumanInputRun.html |
f2db9be1f4e7-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. 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¶
Make tool callable.
async arun(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 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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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'¶ | [
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
1988,
9791,
25,
54223,
510,
15669,
60,
55609,
198,
913,
836,
25,
610,
284,
364,
26380,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
10137,
9791,
25,
54223,
15873,
496,
1145,
2290,
60,
510,
15669,
60,
55609,
198,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.human.tool.HumanInputRun.html |
92124f4accab-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]] | [
5317,
8995,
24029,
13269,
53852,
9105,
85221,
18941,
22932,
53852,
890,
91658,
55609,
198,
5317,
8995,
24029,
13269,
53852,
9105,
85221,
18941,
22932,
53852,
890,
91658,
368,
11651,
25645,
58,
941,
58,
6662,
18360,
1145,
4078,
58,
12430,
18360,
28819,
2484,
60,
55609,
198,
40866,
1179,
99468,
33957,
627,
16851,
198,
6662,
18360,
323,
30037,
18360,
6989,
627,
5715,
955,
198,
29781,
58,
941,
58,
6662,
18360,
1145,
4078,
58,
12430,
18360,
5163
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.playwright.base.lazy_import_playwright_browsers.html |
f716891637ff-0 | langchain.tools.powerbi.tool.QueryPowerBITool¶ | [
5317,
8995,
24029,
40645,
8385,
21966,
16060,
15335,
21587,
1786,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
f716891637ff-1 | class langchain.tools.powerbi.tool.QueryPowerBITool(*, name: str = 'query_powerbi', description: str = '\n Input to this tool is a detailed question about the dataset, output is a result from the dataset. It will try to answer the question using the dataset, and if it cannot, it will ask for clarification.\n\n Example Input: "How many rows are in table1?"\n ', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, llm_chain: LLMChain, powerbi: PowerBIDataset, template: Optional[str] = '\nAnswer the question below with a DAX query that can be sent to Power BI. DAX queries have a simple syntax comprised of just one required keyword, EVALUATE, and several optional keywords: ORDER BY, START AT, DEFINE, MEASURE, VAR, TABLE, and COLUMN. Each keyword defines a statement used for the duration of the query. Any time < or > are used in the text below it means that those values need to be replaced by table, columns or other things. If the question is not something you can answer with a DAX query, reply with "I cannot answer this" and the question will be escalated to a human.\n\nSome DAX functions return a table instead of a scalar, and must be wrapped in a function that evaluates the table and returns a scalar; unless the table is a single column, single row table, then it is treated as a scalar value. Most DAX functions require one or more arguments, which can include tables, columns, expressions, and values. | [
1058,
8859,
8995,
24029,
40645,
8385,
21966,
16060,
15335,
21587,
1786,
4163,
11,
836,
25,
610,
284,
364,
1663,
21052,
8385,
518,
4096,
25,
610,
284,
5307,
77,
46493,
5688,
311,
420,
5507,
374,
264,
11944,
3488,
922,
279,
10550,
11,
2612,
374,
264,
1121,
505,
279,
10550,
13,
1102,
690,
1456,
311,
4320,
279,
3488,
1701,
279,
10550,
11,
323,
422,
433,
4250,
11,
433,
690,
2610,
369,
64784,
7255,
77,
1734,
46493,
13688,
5688,
25,
330,
4438,
1690,
7123,
527,
304,
2007,
16,
7673,
59,
77,
46493,
6752,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
9507,
76,
31683,
25,
445,
11237,
19368,
11,
2410,
8385,
25,
7572,
33,
926,
8534,
11,
3896,
25,
12536,
17752,
60,
284,
5307,
77,
16533,
279,
3488,
3770,
449,
264,
423,
3027,
3319,
430,
649,
387,
3288,
311,
7572,
48153,
13,
423,
3027,
20126,
617,
264,
4382,
20047,
40056,
315,
1120,
832,
2631,
16570,
11,
97492,
52,
2390,
11,
323,
3892,
10309,
21513,
25,
15888,
7866,
11,
21673,
7520,
11,
68014,
11,
16691,
73269,
11,
44608,
11,
14700,
11,
323,
40123,
13,
9062,
16570,
19170,
264,
5224,
1511,
369,
279,
8250,
315,
279,
3319,
13,
5884,
892,
366,
477,
871,
527,
1511,
304,
279,
1495,
3770,
433,
3445,
430,
1884,
2819,
1205,
311,
387,
12860,
555,
2007,
11,
8310,
477,
1023,
2574,
13,
1442,
279,
3488,
374,
539,
2555,
499,
649,
4320,
449,
264,
423,
3027,
3319,
11,
10052,
449,
330,
40,
4250,
4320,
420,
1,
323,
279,
3488,
690,
387,
81700,
311,
264,
3823,
7255,
77,
1734,
8538,
423,
3027,
5865,
471,
264,
2007,
4619,
315,
264,
17722,
11,
323,
2011,
387,
20037,
304,
264,
734,
430,
67349,
279,
2007,
323,
4780,
264,
17722,
26,
7389,
279,
2007,
374,
264,
3254,
3330,
11,
3254,
2872,
2007,
11,
1243,
433,
374,
12020,
439,
264,
17722,
907,
13,
7648,
423,
3027,
5865,
1397,
832,
477,
810,
6105,
11,
902,
649,
2997,
12920,
11,
8310,
11,
24282,
11,
323,
2819,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
f716891637ff-2 | functions require one or more arguments, which can include tables, columns, expressions, and values. However, some functions, such as PI, do not require any arguments, but always require parentheses to indicate the null argument. For example, you must always type PI(), not PI. You can also nest functions within other functions. \n\nSome commonly used functions are:\nEVALUATE <table> - At the most basic level, a DAX query is an EVALUATE statement containing a table expression. At least one EVALUATE statement is required, however, a query can contain any number of EVALUATE statements.\nEVALUATE <table> ORDER BY <expression> ASC or DESC - The optional ORDER BY keyword defines one or more expressions used to sort query results. Any expression that can be evaluated for each row of the result is valid.\nEVALUATE <table> ORDER BY <expression> ASC or DESC START AT <value> or <parameter> - The optional START AT keyword is used inside an ORDER BY clause. It defines the value at which the query results begin.\nDEFINE MEASURE | VAR; EVALUATE <table> - The optional DEFINE keyword introduces one or more calculated entity definitions that exist only for the duration of the query. Definitions precede the EVALUATE statement and are valid for all EVALUATE statements in the query. Definitions can be variables, measures, tables1, and columns1. Definitions can reference other definitions that appear before or after the current definition. At least one definition is required if the DEFINE keyword is included in a query.\nMEASURE <table name>[<measure name>] = <scalar expression> - Introduces a measure definition in a DEFINE statement of a DAX query.\nVAR <name> = <expression> - Stores the result of an expression as a named variable, which can then be passed as an argument to other measure expressions. Once resultant values have been calculated for | [
22124,
1397,
832,
477,
810,
6105,
11,
902,
649,
2997,
12920,
11,
8310,
11,
24282,
11,
323,
2819,
13,
4452,
11,
1063,
5865,
11,
1778,
439,
23396,
11,
656,
539,
1397,
904,
6105,
11,
719,
2744,
1397,
75075,
311,
13519,
279,
854,
5811,
13,
1789,
3187,
11,
499,
2011,
2744,
955,
23396,
1535,
539,
23396,
13,
1472,
649,
1101,
23634,
5865,
2949,
1023,
5865,
13,
1144,
77,
1734,
8538,
17037,
1511,
5865,
527,
7338,
77,
36,
5711,
52,
2390,
366,
2048,
29,
482,
2468,
279,
1455,
6913,
2237,
11,
264,
423,
3027,
3319,
374,
459,
97492,
52,
2390,
5224,
8649,
264,
2007,
7645,
13,
2468,
3325,
832,
97492,
52,
2390,
5224,
374,
2631,
11,
4869,
11,
264,
3319,
649,
6782,
904,
1396,
315,
97492,
52,
2390,
12518,
7255,
77,
36,
5711,
52,
2390,
366,
2048,
29,
15888,
7866,
366,
29199,
29,
20382,
477,
16477,
482,
578,
10309,
15888,
7866,
16570,
19170,
832,
477,
810,
24282,
1511,
311,
3460,
3319,
3135,
13,
5884,
7645,
430,
649,
387,
26126,
369,
1855,
2872,
315,
279,
1121,
374,
2764,
7255,
77,
36,
5711,
52,
2390,
366,
2048,
29,
15888,
7866,
366,
29199,
29,
20382,
477,
16477,
21673,
7520,
366,
970,
29,
477,
366,
16577,
29,
482,
578,
10309,
21673,
7520,
16570,
374,
1511,
4871,
459,
15888,
7866,
22381,
13,
1102,
19170,
279,
907,
520,
902,
279,
3319,
3135,
3240,
7255,
77,
36972,
16691,
73269,
765,
44608,
26,
97492,
52,
2390,
366,
2048,
29,
482,
578,
10309,
68014,
16570,
40019,
832,
477,
810,
16997,
5502,
17931,
430,
3073,
1193,
369,
279,
8250,
315,
279,
3319,
13,
47613,
16599,
68,
279,
97492,
52,
2390,
5224,
323,
527,
2764,
369,
682,
97492,
52,
2390,
12518,
304,
279,
3319,
13,
47613,
649,
387,
7482,
11,
11193,
11,
12920,
16,
11,
323,
8310,
16,
13,
47613,
649,
5905,
1023,
17931,
430,
5101,
1603,
477,
1306,
279,
1510,
7419,
13,
2468,
3325,
832,
7419,
374,
2631,
422,
279,
68014,
16570,
374,
5343,
304,
264,
3319,
7255,
77,
7614,
73269,
366,
2048,
836,
31868,
27,
48899,
836,
54629,
284,
366,
36442,
7645,
29,
482,
1357,
4653,
1634,
264,
6767,
7419,
304,
264,
68014,
5224,
315,
264,
423,
3027,
3319,
7255,
77,
34140,
366,
609,
29,
284,
366,
29199,
29,
482,
39402,
279,
1121,
315,
459,
7645,
439,
264,
7086,
3977,
11,
902,
649,
1243,
387,
5946,
439,
459,
5811,
311,
1023,
6767,
24282,
13,
9843,
84913,
2819,
617,
1027,
16997,
369
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
f716891637ff-3 | which can then be passed as an argument to other measure expressions. Once resultant values have been calculated for a variable expression, those values do not change, even if the variable is referenced in another expression.\n\nFILTER(<table>,<filter>) - Returns a table that represents a subset of another table or expression, where <filter> is a Boolean expression that is to be evaluated for each row of the table. For example, [Amount] > 0 or [Region] = "France"\nROW(<name>, <expression>) - Returns a table with a single row containing values that result from the expressions given to each column.\nDISTINCT(<column>) - Returns a one-column table that contains the distinct values from the specified column. In other words, duplicate values are removed and only unique values are returned. This function cannot be used to Return values into a cell or column on a worksheet; rather, you nest the DISTINCT function within a formula, to get a list of distinct values that can be passed to another function and then counted, summed, or used for other operations.\nDISTINCT(<table>) - Returns a table by removing duplicate rows from another table or expression.\n\nAggregation functions, names with a A in it, handle booleans and empty strings in appropriate ways, while the same function without A only uses the numeric values in a column. Functions names with an X in it can include a expression as an argument, this will be evaluated for each row in the table and the result will be used in the regular function calculation, these are the functions:\nCOUNT(<column>), COUNTA(<column>), COUNTX(<table>,<expression>), COUNTAX(<table>,<expression>), COUNTROWS([<table>]), COUNTBLANK(<column>), DISTINCTCOUNT(<column>), DISTINCTCOUNTNOBLANK (<column>) - these are all variantions of count functions.\nAVERAGE(<column>), | [
8370,
649,
1243,
387,
5946,
439,
459,
5811,
311,
1023,
6767,
24282,
13,
9843,
84913,
2819,
617,
1027,
16997,
369,
264,
3977,
7645,
11,
1884,
2819,
656,
539,
2349,
11,
1524,
422,
279,
3977,
374,
25819,
304,
2500,
7645,
7255,
77,
1734,
62480,
23561,
2048,
8226,
27,
5428,
9414,
482,
5295,
264,
2007,
430,
11105,
264,
27084,
315,
2500,
2007,
477,
7645,
11,
1405,
366,
5428,
29,
374,
264,
7137,
7645,
430,
374,
311,
387,
26126,
369,
1855,
2872,
315,
279,
2007,
13,
1789,
3187,
11,
510,
10301,
60,
871,
220,
15,
477,
510,
14422,
60,
284,
330,
50100,
12200,
77,
15445,
23561,
609,
8226,
366,
29199,
9414,
482,
5295,
264,
2007,
449,
264,
3254,
2872,
8649,
2819,
430,
1121,
505,
279,
24282,
2728,
311,
1855,
3330,
7255,
77,
80540,
46419,
23561,
6361,
9414,
482,
5295,
264,
832,
26005,
2007,
430,
5727,
279,
12742,
2819,
505,
279,
5300,
3330,
13,
763,
1023,
4339,
11,
23329,
2819,
527,
7108,
323,
1193,
5016,
2819,
527,
6052,
13,
1115,
734,
4250,
387,
1511,
311,
3494,
2819,
1139,
264,
2849,
477,
3330,
389,
264,
37736,
26,
4856,
11,
499,
23634,
279,
60186,
734,
2949,
264,
15150,
11,
311,
636,
264,
1160,
315,
12742,
2819,
430,
649,
387,
5946,
311,
2500,
734,
323,
1243,
31094,
11,
66766,
11,
477,
1511,
369,
1023,
7677,
7255,
77,
80540,
46419,
23561,
2048,
9414,
482,
5295,
264,
2007,
555,
18054,
23329,
7123,
505,
2500,
2007,
477,
7645,
7255,
77,
1734,
9219,
35542,
5865,
11,
5144,
449,
264,
362,
304,
433,
11,
3790,
712,
98099,
323,
4384,
9246,
304,
8475,
5627,
11,
1418,
279,
1890,
734,
2085,
362,
1193,
5829,
279,
25031,
2819,
304,
264,
3330,
13,
24460,
5144,
449,
459,
1630,
304,
433,
649,
2997,
264,
7645,
439,
459,
5811,
11,
420,
690,
387,
26126,
369,
1855,
2872,
304,
279,
2007,
323,
279,
1121,
690,
387,
1511,
304,
279,
5912,
734,
22702,
11,
1521,
527,
279,
5865,
7338,
77,
39243,
23561,
6361,
29,
705,
24945,
32,
23561,
6361,
29,
705,
24945,
55,
23561,
2048,
8226,
27,
29199,
29,
705,
24945,
3027,
23561,
2048,
8226,
27,
29199,
29,
705,
24945,
38242,
2625,
27,
2048,
29,
9918,
24945,
9574,
16395,
23561,
6361,
29,
705,
60186,
39243,
23561,
6361,
29,
705,
60186,
39243,
9173,
9574,
16395,
23246,
6361,
9414,
482,
1521,
527,
682,
11678,
919,
315,
1797,
5865,
7255,
77,
32,
61927,
23561,
6361,
29,
705
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
f716891637ff-4 | (<column>) - these are all variantions of count functions.\nAVERAGE(<column>), AVERAGEA(<column>), AVERAGEX(<table>,<expression>) - these are all variantions of average functions.\nMAX(<column>), MAXA(<column>), MAXX(<table>,<expression>) - these are all variantions of max functions.\nMIN(<column>), MINA(<column>), MINX(<table>,<expression>) - these are all variantions of min functions.\nPRODUCT(<column>), PRODUCTX(<table>,<expression>) - these are all variantions of product functions.\nSUM(<column>), SUMX(<table>,<expression>) - these are all variantions of sum functions.\n\nDate and time functions:\nDATE(year, month, day) - Returns a date value that represents the specified year, month, and day.\nDATEDIFF(date1, date2, <interval>) - Returns the difference between two date values, in the specified interval, that can be SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR.\nDATEVALUE(<date_text>) - Returns a date value that represents the specified date.\nYEAR(<date>), QUARTER(<date>), MONTH(<date>), DAY(<date>), HOUR(<date>), MINUTE(<date>), SECOND(<date>) - Returns the part of the date for the specified date.\n\nFinally, make sure to escape double quotes with a single backslash, and make sure that only table names have single quotes around them, while names of measures or the values of columns that you want to compare against are in escaped double quotes. Newlines are not necessary and can be skipped. The queries are serialized as json and so will have to fit be compliant with json syntax. Sometimes you will get a question, a DAX query and a error, in that case you need | [
23561,
6361,
9414,
482,
1521,
527,
682,
11678,
919,
315,
1797,
5865,
7255,
77,
32,
61927,
23561,
6361,
29,
705,
362,
61927,
32,
23561,
6361,
29,
705,
362,
3848,
1929,
3337,
23561,
2048,
8226,
27,
29199,
9414,
482,
1521,
527,
682,
11678,
919,
315,
5578,
5865,
7255,
77,
10809,
23561,
6361,
29,
705,
8498,
32,
23561,
6361,
29,
705,
8498,
55,
23561,
2048,
8226,
27,
29199,
9414,
482,
1521,
527,
682,
11678,
919,
315,
1973,
5865,
7255,
77,
16818,
23561,
6361,
29,
705,
17116,
32,
23561,
6361,
29,
705,
17116,
55,
23561,
2048,
8226,
27,
29199,
9414,
482,
1521,
527,
682,
11678,
919,
315,
1332,
5865,
7255,
77,
52531,
23561,
6361,
29,
705,
39183,
55,
23561,
2048,
8226,
27,
29199,
9414,
482,
1521,
527,
682,
11678,
919,
315,
2027,
5865,
7255,
77,
28477,
23561,
6361,
29,
705,
31835,
55,
23561,
2048,
8226,
27,
29199,
9414,
482,
1521,
527,
682,
11678,
919,
315,
2694,
5865,
7255,
77,
1734,
1956,
323,
892,
5865,
7338,
77,
7242,
29381,
11,
2305,
11,
1938,
8,
482,
5295,
264,
2457,
907,
430,
11105,
279,
5300,
1060,
11,
2305,
11,
323,
1938,
7255,
77,
37636,
30135,
12237,
16,
11,
2457,
17,
11,
366,
29004,
9414,
482,
5295,
279,
6811,
1990,
1403,
2457,
2819,
11,
304,
279,
5300,
10074,
11,
430,
649,
387,
69795,
11,
17116,
11701,
11,
97064,
11,
38788,
11,
58529,
11,
59080,
11,
27090,
3065,
643,
11,
52005,
7255,
77,
7242,
24771,
23561,
1045,
4424,
9414,
482,
5295,
264,
2457,
907,
430,
11105,
279,
5300,
2457,
7255,
77,
88301,
23561,
1045,
29,
705,
27090,
3065,
643,
23561,
1045,
29,
705,
59080,
23561,
1045,
29,
705,
38788,
23561,
1045,
29,
705,
97064,
23561,
1045,
29,
705,
17116,
11701,
23561,
1045,
29,
705,
69795,
23561,
1045,
9414,
482,
5295,
279,
961,
315,
279,
2457,
369,
279,
5300,
2457,
7255,
77,
1734,
24901,
11,
1304,
2771,
311,
12731,
2033,
17637,
449,
264,
3254,
1203,
51356,
11,
323,
1304,
2771,
430,
1193,
2007,
5144,
617,
3254,
17637,
2212,
1124,
11,
1418,
5144,
315,
11193,
477,
279,
2819,
315,
8310,
430,
499,
1390,
311,
9616,
2403,
527,
304,
28883,
2033,
17637,
13,
1561,
8128,
527,
539,
5995,
323,
649,
387,
36257,
13,
578,
20126,
527,
34016,
439,
3024,
323,
779,
690,
617,
311,
5052,
387,
49798,
449,
3024,
20047,
13,
18156,
499,
690,
636,
264,
3488,
11,
264,
423,
3027,
3319,
323,
264,
1493,
11,
304,
430,
1162,
499,
1205
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
f716891637ff-5 | Sometimes you will get a question, a DAX query and a error, in that case you need to rewrite the DAX query to get the correct answer.\n\nThe following tables exist: {tables}\n\nand the schema\'s for some are given here:\n{schemas}\n\nExamples:\n{examples}\n\nQuestion: {tool_input}\nDAX: \n', examples: Optional[str] = '\nQuestion: How many rows are in the table <table>?\nDAX: EVALUATE ROW("Number of rows", COUNTROWS(<table>))\n----\nQuestion: How many rows are in the table <table> where <column> is not empty?\nDAX: EVALUATE ROW("Number of rows", COUNTROWS(FILTER(<table>, <table>[<column>] <> "")))\n----\nQuestion: What was the average of <column> in <table>?\nDAX: EVALUATE ROW("Average", AVERAGE(<table>[<column>]))\n----\n', session_cache: Dict[str, Any] = None, max_iterations: int = 5)[source]¶ | [
32148,
499,
690,
636,
264,
3488,
11,
264,
423,
3027,
3319,
323,
264,
1493,
11,
304,
430,
1162,
499,
1205,
311,
18622,
279,
423,
3027,
3319,
311,
636,
279,
4495,
4320,
7255,
77,
1734,
791,
2768,
12920,
3073,
25,
314,
33210,
11281,
77,
1734,
438,
279,
11036,
10379,
82,
369,
1063,
527,
2728,
1618,
7338,
77,
90,
57643,
11281,
77,
1734,
41481,
7338,
77,
90,
52768,
11281,
77,
1734,
14924,
25,
314,
14506,
6022,
11281,
77,
35,
3027,
25,
1144,
77,
518,
10507,
25,
12536,
17752,
60,
284,
5307,
77,
14924,
25,
2650,
1690,
7123,
527,
304,
279,
2007,
366,
2048,
29,
33720,
77,
35,
3027,
25,
97492,
52,
2390,
46815,
446,
2903,
315,
7123,
498,
24945,
38242,
23561,
2048,
29,
595,
59,
77,
381,
59,
77,
14924,
25,
2650,
1690,
7123,
527,
304,
279,
2007,
366,
2048,
29,
1405,
366,
6361,
29,
374,
539,
4384,
33720,
77,
35,
3027,
25,
97492,
52,
2390,
46815,
446,
2903,
315,
7123,
498,
24945,
38242,
7988,
15675,
23561,
2048,
8226,
366,
2048,
31868,
27,
6361,
54629,
14729,
1621,
7861,
59,
77,
381,
59,
77,
14924,
25,
3639,
574,
279,
5578,
315,
366,
6361,
29,
304,
366,
2048,
29,
33720,
77,
35,
3027,
25,
97492,
52,
2390,
46815,
446,
27388,
498,
362,
61927,
23561,
2048,
31868,
27,
6361,
29,
9549,
59,
77,
381,
59,
77,
518,
3882,
11790,
25,
30226,
17752,
11,
5884,
60,
284,
2290,
11,
1973,
56707,
25,
528,
284,
220,
20,
6758,
2484,
60,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
f716891637ff-6 | Bases: BaseTool
Tool for querying a Power BI Dataset.
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.
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 description: str = '\n Input to this tool is a detailed question about the dataset, output is a result from the dataset. It will try to answer the question using the dataset, and if it cannot, it will ask for clarification.\n\n Example Input: "How many rows are in table1?"\n '¶
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 examples: Optional[str] = '\nQuestion: How many rows are in the table <table>?\nDAX: EVALUATE ROW("Number of rows", COUNTROWS(<table>))\n----\nQuestion: How many rows are in the table <table> where <column> is not empty?\nDAX: EVALUATE ROW("Number of rows", COUNTROWS(FILTER(<table>, <table>[<column>] <> "")))\n----\nQuestion: What was the average of <column> in <table>?\nDAX: EVALUATE ROW("Average", AVERAGE(<table>[<column>]))\n----\n'¶
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown. | [
33,
2315,
25,
5464,
7896,
198,
7896,
369,
82198,
264,
7572,
48153,
40283,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
5307,
77,
46493,
5688,
311,
420,
5507,
374,
264,
11944,
3488,
922,
279,
10550,
11,
2612,
374,
264,
1121,
505,
279,
10550,
13,
1102,
690,
1456,
311,
4320,
279,
3488,
1701,
279,
10550,
11,
323,
422,
433,
4250,
11,
433,
690,
2610,
369,
64784,
7255,
77,
1734,
46493,
13688,
5688,
25,
330,
4438,
1690,
7123,
527,
304,
2007,
16,
7673,
59,
77,
46493,
364,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
10507,
25,
12536,
17752,
60,
284,
5307,
77,
14924,
25,
2650,
1690,
7123,
527,
304,
279,
2007,
366,
2048,
29,
33720,
77,
35,
3027,
25,
97492,
52,
2390,
46815,
446,
2903,
315,
7123,
498,
24945,
38242,
23561,
2048,
29,
595,
59,
77,
381,
59,
77,
14924,
25,
2650,
1690,
7123,
527,
304,
279,
2007,
366,
2048,
29,
1405,
366,
6361,
29,
374,
539,
4384,
33720,
77,
35,
3027,
25,
97492,
52,
2390,
46815,
446,
2903,
315,
7123,
498,
24945,
38242,
7988,
15675,
23561,
2048,
8226,
366,
2048,
31868,
27,
6361,
54629,
14729,
1621,
7861,
59,
77,
381,
59,
77,
14924,
25,
3639,
574,
279,
5578,
315,
366,
6361,
29,
304,
366,
2048,
29,
33720,
77,
35,
3027,
25,
97492,
52,
2390,
46815,
446,
27388,
498,
362,
61927,
23561,
2048,
31868,
27,
6361,
29,
9549,
59,
77,
381,
59,
77,
6,
55609,
198,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
f716891637ff-7 | Handle the content of the ToolException thrown.
param llm_chain: langchain.chains.llm.LLMChain [Required]¶
param max_iterations: int = 5¶
param name: str = 'query_powerbi'¶
The unique name of the tool that clearly communicates its purpose.
param powerbi: langchain.utilities.powerbi.PowerBIDataset [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 AgentExecutor will stop looping.
param session_cache: Dict[str, Any] [Optional]¶ | [
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
9507,
76,
31683,
25,
8859,
8995,
5442,
1771,
60098,
76,
1236,
11237,
19368,
510,
8327,
60,
55609,
198,
913,
1973,
56707,
25,
528,
284,
220,
20,
55609,
198,
913,
836,
25,
610,
284,
364,
1663,
21052,
8385,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
2410,
8385,
25,
8859,
8995,
63795,
40645,
8385,
55186,
33,
926,
8534,
510,
8327,
60,
55609,
198,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
3882,
11790,
25,
30226,
17752,
11,
5884,
60,
510,
15669,
60,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
f716891637ff-8 | param template: Optional[str] = '\nAnswer the question below with a DAX query that can be sent to Power BI. DAX queries have a simple syntax comprised of just one required keyword, EVALUATE, and several optional keywords: ORDER BY, START AT, DEFINE, MEASURE, VAR, TABLE, and COLUMN. Each keyword defines a statement used for the duration of the query. Any time < or > are used in the text below it means that those values need to be replaced by table, columns or other things. If the question is not something you can answer with a DAX query, reply with "I cannot answer this" and the question will be escalated to a human.\n\nSome DAX functions return a table instead of a scalar, and must be wrapped in a function that evaluates the table and returns a scalar; unless the table is a single column, single row table, then it is treated as a scalar value. Most DAX functions require one or more arguments, which can include tables, columns, expressions, and values. However, some functions, such as PI, do not require any arguments, but always require parentheses to indicate the null argument. For example, you must always type PI(), not PI. You can also nest functions within other functions. \n\nSome commonly used functions are:\nEVALUATE <table> - At the most basic level, a DAX query is an EVALUATE statement containing a table expression. At least one EVALUATE statement is required, however, a query can contain any number of EVALUATE statements.\nEVALUATE <table> ORDER BY <expression> ASC or DESC - The optional ORDER BY keyword defines one or more expressions used to sort query results. Any expression that can be evaluated for each row of the result is valid.\nEVALUATE <table> ORDER BY <expression> ASC or DESC START AT <value> or <parameter> - The optional | [
913,
3896,
25,
12536,
17752,
60,
284,
5307,
77,
16533,
279,
3488,
3770,
449,
264,
423,
3027,
3319,
430,
649,
387,
3288,
311,
7572,
48153,
13,
423,
3027,
20126,
617,
264,
4382,
20047,
40056,
315,
1120,
832,
2631,
16570,
11,
97492,
52,
2390,
11,
323,
3892,
10309,
21513,
25,
15888,
7866,
11,
21673,
7520,
11,
68014,
11,
16691,
73269,
11,
44608,
11,
14700,
11,
323,
40123,
13,
9062,
16570,
19170,
264,
5224,
1511,
369,
279,
8250,
315,
279,
3319,
13,
5884,
892,
366,
477,
871,
527,
1511,
304,
279,
1495,
3770,
433,
3445,
430,
1884,
2819,
1205,
311,
387,
12860,
555,
2007,
11,
8310,
477,
1023,
2574,
13,
1442,
279,
3488,
374,
539,
2555,
499,
649,
4320,
449,
264,
423,
3027,
3319,
11,
10052,
449,
330,
40,
4250,
4320,
420,
1,
323,
279,
3488,
690,
387,
81700,
311,
264,
3823,
7255,
77,
1734,
8538,
423,
3027,
5865,
471,
264,
2007,
4619,
315,
264,
17722,
11,
323,
2011,
387,
20037,
304,
264,
734,
430,
67349,
279,
2007,
323,
4780,
264,
17722,
26,
7389,
279,
2007,
374,
264,
3254,
3330,
11,
3254,
2872,
2007,
11,
1243,
433,
374,
12020,
439,
264,
17722,
907,
13,
7648,
423,
3027,
5865,
1397,
832,
477,
810,
6105,
11,
902,
649,
2997,
12920,
11,
8310,
11,
24282,
11,
323,
2819,
13,
4452,
11,
1063,
5865,
11,
1778,
439,
23396,
11,
656,
539,
1397,
904,
6105,
11,
719,
2744,
1397,
75075,
311,
13519,
279,
854,
5811,
13,
1789,
3187,
11,
499,
2011,
2744,
955,
23396,
1535,
539,
23396,
13,
1472,
649,
1101,
23634,
5865,
2949,
1023,
5865,
13,
1144,
77,
1734,
8538,
17037,
1511,
5865,
527,
7338,
77,
36,
5711,
52,
2390,
366,
2048,
29,
482,
2468,
279,
1455,
6913,
2237,
11,
264,
423,
3027,
3319,
374,
459,
97492,
52,
2390,
5224,
8649,
264,
2007,
7645,
13,
2468,
3325,
832,
97492,
52,
2390,
5224,
374,
2631,
11,
4869,
11,
264,
3319,
649,
6782,
904,
1396,
315,
97492,
52,
2390,
12518,
7255,
77,
36,
5711,
52,
2390,
366,
2048,
29,
15888,
7866,
366,
29199,
29,
20382,
477,
16477,
482,
578,
10309,
15888,
7866,
16570,
19170,
832,
477,
810,
24282,
1511,
311,
3460,
3319,
3135,
13,
5884,
7645,
430,
649,
387,
26126,
369,
1855,
2872,
315,
279,
1121,
374,
2764,
7255,
77,
36,
5711,
52,
2390,
366,
2048,
29,
15888,
7866,
366,
29199,
29,
20382,
477,
16477,
21673,
7520,
366,
970,
29,
477,
366,
16577,
29,
482,
578,
10309
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
f716891637ff-9 | ORDER BY <expression> ASC or DESC START AT <value> or <parameter> - The optional START AT keyword is used inside an ORDER BY clause. It defines the value at which the query results begin.\nDEFINE MEASURE | VAR; EVALUATE <table> - The optional DEFINE keyword introduces one or more calculated entity definitions that exist only for the duration of the query. Definitions precede the EVALUATE statement and are valid for all EVALUATE statements in the query. Definitions can be variables, measures, tables1, and columns1. Definitions can reference other definitions that appear before or after the current definition. At least one definition is required if the DEFINE keyword is included in a query.\nMEASURE <table name>[<measure name>] = <scalar expression> - Introduces a measure definition in a DEFINE statement of a DAX query.\nVAR <name> = <expression> - Stores the result of an expression as a named variable, which can then be passed as an argument to other measure expressions. Once resultant values have been calculated for a variable expression, those values do not change, even if the variable is referenced in another expression.\n\nFILTER(<table>,<filter>) - Returns a table that represents a subset of another table or expression, where <filter> is a Boolean expression that is to be evaluated for each row of the table. For example, [Amount] > 0 or [Region] = "France"\nROW(<name>, <expression>) - Returns a table with a single row containing values that result from the expressions given to each column.\nDISTINCT(<column>) - Returns a one-column table that contains the distinct values from the specified column. In other words, duplicate values are removed and only unique values are returned. This function cannot be used to Return values into a cell or column on a worksheet; rather, you nest the DISTINCT function within a formula, to get a list of distinct values that can be passed | [
13715,
7866,
366,
29199,
29,
20382,
477,
16477,
21673,
7520,
366,
970,
29,
477,
366,
16577,
29,
482,
578,
10309,
21673,
7520,
16570,
374,
1511,
4871,
459,
15888,
7866,
22381,
13,
1102,
19170,
279,
907,
520,
902,
279,
3319,
3135,
3240,
7255,
77,
36972,
16691,
73269,
765,
44608,
26,
97492,
52,
2390,
366,
2048,
29,
482,
578,
10309,
68014,
16570,
40019,
832,
477,
810,
16997,
5502,
17931,
430,
3073,
1193,
369,
279,
8250,
315,
279,
3319,
13,
47613,
16599,
68,
279,
97492,
52,
2390,
5224,
323,
527,
2764,
369,
682,
97492,
52,
2390,
12518,
304,
279,
3319,
13,
47613,
649,
387,
7482,
11,
11193,
11,
12920,
16,
11,
323,
8310,
16,
13,
47613,
649,
5905,
1023,
17931,
430,
5101,
1603,
477,
1306,
279,
1510,
7419,
13,
2468,
3325,
832,
7419,
374,
2631,
422,
279,
68014,
16570,
374,
5343,
304,
264,
3319,
7255,
77,
7614,
73269,
366,
2048,
836,
31868,
27,
48899,
836,
54629,
284,
366,
36442,
7645,
29,
482,
1357,
4653,
1634,
264,
6767,
7419,
304,
264,
68014,
5224,
315,
264,
423,
3027,
3319,
7255,
77,
34140,
366,
609,
29,
284,
366,
29199,
29,
482,
39402,
279,
1121,
315,
459,
7645,
439,
264,
7086,
3977,
11,
902,
649,
1243,
387,
5946,
439,
459,
5811,
311,
1023,
6767,
24282,
13,
9843,
84913,
2819,
617,
1027,
16997,
369,
264,
3977,
7645,
11,
1884,
2819,
656,
539,
2349,
11,
1524,
422,
279,
3977,
374,
25819,
304,
2500,
7645,
7255,
77,
1734,
62480,
23561,
2048,
8226,
27,
5428,
9414,
482,
5295,
264,
2007,
430,
11105,
264,
27084,
315,
2500,
2007,
477,
7645,
11,
1405,
366,
5428,
29,
374,
264,
7137,
7645,
430,
374,
311,
387,
26126,
369,
1855,
2872,
315,
279,
2007,
13,
1789,
3187,
11,
510,
10301,
60,
871,
220,
15,
477,
510,
14422,
60,
284,
330,
50100,
12200,
77,
15445,
23561,
609,
8226,
366,
29199,
9414,
482,
5295,
264,
2007,
449,
264,
3254,
2872,
8649,
2819,
430,
1121,
505,
279,
24282,
2728,
311,
1855,
3330,
7255,
77,
80540,
46419,
23561,
6361,
9414,
482,
5295,
264,
832,
26005,
2007,
430,
5727,
279,
12742,
2819,
505,
279,
5300,
3330,
13,
763,
1023,
4339,
11,
23329,
2819,
527,
7108,
323,
1193,
5016,
2819,
527,
6052,
13,
1115,
734,
4250,
387,
1511,
311,
3494,
2819,
1139,
264,
2849,
477,
3330,
389,
264,
37736,
26,
4856,
11,
499,
23634,
279,
60186,
734,
2949,
264,
15150,
11,
311,
636,
264,
1160,
315,
12742,
2819,
430,
649,
387,
5946
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
f716891637ff-10 | you nest the DISTINCT function within a formula, to get a list of distinct values that can be passed to another function and then counted, summed, or used for other operations.\nDISTINCT(<table>) - Returns a table by removing duplicate rows from another table or expression.\n\nAggregation functions, names with a A in it, handle booleans and empty strings in appropriate ways, while the same function without A only uses the numeric values in a column. Functions names with an X in it can include a expression as an argument, this will be evaluated for each row in the table and the result will be used in the regular function calculation, these are the functions:\nCOUNT(<column>), COUNTA(<column>), COUNTX(<table>,<expression>), COUNTAX(<table>,<expression>), COUNTROWS([<table>]), COUNTBLANK(<column>), DISTINCTCOUNT(<column>), DISTINCTCOUNTNOBLANK (<column>) - these are all variantions of count functions.\nAVERAGE(<column>), AVERAGEA(<column>), AVERAGEX(<table>,<expression>) - these are all variantions of average functions.\nMAX(<column>), MAXA(<column>), MAXX(<table>,<expression>) - these are all variantions of max functions.\nMIN(<column>), MINA(<column>), MINX(<table>,<expression>) - these are all variantions of min functions.\nPRODUCT(<column>), PRODUCTX(<table>,<expression>) - these are all variantions of product functions.\nSUM(<column>), SUMX(<table>,<expression>) - these are all variantions of sum functions.\n\nDate and time functions:\nDATE(year, month, day) - Returns a date value that represents the specified year, month, and day.\nDATEDIFF(date1, date2, <interval>) - Returns the difference between two date values, in the specified | [
9514,
23634,
279,
60186,
734,
2949,
264,
15150,
11,
311,
636,
264,
1160,
315,
12742,
2819,
430,
649,
387,
5946,
311,
2500,
734,
323,
1243,
31094,
11,
66766,
11,
477,
1511,
369,
1023,
7677,
7255,
77,
80540,
46419,
23561,
2048,
9414,
482,
5295,
264,
2007,
555,
18054,
23329,
7123,
505,
2500,
2007,
477,
7645,
7255,
77,
1734,
9219,
35542,
5865,
11,
5144,
449,
264,
362,
304,
433,
11,
3790,
712,
98099,
323,
4384,
9246,
304,
8475,
5627,
11,
1418,
279,
1890,
734,
2085,
362,
1193,
5829,
279,
25031,
2819,
304,
264,
3330,
13,
24460,
5144,
449,
459,
1630,
304,
433,
649,
2997,
264,
7645,
439,
459,
5811,
11,
420,
690,
387,
26126,
369,
1855,
2872,
304,
279,
2007,
323,
279,
1121,
690,
387,
1511,
304,
279,
5912,
734,
22702,
11,
1521,
527,
279,
5865,
7338,
77,
39243,
23561,
6361,
29,
705,
24945,
32,
23561,
6361,
29,
705,
24945,
55,
23561,
2048,
8226,
27,
29199,
29,
705,
24945,
3027,
23561,
2048,
8226,
27,
29199,
29,
705,
24945,
38242,
2625,
27,
2048,
29,
9918,
24945,
9574,
16395,
23561,
6361,
29,
705,
60186,
39243,
23561,
6361,
29,
705,
60186,
39243,
9173,
9574,
16395,
23246,
6361,
9414,
482,
1521,
527,
682,
11678,
919,
315,
1797,
5865,
7255,
77,
32,
61927,
23561,
6361,
29,
705,
362,
61927,
32,
23561,
6361,
29,
705,
362,
3848,
1929,
3337,
23561,
2048,
8226,
27,
29199,
9414,
482,
1521,
527,
682,
11678,
919,
315,
5578,
5865,
7255,
77,
10809,
23561,
6361,
29,
705,
8498,
32,
23561,
6361,
29,
705,
8498,
55,
23561,
2048,
8226,
27,
29199,
9414,
482,
1521,
527,
682,
11678,
919,
315,
1973,
5865,
7255,
77,
16818,
23561,
6361,
29,
705,
17116,
32,
23561,
6361,
29,
705,
17116,
55,
23561,
2048,
8226,
27,
29199,
9414,
482,
1521,
527,
682,
11678,
919,
315,
1332,
5865,
7255,
77,
52531,
23561,
6361,
29,
705,
39183,
55,
23561,
2048,
8226,
27,
29199,
9414,
482,
1521,
527,
682,
11678,
919,
315,
2027,
5865,
7255,
77,
28477,
23561,
6361,
29,
705,
31835,
55,
23561,
2048,
8226,
27,
29199,
9414,
482,
1521,
527,
682,
11678,
919,
315,
2694,
5865,
7255,
77,
1734,
1956,
323,
892,
5865,
7338,
77,
7242,
29381,
11,
2305,
11,
1938,
8,
482,
5295,
264,
2457,
907,
430,
11105,
279,
5300,
1060,
11,
2305,
11,
323,
1938,
7255,
77,
37636,
30135,
12237,
16,
11,
2457,
17,
11,
366,
29004,
9414,
482,
5295,
279,
6811,
1990,
1403,
2457,
2819,
11,
304,
279,
5300
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
f716891637ff-11 | date2, <interval>) - Returns the difference between two date values, in the specified interval, that can be SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR.\nDATEVALUE(<date_text>) - Returns a date value that represents the specified date.\nYEAR(<date>), QUARTER(<date>), MONTH(<date>), DAY(<date>), HOUR(<date>), MINUTE(<date>), SECOND(<date>) - Returns the part of the date for the specified date.\n\nFinally, make sure to escape double quotes with a single backslash, and make sure that only table names have single quotes around them, while names of measures or the values of columns that you want to compare against are in escaped double quotes. Newlines are not necessary and can be skipped. The queries are serialized as json and so will have to fit be compliant with json syntax. Sometimes you will get a question, a DAX query and a error, in that case you need to rewrite the DAX query to get the correct answer.\n\nThe following tables exist: {tables}\n\nand the schema\'s for some are given here:\n{schemas}\n\nExamples:\n{examples}\n\nQuestion: {tool_input}\nDAX: \n'¶ | [
1045,
17,
11,
366,
29004,
9414,
482,
5295,
279,
6811,
1990,
1403,
2457,
2819,
11,
304,
279,
5300,
10074,
11,
430,
649,
387,
69795,
11,
17116,
11701,
11,
97064,
11,
38788,
11,
58529,
11,
59080,
11,
27090,
3065,
643,
11,
52005,
7255,
77,
7242,
24771,
23561,
1045,
4424,
9414,
482,
5295,
264,
2457,
907,
430,
11105,
279,
5300,
2457,
7255,
77,
88301,
23561,
1045,
29,
705,
27090,
3065,
643,
23561,
1045,
29,
705,
59080,
23561,
1045,
29,
705,
38788,
23561,
1045,
29,
705,
97064,
23561,
1045,
29,
705,
17116,
11701,
23561,
1045,
29,
705,
69795,
23561,
1045,
9414,
482,
5295,
279,
961,
315,
279,
2457,
369,
279,
5300,
2457,
7255,
77,
1734,
24901,
11,
1304,
2771,
311,
12731,
2033,
17637,
449,
264,
3254,
1203,
51356,
11,
323,
1304,
2771,
430,
1193,
2007,
5144,
617,
3254,
17637,
2212,
1124,
11,
1418,
5144,
315,
11193,
477,
279,
2819,
315,
8310,
430,
499,
1390,
311,
9616,
2403,
527,
304,
28883,
2033,
17637,
13,
1561,
8128,
527,
539,
5995,
323,
649,
387,
36257,
13,
578,
20126,
527,
34016,
439,
3024,
323,
779,
690,
617,
311,
5052,
387,
49798,
449,
3024,
20047,
13,
18156,
499,
690,
636,
264,
3488,
11,
264,
423,
3027,
3319,
323,
264,
1493,
11,
304,
430,
1162,
499,
1205,
311,
18622,
279,
423,
3027,
3319,
311,
636,
279,
4495,
4320,
7255,
77,
1734,
791,
2768,
12920,
3073,
25,
314,
33210,
11281,
77,
1734,
438,
279,
11036,
10379,
82,
369,
1063,
527,
2728,
1618,
7338,
77,
90,
57643,
11281,
77,
1734,
41481,
7338,
77,
90,
52768,
11281,
77,
1734,
14924,
25,
314,
14506,
6022,
11281,
77,
35,
3027,
25,
1144,
77,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
f716891637ff-12 | 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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool.
validator validate_llm_chain_input_variables » llm_chain[source]¶
Make sure the LLM chain has the correct input variables.
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.
arbitrary_types_allowed = True¶ | [
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
16503,
9788,
44095,
76,
31683,
6022,
29282,
4194,
8345,
4194,
9507,
76,
31683,
76747,
60,
55609,
198,
8238,
2771,
279,
445,
11237,
8957,
706,
279,
4495,
1988,
7482,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
76747,
60,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.powerbi.tool.QueryPowerBITool.html |
fcb301f6510f-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[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False)[source]¶
Bases: ABC, BaseModel
Interface LangChain tools must implement.
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.
param args_schema: Optional[Type[pydantic.main.BaseModel]] = None¶
Pydantic model class to validate and parse the tool’s input arguments.
param callback_manager: Optional[langchain.callbacks.base.BaseCallbackManager] = None¶
Deprecated. Please use callbacks instead.
param callbacks: Optional[Union[List[langchain.callbacks.base.BaseCallbackHandler], langchain.callbacks.base.BaseCallbackManager]] = None¶
Callbacks to be called during tool execution.
param description: str [Required]¶
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[[langchain.tools.base.ToolException], str]]] = False¶
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. | [
5317,
8995,
24029,
9105,
13316,
7896,
55609,
198,
1058,
8859,
8995,
24029,
9105,
13316,
7896,
4163,
11,
836,
25,
610,
11,
4096,
25,
610,
11,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
19921,
11,
65705,
198,
5160,
23272,
19368,
7526,
2011,
4305,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
3368,
67,
8322,
9056,
13316,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
12536,
58,
33758,
53094,
58,
5317,
8995,
72134,
9105,
13316,
7646,
3126,
1145,
8859,
8995,
72134,
9105,
13316,
7646,
2087,
5163,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
510,
8327,
60,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
5317,
8995,
24029,
9105,
25443,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
510,
8327,
60,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.base.BaseTool.html |
fcb301f6510f-1 | 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[source]¶
Make tool callable.
async arun(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[source]¶
Run the tool asynchronously.
validator raise_deprecation » all fields[source]¶
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[source]¶
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.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | [
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
76747,
60,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
76747,
60,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
76747,
60,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
76747,
60,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
76747,
60,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.base.BaseTool.html |
ac61c57433ef-0 | langchain.tools.shell.tool.ShellTool¶
class langchain.tools.shell.tool.ShellTool(*, name: str = 'terminal', description: str = 'Run shell commands on this Linux machine.', args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'langchain.tools.shell.tool.ShellInput'>, return_direct: bool = False, verbose: bool = False, callbacks: ~typing.Optional[~typing.Union[~typing.List[~langchain.callbacks.base.BaseCallbackHandler], ~langchain.callbacks.base.BaseCallbackManager]] = None, callback_manager: ~typing.Optional[~langchain.callbacks.base.BaseCallbackManager] = None, handle_tool_error: ~typing.Optional[~typing.Union[bool, str, ~typing.Callable[[~langchain.tools.base.ToolException], str]]] = False, process: ~langchain.utilities.bash.BashProcess = None)[source]¶
Bases: BaseTool
Tool to run shell commands.
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.
param args_schema: Type[pydantic.main.BaseModel] = <class 'langchain.tools.shell.tool.ShellInput'>¶
Schema for 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 description: str = 'Run shell commands on this Linux machine.'¶
Description of tool.
param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶
Handle the content of the ToolException thrown.
param name: str = 'terminal'¶
Name of tool.
param process: langchain.utilities.bash.BashProcess [Optional]¶ | [
5317,
8995,
24029,
85446,
21966,
11086,
616,
7896,
55609,
198,
1058,
8859,
8995,
24029,
85446,
21966,
11086,
616,
7896,
4163,
11,
836,
25,
610,
284,
364,
37427,
518,
4096,
25,
610,
284,
364,
6869,
12811,
11545,
389,
420,
14677,
5780,
16045,
2897,
26443,
25,
4056,
90902,
10394,
58,
93,
3368,
67,
8322,
9056,
13316,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
85446,
21966,
11086,
616,
2566,
6404,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
93,
90902,
5937,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
3126,
1145,
4056,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
4056,
90902,
37464,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
2707,
11,
610,
11,
4056,
90902,
28115,
481,
15873,
93,
5317,
8995,
24029,
9105,
25443,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
1920,
25,
4056,
5317,
8995,
63795,
960,
1003,
1823,
1003,
7575,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
7896,
311,
1629,
12811,
11545,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
4078,
58,
3368,
67,
8322,
9056,
13316,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
85446,
21966,
11086,
616,
2566,
6404,
55609,
198,
8802,
369,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
6869,
12811,
11545,
389,
420,
14677,
5780,
3238,
55609,
198,
5116,
315,
5507,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
37427,
6,
55609,
198,
678,
315,
5507,
627,
913,
1920,
25,
8859,
8995,
63795,
960,
1003,
1823,
1003,
7575,
510,
15669,
60,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.shell.tool.ShellTool.html |
ac61c57433ef-1 | param process: langchain.utilities.bash.BashProcess [Optional]¶
Bash process to run commands.
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], BaseCallbackManager]] = None) → str¶
Make tool callable.
async arun(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 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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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'¶ | [
913,
1920,
25,
8859,
8995,
63795,
960,
1003,
1823,
1003,
7575,
510,
15669,
60,
55609,
198,
33,
1003,
1920,
311,
1629,
11545,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.shell.tool.ShellTool.html |
a2c19b3e6d4b-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 imageOutput: the UUID of a generated image', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, model_name: ModelName, size: Optional[str] = '512x512', steamship: Steamship, return_urls: Optional[bool] = False)[source]¶
Bases: BaseTool
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.
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 description: str = 'Useful for when you need to generate an image.Input: A detailed text-2-image prompt describing an imageOutput: the UUID of a generated image'¶
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¶ | [
5317,
8995,
24029,
1258,
14922,
5383,
5060,
65291,
21966,
7914,
14922,
5383,
1945,
38238,
7896,
55609,
198,
1058,
8859,
8995,
24029,
1258,
14922,
5383,
5060,
65291,
21966,
7914,
14922,
5383,
1945,
38238,
7896,
4163,
11,
836,
25,
610,
284,
364,
32215,
1945,
518,
4096,
25,
610,
284,
364,
10464,
1285,
369,
994,
499,
1205,
311,
7068,
459,
2217,
16521,
25,
362,
11944,
1495,
12,
17,
14064,
10137,
23524,
459,
2217,
5207,
25,
279,
24628,
315,
264,
8066,
2217,
518,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
1646,
1292,
25,
5008,
678,
11,
1404,
25,
12536,
17752,
60,
284,
364,
8358,
87,
8358,
518,
20930,
5383,
25,
22578,
5383,
11,
471,
33922,
25,
12536,
58,
2707,
60,
284,
3641,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
10464,
1285,
369,
994,
499,
1205,
311,
7068,
459,
2217,
16521,
25,
362,
11944,
1495,
12,
17,
14064,
10137,
23524,
459,
2217,
5207,
25,
279,
24628,
315,
264,
8066,
2217,
6,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.steamship_image_generation.tool.SteamshipImageGenerationTool.html |
a2c19b3e6d4b-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 called, the AgentExecutor will stop looping.
param return_urls: Optional[bool] = False¶
param size: Optional[str] = '512x512'¶
param steamship: Steamship [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: 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 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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
Run the tool.
validator validate_environment » all fields[source]¶
Validate that api key and python package exists in environment.
validator validate_size » all fields[source]¶
property args: dict¶
property is_single_input: bool¶
Whether the tool only accepts a single input.
model Config¶ | [
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
1646,
1292,
25,
5008,
678,
510,
8327,
60,
55609,
198,
913,
836,
25,
610,
284,
364,
32215,
1945,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
471,
33922,
25,
12536,
58,
2707,
60,
284,
3641,
55609,
198,
913,
1404,
25,
12536,
17752,
60,
284,
364,
8358,
87,
8358,
6,
55609,
198,
913,
20930,
5383,
25,
22578,
5383,
510,
8327,
60,
55609,
198,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
16503,
9788,
52874,
4194,
8345,
4194,
682,
5151,
76747,
60,
55609,
198,
18409,
430,
6464,
1401,
323,
10344,
6462,
6866,
304,
4676,
627,
16503,
9788,
2424,
4194,
8345,
4194,
682,
5151,
76747,
60,
55609,
198,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.steamship_image_generation.tool.SteamshipImageGenerationTool.html |
a2c19b3e6d4b-2 | Whether the tool only accepts a single input.
model Config¶
Bases: object
Configuration for this pydantic object.
arbitrary_types_allowed = True¶
extra = 'forbid'¶ | [
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.steamship_image_generation.tool.SteamshipImageGenerationTool.html |
cc633429aa86-0 | langchain.tools.office365.create_draft_message.CreateDraftMessageSchema¶
class langchain.tools.office365.create_draft_message.CreateDraftMessageSchema(*, 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 keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
param bcc: Optional[List[str]] = None¶
The list of BCC recipients.
param body: str [Required]¶
The message body to include in the draft.
param cc: Optional[List[str]] = None¶
The list of CC recipients.
param subject: str [Required]¶
The subject of the message.
param to: List[str] [Required]¶
The list of recipients. | [
5317,
8995,
24029,
100193,
12676,
2581,
92439,
6598,
7399,
51186,
2097,
8802,
55609,
198,
1058,
8859,
8995,
24029,
100193,
12676,
2581,
92439,
6598,
7399,
51186,
2097,
8802,
4163,
11,
2547,
25,
610,
11,
311,
25,
1796,
17752,
1145,
3917,
25,
610,
11,
12810,
25,
12536,
53094,
17752,
5163,
284,
2290,
11,
293,
641,
25,
12536,
53094,
17752,
5163,
284,
2290,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
293,
641,
25,
12536,
53094,
17752,
5163,
284,
2290,
55609,
198,
791,
1160,
315,
426,
3791,
34876,
627,
913,
2547,
25,
610,
510,
8327,
60,
55609,
198,
791,
1984,
2547,
311,
2997,
304,
279,
10165,
627,
913,
12810,
25,
12536,
53094,
17752,
5163,
284,
2290,
55609,
198,
791,
1160,
315,
13844,
34876,
627,
913,
3917,
25,
610,
510,
8327,
60,
55609,
198,
791,
3917,
315,
279,
1984,
627,
913,
311,
25,
1796,
17752,
60,
510,
8327,
60,
55609,
198,
791,
1160,
315,
34876,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.office365.create_draft_message.CreateDraftMessageSchema.html |
04df60f25de8-0 | langchain.tools.sleep.tool.SleepTool¶
class langchain.tools.sleep.tool.SleepTool(*, name: str = 'sleep', description: str = 'Make agent sleep for a specified number of seconds.', args_schema: ~typing.Type[~pydantic.main.BaseModel] = <class 'langchain.tools.sleep.tool.SleepInput'>, return_direct: bool = False, verbose: bool = False, callbacks: ~typing.Optional[~typing.Union[~typing.List[~langchain.callbacks.base.BaseCallbackHandler], ~langchain.callbacks.base.BaseCallbackManager]] = None, callback_manager: ~typing.Optional[~langchain.callbacks.base.BaseCallbackManager] = None, handle_tool_error: ~typing.Optional[~typing.Union[bool, str, ~typing.Callable[[~langchain.tools.base.ToolException], str]]] = False)[source]¶
Bases: BaseTool
Tool that adds the capability to sleep.
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.
param args_schema: Type[pydantic.main.BaseModel] = <class 'langchain.tools.sleep.tool.SleepInput'>¶
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 description: str = 'Make agent sleep for a specified number of seconds.'¶
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. | [
5317,
8995,
24029,
11365,
21966,
32686,
7896,
55609,
198,
1058,
8859,
8995,
24029,
11365,
21966,
32686,
7896,
4163,
11,
836,
25,
610,
284,
364,
26894,
518,
4096,
25,
610,
284,
364,
8238,
8479,
6212,
369,
264,
5300,
1396,
315,
6622,
16045,
2897,
26443,
25,
4056,
90902,
10394,
58,
93,
3368,
67,
8322,
9056,
13316,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
11365,
21966,
32686,
2566,
6404,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
93,
90902,
5937,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
3126,
1145,
4056,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
4056,
90902,
37464,
58,
93,
5317,
8995,
72134,
9105,
13316,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
4056,
90902,
37464,
58,
93,
90902,
10840,
290,
58,
2707,
11,
610,
11,
4056,
90902,
28115,
481,
15873,
93,
5317,
8995,
24029,
9105,
25443,
1378,
1145,
610,
5163,
60,
284,
3641,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
7896,
430,
11621,
279,
23099,
311,
6212,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
4078,
58,
3368,
67,
8322,
9056,
13316,
1747,
60,
284,
366,
1058,
364,
5317,
8995,
24029,
11365,
21966,
32686,
2566,
6404,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
8238,
8479,
6212,
369,
264,
5300,
1396,
315,
6622,
3238,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
13
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.sleep.tool.SleepTool.html |
04df60f25de8-1 | Handle the content of the ToolException thrown.
param name: str = 'sleep'¶
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__(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: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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], BaseCallbackManager]] = None, **kwargs: Any) → Any¶
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'¶ | [
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
26894,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
471,
279,
5507,
753,
2612,
6089,
13,
20638,
420,
311,
3082,
3445,
198,
9210,
1306,
279,
5507,
374,
2663,
11,
279,
21372,
26321,
690,
3009,
63687,
627,
913,
14008,
25,
1845,
284,
3641,
55609,
198,
25729,
311,
1515,
279,
5507,
753,
5208,
627,
565,
6797,
3889,
14506,
6022,
25,
610,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
8,
11651,
610,
55609,
198,
8238,
5507,
42022,
627,
7847,
802,
359,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
68881,
627,
16503,
4933,
2310,
70693,
4194,
8345,
4194,
682,
5151,
55609,
198,
94201,
409,
70693,
10163,
422,
4927,
12418,
374,
1511,
627,
6236,
50050,
6022,
25,
9323,
17752,
11,
30226,
1145,
14008,
25,
12536,
58,
2707,
60,
284,
2290,
11,
1212,
6855,
25,
12536,
17752,
60,
284,
364,
13553,
518,
1933,
25,
12536,
17752,
60,
284,
364,
13553,
518,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
3146,
9872,
25,
5884,
8,
11651,
5884,
55609,
198,
6869,
279,
5507,
627,
3784,
2897,
25,
6587,
55609,
198,
3784,
374,
20052,
6022,
25,
1845,
55609,
198,
25729,
279,
5507,
1193,
27441,
264,
3254,
1988,
627,
2590,
5649,
55609,
198,
33,
2315,
25,
1665,
198,
7843,
369,
420,
4611,
67,
8322,
1665,
627,
277,
88951,
9962,
43255,
284,
3082,
55609,
198,
15824,
284,
364,
2000,
21301,
6,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.sleep.tool.SleepTool.html |
20975744745a-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 form a valid model.
param commands: Union[str, List[str]] [Required]¶
List of shell commands to run.
List of shell commands to run. Deserialized using json.loads | [
5317,
8995,
24029,
85446,
21966,
11086,
616,
2566,
55609,
198,
1058,
8859,
8995,
24029,
85446,
21966,
11086,
616,
2566,
4163,
11,
11545,
25,
9323,
17752,
11,
1796,
17752,
30716,
58,
2484,
60,
55609,
198,
33,
2315,
25,
65705,
198,
31579,
369,
279,
39630,
30502,
5507,
627,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
11545,
25,
9323,
17752,
11,
1796,
17752,
5163,
510,
8327,
60,
55609,
198,
861,
315,
12811,
11545,
311,
1629,
627,
861,
315,
12811,
11545,
311,
1629,
13,
3959,
68677,
1701,
3024,
23818
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.shell.tool.ShellInput.html |
e66c2fb8642c-0 | langchain.tools.brave_search.tool.BraveSearch¶
class langchain.tools.brave_search.tool.BraveSearch(*, name: str = 'brave_search', description: str = 'a search engine. useful for when you need to answer questions about current events. input should be a search query.', args_schema: Optional[Type[BaseModel]] = None, return_direct: bool = False, verbose: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, callback_manager: Optional[BaseCallbackManager] = None, handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False, search_wrapper: BraveSearchWrapper)[source]¶
Bases: BaseTool
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.
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 description: str = 'a search engine. useful for when you need to answer questions about current events. input should be a search query.'¶
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 = 'brave_search'¶
The unique name of the tool that clearly communicates its purpose.
param return_direct: bool = False¶ | [
5317,
8995,
24029,
21610,
525,
10947,
21966,
56525,
525,
6014,
55609,
198,
1058,
8859,
8995,
24029,
21610,
525,
10947,
21966,
56525,
525,
6014,
4163,
11,
836,
25,
610,
284,
364,
1347,
525,
10947,
518,
4096,
25,
610,
284,
364,
64,
2778,
4817,
13,
5505,
369,
994,
499,
1205,
311,
4320,
4860,
922,
1510,
4455,
13,
1988,
1288,
387,
264,
2778,
3319,
16045,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
11,
471,
33971,
25,
1845,
284,
3641,
11,
14008,
25,
1845,
284,
3641,
11,
27777,
25,
12536,
58,
33758,
53094,
58,
4066,
7646,
3126,
1145,
5464,
7646,
2087,
5163,
284,
2290,
11,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
11,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
11,
2778,
24474,
25,
70308,
6014,
11803,
6758,
2484,
60,
55609,
198,
33,
2315,
25,
5464,
7896,
198,
4110,
264,
502,
1646,
555,
23115,
323,
69772,
1988,
828,
505,
16570,
6105,
627,
36120,
54129,
422,
279,
1988,
828,
4250,
387,
16051,
311,
1376,
264,
2764,
1646,
627,
913,
2897,
26443,
25,
12536,
58,
941,
58,
4066,
1747,
5163,
284,
2290,
55609,
198,
14149,
67,
8322,
1646,
538,
311,
9788,
323,
4820,
279,
5507,
753,
1988,
6105,
627,
913,
4927,
12418,
25,
12536,
58,
4066,
7646,
2087,
60,
284,
2290,
55609,
198,
52444,
13,
5321,
1005,
27777,
4619,
627,
913,
27777,
25,
23499,
82,
284,
2290,
55609,
198,
45561,
311,
387,
2663,
2391,
5507,
11572,
627,
913,
4096,
25,
610,
284,
364,
64,
2778,
4817,
13,
5505,
369,
994,
499,
1205,
311,
4320,
4860,
922,
1510,
4455,
13,
1988,
1288,
387,
264,
2778,
3319,
3238,
55609,
198,
23580,
311,
3371,
279,
1646,
1268,
14,
9493,
14,
35734,
311,
1005,
279,
5507,
627,
2675,
649,
3493,
2478,
64630,
10507,
439,
264,
961,
315,
279,
4096,
627,
913,
3790,
23627,
4188,
25,
12536,
58,
33758,
58,
2707,
11,
610,
11,
54223,
15873,
7896,
1378,
1145,
610,
5163,
60,
284,
3641,
55609,
198,
7144,
279,
2262,
315,
279,
13782,
1378,
15338,
627,
913,
836,
25,
610,
284,
364,
1347,
525,
10947,
6,
55609,
198,
791,
5016,
836,
315,
279,
5507,
430,
9539,
92606,
1202,
7580,
627,
913,
471,
33971,
25,
1845,
284,
3641,
55609
] | https://langchain.readthedocs.io/en/latest/tools/langchain.tools.brave_search.tool.BraveSearch.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.