id stringlengths 14 15 | text stringlengths 44 2.47k | source stringlengths 61 181 |
|---|---|---|
61def6e607da-1 | Duplicate a model, optionally choose which fields to include, exclude and change.
Parameters
include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creat... | https://api.python.langchain.com/en/latest/tools/langchain.tools.openapi.utils.api_models.APIRequestBodyProperty.html |
61def6e607da-2 | Generate a JSON representation of the model, include and exclude arguments as per dict().
encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().
classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol... | https://api.python.langchain.com/en/latest/tools/langchain.tools.openapi.utils.api_models.APIRequestBodyProperty.html |
5ec9c4d7d54b-0 | langchain.tools.ainetwork.owner.AINOwnerOps¶
class langchain.tools.ainetwork.owner.AINOwnerOps[source]¶
Bases: AINBaseTool
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.mai... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.owner.AINOwnerOps.html |
5ec9c4d7d54b-1 | param callbacks: Callbacks = None¶
Callbacks to be called during tool execution.
param description: str = "\nRules for `owner` in AINetwork Blockchain database.\nAn address set as `owner` can modify permissions according to its granted authorities\n\n## Path Rule\n- (/[a-zA-Z_0-9]+)+\n- Permission checks ascend from th... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.owner.AINOwnerOps.html |
5ec9c4d7d54b-2 | param metadata: Optional[Dict[str, Any]] = None¶
Optional metadata associated with the tool. Defaults to None
This metadata will be associated with each call to this tool,
and passed as arguments to the handlers defined in callbacks.
You can use these to eg identify a specific instance of a tool with its use case.
para... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.owner.AINOwnerOps.html |
5ec9c4d7d54b-3 | Subclasses should override this method if they can run asynchronously.
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, *, tags: Optional[List[... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.owner.AINOwnerOps.html |
5ec9c4d7d54b-4 | Default implementation of atransform, which buffers input and calls astream.
Subclasses should override this method if they can start producing output while
input is still being generated.
batch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.owner.AINOwnerOps.html |
5ec9c4d7d54b-5 | deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, ex... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.owner.AINOwnerOps.html |
5ec9c4d7d54b-6 | classmethod parse_obj(obj: Any) → Model¶
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model¶
run(tool_input: Union[str, Dict], verbose: Optional[bool] = None, start_color: Optional[str] = 'green', color: Op... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.owner.AINOwnerOps.html |
5ec9c4d7d54b-7 | Bind config to a Runnable, returning a new Runnable.
with_fallbacks(fallbacks: ~typing.Sequence[~langchain.schema.runnable.base.Runnable[~langchain.schema.runnable.utils.Input, ~langchain.schema.runnable.utils.Output]], *, exceptions_to_handle: ~typing.Tuple[~typing.Type[BaseException], ...] = (<class 'Exception'>,)) →... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.owner.AINOwnerOps.html |
f35b601dd9c2-0 | langchain.tools.amadeus.utils.authenticate¶
langchain.tools.amadeus.utils.authenticate() → Client[source]¶
Authenticate using the Amadeus API | https://api.python.langchain.com/en/latest/tools/langchain.tools.amadeus.utils.authenticate.html |
8894598cd87b-0 | langchain.tools.sleep.tool.SleepInput¶
class langchain.tools.sleep.tool.SleepInput[source]¶
Bases: BaseModel
Input for CopyFileTool.
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 sleep_time: int [Req... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sleep.tool.SleepInput.html |
8894598cd87b-1 | Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
classmethod from_orm(obj: Any) → Model¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False,... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sleep.tool.SleepInput.html |
77428b3162c8-0 | langchain.tools.gitlab.tool.GitLabAction¶
class langchain.tools.gitlab.tool.GitLabAction[source]¶
Bases: BaseTool
Tool for interacting with the GitLab 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.
par... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gitlab.tool.GitLabAction.html |
77428b3162c8-1 | Optional list of tags associated with the tool. Defaults to None
These tags will be associated with each call to this tool,
and passed as arguments to the handlers defined in callbacks.
You can use these to eg identify a specific instance of a tool with its use case.
param verbose: bool = False¶
Whether to log the tool... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gitlab.tool.GitLabAction.html |
77428b3162c8-2 | Default implementation of astream, which calls ainvoke.
Subclasses should override this method if they support streaming output.
async astream_log(input: Any, config: Optional[RunnableConfig] = None, *, include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gitlab.tool.GitLabAction.html |
77428b3162c8-3 | Bind arguments to a Runnable, returning a new Runnable.
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
Default values are respected, but no other validation is performed.
Behaves as if Config... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gitlab.tool.GitLabAction.html |
77428b3162c8-4 | json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Cal... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gitlab.tool.GitLabAction.html |
77428b3162c8-5 | Run the tool.
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode¶
stream(input: Input, config: Optional[RunnableConfig] = None, **kwargs... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gitlab.tool.GitLabAction.html |
77428b3162c8-6 | property InputType: Type[langchain.schema.runnable.utils.Input]¶
property OutputType: Type[langchain.schema.runnable.utils.Output]¶
property args: dict¶
property input_schema: Type[pydantic.main.BaseModel]¶
The tool’s input schema.
property is_single_input: bool¶
Whether the tool only accepts a single input.
property o... | https://api.python.langchain.com/en/latest/tools/langchain.tools.gitlab.tool.GitLabAction.html |
87528832366a-0 | langchain.tools.bing_search.tool.BingSearchRun¶
class langchain.tools.bing_search.tool.BingSearchRun[source]¶
Bases: BaseTool
Tool that queries the Bing 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 m... | https://api.python.langchain.com/en/latest/tools/langchain.tools.bing_search.tool.BingSearchRun.html |
87528832366a-1 | that after the tool is called, the AgentExecutor will stop looping.
param tags: Optional[List[str]] = None¶
Optional list of tags associated with the tool. Defaults to None
These tags will be associated with each call to this tool,
and passed as arguments to the handlers defined in callbacks.
You can use these to eg id... | https://api.python.langchain.com/en/latest/tools/langchain.tools.bing_search.tool.BingSearchRun.html |
87528832366a-2 | Run the tool asynchronously.
async astream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) → AsyncIterator[Output]¶
Default implementation of astream, which calls ainvoke.
Subclasses should override this method if they support streaming output.
async astream_log(input: Any, config: Optio... | https://api.python.langchain.com/en/latest/tools/langchain.tools.bing_search.tool.BingSearchRun.html |
87528832366a-3 | Subclasses should override this method if they can batch more efficiently.
bind(**kwargs: Any) → Runnable[Input, Output]¶
Bind arguments to a Runnable, returning a new Runnable.
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new model setting __dict__ and __fields_set__ fr... | https://api.python.langchain.com/en/latest/tools/langchain.tools.bing_search.tool.BingSearchRun.html |
87528832366a-4 | classmethod from_orm(obj: Any) → Model¶
invoke(input: Union[str, Dict], config: Optional[RunnableConfig] = None, **kwargs: Any) → Any¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults... | https://api.python.langchain.com/en/latest/tools/langchain.tools.bing_search.tool.BingSearchRun.html |
87528832366a-5 | 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, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[st... | https://api.python.langchain.com/en/latest/tools/langchain.tools.bing_search.tool.BingSearchRun.html |
87528832366a-6 | Bind config to a Runnable, returning a new Runnable.
with_fallbacks(fallbacks: ~typing.Sequence[~langchain.schema.runnable.base.Runnable[~langchain.schema.runnable.utils.Input, ~langchain.schema.runnable.utils.Output]], *, exceptions_to_handle: ~typing.Tuple[~typing.Type[BaseException], ...] = (<class 'Exception'>,)) →... | https://api.python.langchain.com/en/latest/tools/langchain.tools.bing_search.tool.BingSearchRun.html |
eb217246d67a-0 | langchain.tools.dataforseo_api_search.tool.DataForSeoAPISearchRun¶
class langchain.tools.dataforseo_api_search.tool.DataForSeoAPISearchRun[source]¶
Bases: BaseTool
Tool that queries the DataForSeo Google search API.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError i... | https://api.python.langchain.com/en/latest/tools/langchain.tools.dataforseo_api_search.tool.DataForSeoAPISearchRun.html |
eb217246d67a-1 | param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
param tags: Optional[List[str]] = None¶
Optional list of tags associated with the tool. Defaults to None
These tags will be associated with each... | https://api.python.langchain.com/en/latest/tools/langchain.tools.dataforseo_api_search.tool.DataForSeoAPISearchRun.html |
eb217246d67a-2 | Run the tool asynchronously.
async astream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) → AsyncIterator[Output]¶
Default implementation of astream, which calls ainvoke.
Subclasses should override this method if they support streaming output.
async astream_log(input: Any, config: Optio... | https://api.python.langchain.com/en/latest/tools/langchain.tools.dataforseo_api_search.tool.DataForSeoAPISearchRun.html |
eb217246d67a-3 | Subclasses should override this method if they can batch more efficiently.
bind(**kwargs: Any) → Runnable[Input, Output]¶
Bind arguments to a Runnable, returning a new Runnable.
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new model setting __dict__ and __fields_set__ fr... | https://api.python.langchain.com/en/latest/tools/langchain.tools.dataforseo_api_search.tool.DataForSeoAPISearchRun.html |
eb217246d67a-4 | classmethod from_orm(obj: Any) → Model¶
invoke(input: Union[str, Dict], config: Optional[RunnableConfig] = None, **kwargs: Any) → Any¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults... | https://api.python.langchain.com/en/latest/tools/langchain.tools.dataforseo_api_search.tool.DataForSeoAPISearchRun.html |
eb217246d67a-5 | 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, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[st... | https://api.python.langchain.com/en/latest/tools/langchain.tools.dataforseo_api_search.tool.DataForSeoAPISearchRun.html |
eb217246d67a-6 | Bind config to a Runnable, returning a new Runnable.
with_fallbacks(fallbacks: ~typing.Sequence[~langchain.schema.runnable.base.Runnable[~langchain.schema.runnable.utils.Input, ~langchain.schema.runnable.utils.Output]], *, exceptions_to_handle: ~typing.Tuple[~typing.Type[BaseException], ...] = (<class 'Exception'>,)) →... | https://api.python.langchain.com/en/latest/tools/langchain.tools.dataforseo_api_search.tool.DataForSeoAPISearchRun.html |
8e5b9b06267b-0 | langchain.tools.office365.send_event.SendEventSchema¶
class langchain.tools.office365.send_event.SendEventSchema[source]¶
Bases: BaseModel
Input for CreateEvent 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... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.send_event.SendEventSchema.html |
8e5b9b06267b-1 | Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
Default values are respected, but no other validation is performed.
Behaves as if Config.extra = ‘allow’ was set since it adds all passed values
copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclu... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.send_event.SendEventSchema.html |
8e5b9b06267b-2 | classmethod from_orm(obj: Any) → Model¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_n... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.send_event.SendEventSchema.html |
a9e25cbdc45e-0 | langchain.tools.file_management.file_search.FileSearchTool¶
class langchain.tools.file_management.file_search.FileSearchTool[source]¶
Bases: BaseFileToolMixin, BaseTool
Tool that searches for files in a subdirectory that match a regex pattern.
Create a new model by parsing and validating input data from keyword argumen... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.file_search.FileSearchTool.html |
a9e25cbdc45e-1 | that after the tool is called, the AgentExecutor will stop looping.
param root_dir: Optional[str] = None¶
The final path will be chosen relative to root_dir if specified.
param tags: Optional[List[str]] = None¶
Optional list of tags associated with the tool. Defaults to None
These tags will be associated with each call... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.file_search.FileSearchTool.html |
a9e25cbdc45e-2 | Run the tool asynchronously.
async astream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) → AsyncIterator[Output]¶
Default implementation of astream, which calls ainvoke.
Subclasses should override this method if they support streaming output.
async astream_log(input: Any, config: Optio... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.file_search.FileSearchTool.html |
a9e25cbdc45e-3 | Subclasses should override this method if they can batch more efficiently.
bind(**kwargs: Any) → Runnable[Input, Output]¶
Bind arguments to a Runnable, returning a new Runnable.
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new model setting __dict__ and __fields_set__ fr... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.file_search.FileSearchTool.html |
a9e25cbdc45e-4 | classmethod from_orm(obj: Any) → Model¶
get_relative_path(file_path: str) → Path¶
Get the relative path, returning an error if unsupported.
invoke(input: Union[str, Dict], config: Optional[RunnableConfig] = None, **kwargs: Any) → Any¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.file_search.FileSearchTool.html |
a9e25cbdc45e-5 | 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, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[st... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.file_search.FileSearchTool.html |
a9e25cbdc45e-6 | Bind config to a Runnable, returning a new Runnable.
with_fallbacks(fallbacks: ~typing.Sequence[~langchain.schema.runnable.base.Runnable[~langchain.schema.runnable.utils.Input, ~langchain.schema.runnable.utils.Output]], *, exceptions_to_handle: ~typing.Tuple[~typing.Type[BaseException], ...] = (<class 'Exception'>,)) →... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.file_search.FileSearchTool.html |
93fc486add0f-0 | langchain.tools.sql_database.tool.QuerySQLDataBaseTool¶
class langchain.tools.sql_database.tool.QuerySQLDataBaseTool[source]¶
Bases: BaseSQLDatabaseTool, BaseTool
Tool for querying a SQL database.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data ca... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLDataBaseTool.html |
93fc486add0f-1 | param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
param tags: Optional[List[str]] = None¶
Optional list of tags associated with the tool. Defaults to None
These tags will be associated with each... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLDataBaseTool.html |
93fc486add0f-2 | Run the tool asynchronously.
async astream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) → AsyncIterator[Output]¶
Default implementation of astream, which calls ainvoke.
Subclasses should override this method if they support streaming output.
async astream_log(input: Any, config: Optio... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLDataBaseTool.html |
93fc486add0f-3 | Subclasses should override this method if they can batch more efficiently.
bind(**kwargs: Any) → Runnable[Input, Output]¶
Bind arguments to a Runnable, returning a new Runnable.
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new model setting __dict__ and __fields_set__ fr... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLDataBaseTool.html |
93fc486add0f-4 | classmethod from_orm(obj: Any) → Model¶
invoke(input: Union[str, Dict], config: Optional[RunnableConfig] = None, **kwargs: Any) → Any¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLDataBaseTool.html |
93fc486add0f-5 | 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, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[st... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLDataBaseTool.html |
93fc486add0f-6 | Bind config to a Runnable, returning a new Runnable.
with_fallbacks(fallbacks: ~typing.Sequence[~langchain.schema.runnable.base.Runnable[~langchain.schema.runnable.utils.Input, ~langchain.schema.runnable.utils.Output]], *, exceptions_to_handle: ~typing.Tuple[~typing.Type[BaseException], ...] = (<class 'Exception'>,)) →... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sql_database.tool.QuerySQLDataBaseTool.html |
2bf3a2d4e3c9-0 | langchain.tools.multion.create_session.MultionCreateSession¶
class langchain.tools.multion.create_session.MultionCreateSession[source]¶
Bases: BaseTool
Tool that creates a new Multion Browser Window with provided fields.
name¶
The name of the tool. Default: “create_multion_session”
description¶
The description of the t... | https://api.python.langchain.com/en/latest/tools/langchain.tools.multion.create_session.MultionCreateSession.html |
2bf3a2d4e3c9-1 | Optional metadata associated with the tool. Defaults to None
This metadata will be associated with each call to this tool,
and passed as arguments to the handlers defined in callbacks.
You can use these to eg identify a specific instance of a tool with its use case.
param name: str = 'create_multion_session'¶
The uniqu... | https://api.python.langchain.com/en/latest/tools/langchain.tools.multion.create_session.MultionCreateSession.html |
2bf3a2d4e3c9-2 | Subclasses should override this method if they can run asynchronously.
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, *, tags: Optional[List[... | https://api.python.langchain.com/en/latest/tools/langchain.tools.multion.create_session.MultionCreateSession.html |
2bf3a2d4e3c9-3 | Default implementation of atransform, which buffers input and calls astream.
Subclasses should override this method if they can start producing output while
input is still being generated.
batch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False... | https://api.python.langchain.com/en/latest/tools/langchain.tools.multion.create_session.MultionCreateSession.html |
2bf3a2d4e3c9-4 | deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, ex... | https://api.python.langchain.com/en/latest/tools/langchain.tools.multion.create_session.MultionCreateSession.html |
2bf3a2d4e3c9-5 | classmethod parse_obj(obj: Any) → Model¶
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model¶
run(tool_input: Union[str, Dict], verbose: Optional[bool] = None, start_color: Optional[str] = 'green', color: Op... | https://api.python.langchain.com/en/latest/tools/langchain.tools.multion.create_session.MultionCreateSession.html |
2bf3a2d4e3c9-6 | Bind config to a Runnable, returning a new Runnable.
with_fallbacks(fallbacks: ~typing.Sequence[~langchain.schema.runnable.base.Runnable[~langchain.schema.runnable.utils.Input, ~langchain.schema.runnable.utils.Output]], *, exceptions_to_handle: ~typing.Tuple[~typing.Type[BaseException], ...] = (<class 'Exception'>,)) →... | https://api.python.langchain.com/en/latest/tools/langchain.tools.multion.create_session.MultionCreateSession.html |
007ec5305546-0 | langchain.tools.base.BaseTool¶
class langchain.tools.base.BaseTool[source]¶
Bases: BaseModel, Runnable[Union[str, Dict], Any]
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 vali... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.BaseTool.html |
007ec5305546-1 | param tags: Optional[List[str]] = None¶
Optional list of tags associated with the tool. Defaults to None
These tags will be associated with each call to this tool,
and passed as arguments to the handlers defined in callbacks.
You can use these to eg identify a specific instance of a tool with its use case.
param verbos... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.BaseTool.html |
007ec5305546-2 | Default implementation of astream, which calls ainvoke.
Subclasses should override this method if they support streaming output.
async astream_log(input: Any, config: Optional[RunnableConfig] = None, *, include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.BaseTool.html |
007ec5305546-3 | Bind arguments to a Runnable, returning a new Runnable.
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
Default values are respected, but no other validation is performed.
Behaves as if Config... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.BaseTool.html |
007ec5305546-4 | json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Cal... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.BaseTool.html |
007ec5305546-5 | Run the tool.
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode¶
stream(input: Input, config: Optional[RunnableConfig] = None, **kwargs... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.BaseTool.html |
007ec5305546-6 | property InputType: Type[langchain.schema.runnable.utils.Input]¶
property OutputType: Type[langchain.schema.runnable.utils.Output]¶
property args: dict¶
property input_schema: Type[pydantic.main.BaseModel]¶
The tool’s input schema.
property is_single_input: bool¶
Whether the tool only accepts a single input.
property o... | https://api.python.langchain.com/en/latest/tools/langchain.tools.base.BaseTool.html |
91d44685625a-0 | langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool¶
class langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool[source]¶
Bases: BaseBrowserTool
Extract all hyperlinks on the page.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool.html |
91d44685625a-1 | that after the tool is called, the AgentExecutor will stop looping.
param sync_browser: Optional['SyncBrowser'] = None¶
param tags: Optional[List[str]] = None¶
Optional list of tags associated with the tool. Defaults to None
These tags will be associated with each call to this tool,
and passed as arguments to the handl... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool.html |
91d44685625a-2 | Run the tool asynchronously.
async astream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) → AsyncIterator[Output]¶
Default implementation of astream, which calls ainvoke.
Subclasses should override this method if they support streaming output.
async astream_log(input: Any, config: Optio... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool.html |
91d44685625a-3 | Subclasses should override this method if they can batch more efficiently.
bind(**kwargs: Any) → Runnable[Input, Output]¶
Bind arguments to a Runnable, returning a new Runnable.
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new model setting __dict__ and __fields_set__ fr... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool.html |
91d44685625a-4 | Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
classmethod from_browser(sync_browser: Optional[SyncBrowser] = None, async_browser: Optional[AsyncBrowser] = None) → BaseBrowserTool¶
Instantiate the tool.
classmethod from_orm(obj: Any) → Model¶
invoke(input: U... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool.html |
91d44685625a-5 | 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, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[st... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool.html |
91d44685625a-6 | Bind config to a Runnable, returning a new Runnable.
with_fallbacks(fallbacks: ~typing.Sequence[~langchain.schema.runnable.base.Runnable[~langchain.schema.runnable.utils.Input, ~langchain.schema.runnable.utils.Output]], *, exceptions_to_handle: ~typing.Tuple[~typing.Type[BaseException], ...] = (<class 'Exception'>,)) →... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_hyperlinks.ExtractHyperlinksTool.html |
cdd47b227bc7-0 | langchain.tools.json.tool.JsonGetValueTool¶
class langchain.tools.json.tool.JsonGetValueTool[source]¶
Bases: BaseTool
Tool for getting a value 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.
... | https://api.python.langchain.com/en/latest/tools/langchain.tools.json.tool.JsonGetValueTool.html |
cdd47b227bc7-1 | param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
param spec: JsonSpec [Required]¶
param tags: Optional[List[str]] = None¶
Optional list of tags associated with the tool. Defaults to None
These ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.json.tool.JsonGetValueTool.html |
cdd47b227bc7-2 | Run the tool asynchronously.
async astream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) → AsyncIterator[Output]¶
Default implementation of astream, which calls ainvoke.
Subclasses should override this method if they support streaming output.
async astream_log(input: Any, config: Optio... | https://api.python.langchain.com/en/latest/tools/langchain.tools.json.tool.JsonGetValueTool.html |
cdd47b227bc7-3 | Subclasses should override this method if they can batch more efficiently.
bind(**kwargs: Any) → Runnable[Input, Output]¶
Bind arguments to a Runnable, returning a new Runnable.
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new model setting __dict__ and __fields_set__ fr... | https://api.python.langchain.com/en/latest/tools/langchain.tools.json.tool.JsonGetValueTool.html |
cdd47b227bc7-4 | classmethod from_orm(obj: Any) → Model¶
invoke(input: Union[str, Dict], config: Optional[RunnableConfig] = None, **kwargs: Any) → Any¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults... | https://api.python.langchain.com/en/latest/tools/langchain.tools.json.tool.JsonGetValueTool.html |
cdd47b227bc7-5 | 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, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[st... | https://api.python.langchain.com/en/latest/tools/langchain.tools.json.tool.JsonGetValueTool.html |
cdd47b227bc7-6 | Bind config to a Runnable, returning a new Runnable.
with_fallbacks(fallbacks: ~typing.Sequence[~langchain.schema.runnable.base.Runnable[~langchain.schema.runnable.utils.Input, ~langchain.schema.runnable.utils.Output]], *, exceptions_to_handle: ~typing.Tuple[~typing.Type[BaseException], ...] = (<class 'Exception'>,)) →... | https://api.python.langchain.com/en/latest/tools/langchain.tools.json.tool.JsonGetValueTool.html |
f55bbaf491af-0 | langchain.tools.file_management.copy.FileCopyInput¶
class langchain.tools.file_management.copy.FileCopyInput[source]¶
Bases: BaseModel
Input for CopyFileTool.
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.
... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.copy.FileCopyInput.html |
f55bbaf491af-1 | deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, ex... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.copy.FileCopyInput.html |
f55bbaf491af-2 | classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode¶
classmethod update_forward_refs(**localns: Any) → None¶
Try to update ForwardRefs on... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.copy.FileCopyInput.html |
ad31e2c3101b-0 | langchain.tools.jira.tool.JiraAction¶
class langchain.tools.jira.tool.JiraAction[source]¶
Bases: BaseTool
Tool that queries the Atlassian Jira 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_w... | https://api.python.langchain.com/en/latest/tools/langchain.tools.jira.tool.JiraAction.html |
ad31e2c3101b-1 | Optional list of tags associated with the tool. Defaults to None
These tags will be associated with each call to this tool,
and passed as arguments to the handlers defined in callbacks.
You can use these to eg identify a specific instance of a tool with its use case.
param verbose: bool = False¶
Whether to log the tool... | https://api.python.langchain.com/en/latest/tools/langchain.tools.jira.tool.JiraAction.html |
ad31e2c3101b-2 | Default implementation of astream, which calls ainvoke.
Subclasses should override this method if they support streaming output.
async astream_log(input: Any, config: Optional[RunnableConfig] = None, *, include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[... | https://api.python.langchain.com/en/latest/tools/langchain.tools.jira.tool.JiraAction.html |
ad31e2c3101b-3 | Bind arguments to a Runnable, returning a new Runnable.
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
Default values are respected, but no other validation is performed.
Behaves as if Config... | https://api.python.langchain.com/en/latest/tools/langchain.tools.jira.tool.JiraAction.html |
ad31e2c3101b-4 | json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Cal... | https://api.python.langchain.com/en/latest/tools/langchain.tools.jira.tool.JiraAction.html |
ad31e2c3101b-5 | Run the tool.
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode¶
stream(input: Input, config: Optional[RunnableConfig] = None, **kwargs... | https://api.python.langchain.com/en/latest/tools/langchain.tools.jira.tool.JiraAction.html |
ad31e2c3101b-6 | property InputType: Type[langchain.schema.runnable.utils.Input]¶
property OutputType: Type[langchain.schema.runnable.utils.Output]¶
property args: dict¶
property input_schema: Type[pydantic.main.BaseModel]¶
The tool’s input schema.
property is_single_input: bool¶
Whether the tool only accepts a single input.
property o... | https://api.python.langchain.com/en/latest/tools/langchain.tools.jira.tool.JiraAction.html |
5314160eb65c-0 | langchain.tools.playwright.extract_text.ExtractTextTool¶
class langchain.tools.playwright.extract_text.ExtractTextTool[source]¶
Bases: BaseBrowserTool
Tool for extracting all the text on the current webpage.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the in... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_text.ExtractTextTool.html |
5314160eb65c-1 | param sync_browser: Optional['SyncBrowser'] = None¶
param tags: Optional[List[str]] = None¶
Optional list of tags associated with the tool. Defaults to None
These tags will be associated with each call to this tool,
and passed as arguments to the handlers defined in callbacks.
You can use these to eg identify a specifi... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_text.ExtractTextTool.html |
5314160eb65c-2 | Default implementation of astream, which calls ainvoke.
Subclasses should override this method if they support streaming output.
async astream_log(input: Any, config: Optional[RunnableConfig] = None, *, include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_text.ExtractTextTool.html |
5314160eb65c-3 | Bind arguments to a Runnable, returning a new Runnable.
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
Default values are respected, but no other validation is performed.
Behaves as if Config... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_text.ExtractTextTool.html |
5314160eb65c-4 | Instantiate the tool.
classmethod from_orm(obj: Any) → Model¶
invoke(input: Union[str, Dict], config: Optional[RunnableConfig] = None, **kwargs: Any) → Any¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_text.ExtractTextTool.html |
5314160eb65c-5 | 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, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[st... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_text.ExtractTextTool.html |
5314160eb65c-6 | Bind config to a Runnable, returning a new Runnable.
with_fallbacks(fallbacks: ~typing.Sequence[~langchain.schema.runnable.base.Runnable[~langchain.schema.runnable.utils.Input, ~langchain.schema.runnable.utils.Output]], *, exceptions_to_handle: ~typing.Tuple[~typing.Type[BaseException], ...] = (<class 'Exception'>,)) →... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.extract_text.ExtractTextTool.html |
291a7cc5b5af-0 | langchain.tools.azure_cognitive_services.utils.detect_file_src_type¶
langchain.tools.azure_cognitive_services.utils.detect_file_src_type(file_path: str) → str[source]¶
Detect if the file is local or remote. | https://api.python.langchain.com/en/latest/tools/langchain.tools.azure_cognitive_services.utils.detect_file_src_type.html |
cf89700417b1-0 | langchain.tools.gmail.utils.clean_email_body¶
langchain.tools.gmail.utils.clean_email_body(body: str) → str[source]¶
Clean email body. | https://api.python.langchain.com/en/latest/tools/langchain.tools.gmail.utils.clean_email_body.html |
c3a128062ad2-0 | langchain.tools.powerbi.tool.InfoPowerBITool¶
class langchain.tools.powerbi.tool.InfoPowerBITool[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... | https://api.python.langchain.com/en/latest/tools/langchain.tools.powerbi.tool.InfoPowerBITool.html |
c3a128062ad2-1 | param return_direct: bool = False¶
Whether to return the tool’s output directly. Setting this to True means
that after the tool is called, the AgentExecutor will stop looping.
param tags: Optional[List[str]] = None¶
Optional list of tags associated with the tool. Defaults to None
These tags will be associated with each... | https://api.python.langchain.com/en/latest/tools/langchain.tools.powerbi.tool.InfoPowerBITool.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.