id stringlengths 14 15 | text stringlengths 44 2.47k | source stringlengths 61 181 |
|---|---|---|
f2659f27b787-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.youtube.search.YouTubeSearchTool.html |
f2659f27b787-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.youtube.search.YouTubeSearchTool.html |
f2659f27b787-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.youtube.search.YouTubeSearchTool.html |
18a59f041253-0 | langchain.tools.ainetwork.rule.RuleSchema¶
class langchain.tools.ainetwork.rule.RuleSchema[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 eval: Optional[str] = None¶
eval str... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.rule.RuleSchema.html |
18a59f041253-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.ainetwork.rule.RuleSchema.html |
18a59f041253-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.ainetwork.rule.RuleSchema.html |
b434488f6353-0 | langchain.tools.ainetwork.transfer.AINTransfer¶
class langchain.tools.ainetwork.transfer.AINTransfer[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[langch... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.transfer.AINTransfer.html |
b434488f6353-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.ainetwork.transfer.AINTransfer.html |
b434488f6353-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.ainetwork.transfer.AINTransfer.html |
b434488f6353-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.ainetwork.transfer.AINTransfer.html |
b434488f6353-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.ainetwork.transfer.AINTransfer.html |
b434488f6353-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.ainetwork.transfer.AINTransfer.html |
b434488f6353-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.ainetwork.transfer.AINTransfer.html |
4d98a36cd0ef-0 | langchain.tools.pubmed.tool.PubmedQueryRun¶
class langchain.tools.pubmed.tool.PubmedQueryRun[source]¶
Bases: BaseTool
Tool that searches the PubMed 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 ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.pubmed.tool.PubmedQueryRun.html |
4d98a36cd0ef-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 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 a... | https://api.python.langchain.com/en/latest/tools/langchain.tools.pubmed.tool.PubmedQueryRun.html |
4d98a36cd0ef-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.pubmed.tool.PubmedQueryRun.html |
4d98a36cd0ef-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.pubmed.tool.PubmedQueryRun.html |
4d98a36cd0ef-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.pubmed.tool.PubmedQueryRun.html |
4d98a36cd0ef-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.pubmed.tool.PubmedQueryRun.html |
4d98a36cd0ef-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.pubmed.tool.PubmedQueryRun.html |
c4e048a45c97-0 | langchain.tools.steamship_image_generation.tool.ModelName¶
class langchain.tools.steamship_image_generation.tool.ModelName(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Supported Image Models for generation.
DALL_E = 'dall-e'¶
STABLE_DIFFUSION = 'stable-diffusion'¶ | https://api.python.langchain.com/en/latest/tools/langchain.tools.steamship_image_generation.tool.ModelName.html |
4b6719f9c538-0 | langchain.tools.ainetwork.owner.RuleSchema¶
class langchain.tools.ainetwork.owner.RuleSchema[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 address: Optional[Union[str, List[... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.owner.RuleSchema.html |
4b6719f9c538-1 | 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 creating
the new model: you should trust this data
deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, i... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.owner.RuleSchema.html |
4b6719f9c538-2 | 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¶
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmet... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.owner.RuleSchema.html |
d5212acbcb79-0 | langchain.tools.interaction.tool.StdInInquireTool¶
langchain.tools.interaction.tool.StdInInquireTool(*args: Any, **kwargs: Any) → HumanInputRun[source]¶
Tool for asking the user for input. | https://api.python.langchain.com/en/latest/tools/langchain.tools.interaction.tool.StdInInquireTool.html |
1539c78362ce-0 | langchain.tools.playwright.navigate.NavigateToolInput¶
class langchain.tools.playwright.navigate.NavigateToolInput[source]¶
Bases: BaseModel
Input for NavigateToolInput.
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 va... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.navigate.NavigateToolInput.html |
1539c78362ce-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.playwright.navigate.NavigateToolInput.html |
1539c78362ce-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.playwright.navigate.NavigateToolInput.html |
bdf7aad17158-0 | langchain.tools.render.render_text_description_and_args¶
langchain.tools.render.render_text_description_and_args(tools: List[BaseTool]) → str[source]¶
Render the tool name, description, and args in plain text.
Output will be in the format of:
search: This tool is used for search, args: {"query": {"type": "string"}}
cal... | https://api.python.langchain.com/en/latest/tools/langchain.tools.render.render_text_description_and_args.html |
30855ed119d5-0 | langchain.tools.file_management.utils.BaseFileToolMixin¶
class langchain.tools.file_management.utils.BaseFileToolMixin[source]¶
Bases: BaseModel
Mixin for file system 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 ... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.utils.BaseFileToolMixin.html |
30855ed119d5-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.utils.BaseFileToolMixin.html |
30855ed119d5-2 | 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¶
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmet... | https://api.python.langchain.com/en/latest/tools/langchain.tools.file_management.utils.BaseFileToolMixin.html |
9fb5cfd4d8c3-0 | langchain.tools.brave_search.tool.BraveSearch¶
class langchain.tools.brave_search.tool.BraveSearch[source]¶
Bases: BaseTool
Tool that queries the BraveSearch.
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.brave_search.tool.BraveSearch.html |
9fb5cfd4d8c3-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.brave_search.tool.BraveSearch.html |
9fb5cfd4d8c3-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.brave_search.tool.BraveSearch.html |
9fb5cfd4d8c3-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.brave_search.tool.BraveSearch.html |
9fb5cfd4d8c3-4 | Create a tool from an api key.
Parameters
api_key – The api key to use.
search_kwargs – Any additional kwargs to pass to the search wrapper.
**kwargs – Any additional kwargs to pass to the tool.
Returns
A tool.
classmethod from_orm(obj: Any) → Model¶
invoke(input: Union[str, Dict], config: Optional[RunnableConfig] = No... | https://api.python.langchain.com/en/latest/tools/langchain.tools.brave_search.tool.BraveSearch.html |
9fb5cfd4d8c3-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.brave_search.tool.BraveSearch.html |
9fb5cfd4d8c3-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.brave_search.tool.BraveSearch.html |
7adbb1cee362-0 | langchain.tools.ainetwork.transfer.TransferSchema¶
class langchain.tools.ainetwork.transfer.TransferSchema[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 address: str [Requir... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.transfer.TransferSchema.html |
7adbb1cee362-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.ainetwork.transfer.TransferSchema.html |
7adbb1cee362-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.ainetwork.transfer.TransferSchema.html |
2c74afeb1895-0 | langchain.tools.ainetwork.base.AINBaseTool¶
class langchain.tools.ainetwork.base.AINBaseTool[source]¶
Bases: BaseTool
Base class for the AINetwork 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... | https://api.python.langchain.com/en/latest/tools/langchain.tools.ainetwork.base.AINBaseTool.html |
2c74afeb1895-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.ainetwork.base.AINBaseTool.html |
2c74afeb1895-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.ainetwork.base.AINBaseTool.html |
2c74afeb1895-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.ainetwork.base.AINBaseTool.html |
2c74afeb1895-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.ainetwork.base.AINBaseTool.html |
2c74afeb1895-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.ainetwork.base.AINBaseTool.html |
2c74afeb1895-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.ainetwork.base.AINBaseTool.html |
0a94a60fd7cb-0 | langchain.tools.office365.create_draft_message.O365CreateDraftMessage¶
class langchain.tools.office365.create_draft_message.O365CreateDraftMessage[source]¶
Bases: O365BaseTool
Tool for creating a draft email in Office 365.
Create a new model by parsing and validating input data from keyword arguments.
Raises Validation... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.create_draft_message.O365CreateDraftMessage.html |
0a94a60fd7cb-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.office365.create_draft_message.O365CreateDraftMessage.html |
0a94a60fd7cb-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.office365.create_draft_message.O365CreateDraftMessage.html |
0a94a60fd7cb-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.office365.create_draft_message.O365CreateDraftMessage.html |
0a94a60fd7cb-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.office365.create_draft_message.O365CreateDraftMessage.html |
0a94a60fd7cb-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.office365.create_draft_message.O365CreateDraftMessage.html |
0a94a60fd7cb-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.office365.create_draft_message.O365CreateDraftMessage.html |
eadf52842dac-0 | langchain.tools.yahoo_finance_news.YahooFinanceNewsTool¶
class langchain.tools.yahoo_finance_news.YahooFinanceNewsTool[source]¶
Bases: BaseTool
Tool that searches financial news on Yahoo Finance.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data can... | https://api.python.langchain.com/en/latest/tools/langchain.tools.yahoo_finance_news.YahooFinanceNewsTool.html |
eadf52842dac-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.yahoo_finance_news.YahooFinanceNewsTool.html |
eadf52842dac-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.yahoo_finance_news.YahooFinanceNewsTool.html |
eadf52842dac-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.yahoo_finance_news.YahooFinanceNewsTool.html |
eadf52842dac-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.yahoo_finance_news.YahooFinanceNewsTool.html |
eadf52842dac-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.yahoo_finance_news.YahooFinanceNewsTool.html |
eadf52842dac-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.yahoo_finance_news.YahooFinanceNewsTool.html |
6a83c3c16bd8-0 | langchain.tools.render.format_tool_to_openai_function¶
langchain.tools.render.format_tool_to_openai_function(tool: BaseTool) → FunctionDescription[source]¶
Format tool into the OpenAI function API.
Examples using format_tool_to_openai_function¶
Tools as OpenAI Functions | https://api.python.langchain.com/en/latest/tools/langchain.tools.render.format_tool_to_openai_function.html |
9084a2845096-0 | langchain.tools.gmail.send_message.SendMessageSchema¶
class langchain.tools.gmail.send_message.SendMessageSchema[source]¶
Bases: BaseModel
Input for SendMessageTool.
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.gmail.send_message.SendMessageSchema.html |
9084a2845096-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.gmail.send_message.SendMessageSchema.html |
9084a2845096-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.gmail.send_message.SendMessageSchema.html |
b345c63b3414-0 | langchain.tools.python.tool.PythonInputs¶
class langchain.tools.python.tool.PythonInputs[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 query: str [Required]¶
code snippet to... | https://api.python.langchain.com/en/latest/tools/langchain.tools.python.tool.PythonInputs.html |
b345c63b3414-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.python.tool.PythonInputs.html |
e17a22653709-0 | langchain.tools.sleep.tool.SleepTool¶
class langchain.tools.sleep.tool.SleepTool[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_sc... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sleep.tool.SleepTool.html |
e17a22653709-1 | 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’s progress.
__call__(tool_input: str, callbacks: Optional[Union[... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sleep.tool.SleepTool.html |
e17a22653709-2 | 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[Sequence[str]] = None, exclude_names: Optional[Sequence[... | https://api.python.langchain.com/en/latest/tools/langchain.tools.sleep.tool.SleepTool.html |
e17a22653709-3 | 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.sleep.tool.SleepTool.html |
e17a22653709-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.sleep.tool.SleepTool.html |
e17a22653709-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.sleep.tool.SleepTool.html |
e17a22653709-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.sleep.tool.SleepTool.html |
a287eed7b2fb-0 | langchain.tools.ddg_search.tool.DuckDuckGoSearchTool¶
langchain.tools.ddg_search.tool.DuckDuckGoSearchTool(*args: Any, **kwargs: Any) → DuckDuckGoSearchRun[source]¶
Deprecated. Use DuckDuckGoSearchRun instead.
Parameters
*args –
**kwargs –
Returns
DuckDuckGoSearchRun | https://api.python.langchain.com/en/latest/tools/langchain.tools.ddg_search.tool.DuckDuckGoSearchTool.html |
ea34bc870788-0 | langchain.tools.requests.tool.RequestsPostTool¶
class langchain.tools.requests.tool.RequestsPostTool[source]¶
Bases: BaseRequestsTool, BaseTool
Tool for making a POST request to an API endpoint.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cann... | https://api.python.langchain.com/en/latest/tools/langchain.tools.requests.tool.RequestsPostTool.html |
ea34bc870788-1 | You can use these to eg identify a specific instance of a tool with its use case.
param name: str = 'requests_post'¶
The unique name of the tool that clearly communicates its purpose.
param requests_wrapper: TextRequestsWrapper [Required]¶
param return_direct: bool = False¶
Whether to return the tool’s output directly.... | https://api.python.langchain.com/en/latest/tools/langchain.tools.requests.tool.RequestsPostTool.html |
ea34bc870788-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.requests.tool.RequestsPostTool.html |
ea34bc870788-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.requests.tool.RequestsPostTool.html |
ea34bc870788-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.requests.tool.RequestsPostTool.html |
ea34bc870788-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.requests.tool.RequestsPostTool.html |
ea34bc870788-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.requests.tool.RequestsPostTool.html |
52e77c2bedd9-0 | langchain.tools.github.tool.GitHubAction¶
class langchain.tools.github.tool.GitHubAction[source]¶
Bases: BaseTool
Tool for interacting with the GitHub 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.github.tool.GitHubAction.html |
52e77c2bedd9-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.github.tool.GitHubAction.html |
52e77c2bedd9-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.github.tool.GitHubAction.html |
52e77c2bedd9-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.github.tool.GitHubAction.html |
52e77c2bedd9-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.github.tool.GitHubAction.html |
52e77c2bedd9-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.github.tool.GitHubAction.html |
52e77c2bedd9-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.github.tool.GitHubAction.html |
b5fda9b1f1ba-0 | langchain.tools.playwright.get_elements.GetElementsTool¶
class langchain.tools.playwright.get_elements.GetElementsTool[source]¶
Bases: BaseBrowserTool
Tool for getting elements in the current web page matching a CSS selector.
Create a new model by parsing and validating input data from keyword arguments.
Raises Validat... | https://api.python.langchain.com/en/latest/tools/langchain.tools.playwright.get_elements.GetElementsTool.html |
b5fda9b1f1ba-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.get_elements.GetElementsTool.html |
b5fda9b1f1ba-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.get_elements.GetElementsTool.html |
b5fda9b1f1ba-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.get_elements.GetElementsTool.html |
b5fda9b1f1ba-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.get_elements.GetElementsTool.html |
b5fda9b1f1ba-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.get_elements.GetElementsTool.html |
b5fda9b1f1ba-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.get_elements.GetElementsTool.html |
ac05ed872a52-0 | langchain.tools.python.tool.sanitize_input¶
langchain.tools.python.tool.sanitize_input(query: str) → str[source]¶
Sanitize input to the python REPL.
Remove whitespace, backtick & python (if llm mistakes python console as terminal)
Parameters
query – The query to sanitize
Returns
The sanitized query
Return type
str | https://api.python.langchain.com/en/latest/tools/langchain.tools.python.tool.sanitize_input.html |
fd30666bd662-0 | langchain.tools.office365.base.O365BaseTool¶
class langchain.tools.office365.base.O365BaseTool[source]¶
Bases: BaseTool
Base class for the Office 365 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.
pa... | https://api.python.langchain.com/en/latest/tools/langchain.tools.office365.base.O365BaseTool.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.