`langchain_community.tools.file_management.move`.MoveFileTool¶

注意

MoveFileTool实现了标准Runnable 接口。🏃

Runnable 接口在runnables上还提供了额外的方法，例如with_types、with_retry、assign、bind和get_graph等。

class langchain_community.tools.file_management.move.MoveFileTool[源代码]¶

基类: BaseFileToolMixin、BaseTool

移动文件的工具。

初始化工具。

参数 args_schema: Type[BaseModel] = <class 'langchain_community.tools.file_management.move.FileMoveInput'>¶

Pydantic模型类，用于验证和解析工具的输入参数。

参数模式应该是：

pydantic.BaseModel的子类。

或 - pydantic 2 中访问 v1 命名空间时的pydantic.v1.BaseModel的子类。

参数 callback_manager: Optional[BaseCallbackManager] = None¶: 已弃用。请使用callbacks代替。

参数 callbacks : Callbacks = None¶: 在工具执行期间调用的回调。

param description: str = '将文件从一处位置移动或重命名到另一处'¶

用于告知模型何时/如何/为什么使用此工具。

您可以将少量示例作为描述的一部分提供。

param handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶: 处理抛出的 ToolException 的内容。

param handle_validation_error: Optional[Union[bool, str, Callable[[ValidationError], str]]] = False¶: 处理抛出的 ValidationError 的内容。

param metadata: Optional[Dict[str, Any]] = None¶: 与工具相关联的可选元数据。默认为 None。此元数据将与对工具的每次调用相关联，并作为参数传递到 callbacks 中定义的处理程序。您可以使用这些来识别特定工具的特定实例及其用法。

param response_format: Literal['content', 'content_and_artifact'] = 'content'¶

工具响应格式。默认为‘content’。

如果为“content”，则工具输出将被解释为ToolMessage的内容。如果为“content_and_artifact”，则输出将被期望为对应于ToolMessage（内容，工件）的两个元组。

param return_direct: bool = False¶

是否直接返回工具的输出。

将该值设置为True表示在调用工具后，AgentExecutor将停止循环。

param root_dir: Optional[str] = None¶: 如果指定，最终路径将选择相对于root_dir。

param tags: Optional[List[str]] = None¶: 与工具关联的可选标签列表。默认为None。这些标签将与该工具的每次调用相关联，并作为参数传递给在callbacks中定义的处理程序。您可以使用这些标签来表示具有其用例的工具的特定实例。

param verbose: bool = False¶: 是否记录工具的进度。

__call__(tool_input: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) → str¶

自langchain-core==0.1.47版本以来已弃用：使用invoke代替。

使工具可调用。

参数

tool_input (str) –
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) –

返回类型

str

async abatch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → List[Output]¶

默认实现使用asyncio.gather并行运行run。

默认实现适用于IO密集型的运行程序。

如果子类能够更高效地批量处理，则应覆盖此方法；例如，如果底层的Runnable使用支持批量模式的API。

参数

inputs (列表[输入]) – 要传递给Runnable的输入列表。
config (可选[联合[RunnableConfig, 列表[RunnableConfig]]]) – 在调用Runnable时使用的配置。配置支持标准的键，如用于跟踪的’tags’、‘metadata’，以及用于控制并行工作量的’max_concurrency’，以及其他键。请参考RunnableConfig获取更多详细信息。默认为None。
return_exceptions (布尔值) – 是否返回而不是抛出异常。默认为False。
kwargs (可选[任何]) – 要传递给Runnable的额外关键字参数。

返回

从Runnable返回的输出列表。

返回类型

列表[输出]

async abatch_as_completed(inputs: Sequence[输入], config: 可选[联合[RunnableConfig, 列表[RunnableConfig]]], *, return_exceptions: bool = False, **kwargs: 可选[任何]) → AsyncIterator[元组[int, 联合[输出, 异常]]]¶

在输入列表上并行运行run，产生完成的成果。

参数

inputs (序列[输入]) – 要传递给Runnable的输入列表。
config (可选[联合[RunnableConfig, Sequence[RunnableConfig]]]) – 在调用Runnable时使用的一个配置。该配置支持标准键，如用于跟踪的’tags’，‘metadata’，用于控制并行工作量的’max_concurrency’以及其他键。请参阅RunnableConfig以获取更多详情。默认值为None。默认值为None。
return_exceptions (布尔值) – 是否返回而不是抛出异常。默认为False。
kwargs (可选[任何]) – 要传递给Runnable的额外关键字参数。

产出

Runnable输出输入索引的元组。

返回类型

AsyncIterator[Tuple[int, 联合[Output, Exception]]]

async ainvoke(input: 联合[str, Dict, ToolCall], config: 可选[RunnableConfig] = None, **kwargs: 任意) → 任意¶

ainvoke的默认实现，从线程中调用invoke。

默认实现允许即使Runnable没有实现invoke的本地异步版本，也能使用异步代码。

子类应在其可以异步运行时重写此方法。

参数

input (联合[str, Dict, ToolCall]) –
config (可选[RunnableConfig]) –
kwargs (任意) –

返回类型

任意

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[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, run_id: Optional[UUID] = None, config: Optional[RunnableConfig] = None, tool_call_id: Optional[str] = None, **kwargs: Any) → Any¶

异步运行工具。

参数

tool_input (联合[str, Dict]) – 工具的输入。
verbose (可选[bool]) – 是否记录工具的进度。默认值为None。
start_color (可选[str]) – 启动工具时使用的颜色。默认值为‘green’。
color (可选[str]) – 结束工具时使用的颜色。默认值为‘green’。
callbacks (可选[联合[List[BaseCallbackHandler], BaseCallbackManager]]) – 执行工具时调用的回调。默认值为None。
tags (可选[List[str]]) – 与工具相关联的可选标签列表。默认值为None。
metadata (可选[Dict[str, 任意]]) – 与工具相关联的可选元数据。默认值为None。
run_name (可选[str]) – 运行的名称。默认为 None。
run_id (可选[UUID]) – 运行的 ID。默认为 None。
config (可选[RunnableConfig]) – 工具的配置。默认为 None。
tool_call_id (可选[str]) – 工具调用的 ID。默认为 None。
kwargs (任何) – 传递给工具的额外参数

返回

工具的输出。

抛出

ToolException – 如果工具执行期间发生错误。

返回类型

任意

as_tool(args_schema: Optional[Type[BaseModel]], *, name: Optional[str] = None, description: Optional[str] = None, arg_types: Optional[Dict[str, Type]] = None) → BaseTool¶

测试版

此 API 目前处于测试版，未来可能会有所改变。

从可运行对象创建 BaseTool。

as_tool 将实例化一个具有名称、描述和 args_schema 的 BaseTool，这些信息来自可运行对象。尽可能的情况下，会从 runnable.get_input_schema 推断模式。或者（例如，如果可运行对象以字典作为输入，并且特定的字典键没有类型），可以直接使用 args_schema 指定模式。还可以传递 arg_types 仅指定必需的参数及其类型。

参数

args_schema (可选[Type[BaseModel]]) – 工具的模式。默认为 None。
name (可选[str]) – 工具的名称。默认为 None。
description (可选[str]) – 工具的描述。默认为 None。
arg_types (可选[Dict[str, Type]]) – 参数名称到类型的字典。默认为 None。

返回

BaseTool 实例。

返回类型

BaseTool

类型化字典输入

from typing import List
from typing_extensions import TypedDict
from langchain_core.runnables import RunnableLambda

class Args(TypedDict):
    a: int
    b: List[int]

def f(x: Args) -> str:
    return str(x["a"] * max(x["b"]))

runnable = RunnableLambda(f)
as_tool = runnable.as_tool()
as_tool.invoke({"a": 3, "b": [1, 2]})

dict 输入，通过 args_schema 指定模式

from typing import Any, Dict, List
from langchain_core.pydantic_v1 import BaseModel, Field
from langchain_core.runnables import RunnableLambda

def f(x: Dict[str, Any]) -> str:
    return str(x["a"] * max(x["b"]))

class FSchema(BaseModel):
    """Apply a function to an integer and list of integers."""

    a: int = Field(..., description="Integer")
    b: List[int] = Field(..., description="List of ints")

runnable = RunnableLambda(f)
as_tool = runnable.as_tool(FSchema)
as_tool.invoke({"a": 3, "b": [1, 2]})

dict 输入，通过 arg_types 指定模式

from typing import Any, Dict, List
from langchain_core.runnables import RunnableLambda

def f(x: Dict[str, Any]) -> str:
    return str(x["a"] * max(x["b"]))

runnable = RunnableLambda(f)
as_tool = runnable.as_tool(arg_types={"a": int, "b": List[int]})
as_tool.invoke({"a": 3, "b": [1, 2]})

字符串输入

from langchain_core.runnables import RunnableLambda

def f(x: str) -> str:
    return x + "a"

def g(x: str) -> str:
    return x + "z"

runnable = RunnableLambda(f) | g
as_tool = runnable.as_tool()
as_tool.invoke("b")

从版本 0.2.14 开始引入。

async astream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) → AsyncIterator[Output]¶

astream 的默认实现，它调用了 ainvoke。如果子类支持流式输出，应重写该方法。

参数

input (Input) – Runnable 的输入。
config (可选[RunnableConfig]) – 用于 Runnable 的配置。默认为 None。
kwargs (可选[任何]) – 要传递给Runnable的额外关键字参数。

产出

Runnable 的输出。

返回类型

AsyncIterator[Output]

astream_events(input: Any, config: Optional[RunnableConfig] = None, *, version: Literal['v1', 'v2'], include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[Sequence[str]] = None, exclude_names: Optional[Sequence[str]] = None, exclude_types: Optional[Sequence[str]] = None, exclude_tags: Optional[Sequence[str]] = None, **kwargs: Any) → AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]¶

测试版

此 API 目前处于测试版，未来可能会有所改变。

生成事件流。

用于创建一个迭代器，遍历 StreamEvents，提供关于 Runnable 进展的实时信息，包括来自中间结果的 StreamEvents。

StreamEvent 是一个包含以下模式的字典

event: str - 事件名称的格式为：
on_[runnable_type]_(start|stream|end)。
name: str - 生成事件的 Runnable 的名称。
run_id: str - 与事件发出的 Runnable 的给定执行关联的随机生成的 ID。
作为父 Runnable 执行的一部分被调用的子 Runnable 将分配其唯一的 ID。
parent_ids: 列表[str] - 生成事件的父 Runnable 的 ID。
根 Runnable 将有一个空列表。父 ID 的顺序是从根到直接父级。仅在 API 的 v2 版本中可用。API 的 v1 版本将返回空列表。
tags: 可选[列表[str]] – 生成事件的 Runnable 的标签。
该事件。
metadata: Optional[Dict[str, Any]] - 由生成此事件的Runnable的元数据
。
data: Dict[str, Any]

以下是表格，展示了可能由各种链产生的一些事件。为了简洁，省略了元数据字段。链定义在表格之后。

注意此参考表是针对方案V2版本的。

事件	名称	块	输入	输出
on_chat_model_start	[模型名称]		{“messages”: [[SystemMessage, HumanMessage]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content="hello")
on_chat_model_end	[模型名称]		{“messages”: [[SystemMessage, HumanMessage]]}	AIMessageChunk(content="hello world")
on_llm_start	[模型名称]		{‘input’: ‘hello’}
on_llm_stream	[模型名称]	‘Hello’
on_llm_end	[模型名称]		‘Hello human!’
on_chain_start	format_docs
on_chain_stream	format_docs	“hello world!, goodbye world!”
on_chain_end	format_docs		[Document(…)]	“hello world!, goodbye world!”
on_tool_start	some_tool		{“x”: 1, “y”: “2”}
on_tool_end	some_tool			{“x”: 1, “y”: “2”}
on_retriever_start	[检索器名称]		{“query”: “hello”}
on_retriever_end	[检索器名称]		{“query”: “hello”}	[Document(…), ..]
on_prompt_start	[模板名称]		{“question”: “hello”}
on_prompt_end	[模板名称]		{“question”: “hello”}	ChatPromptValue(messages: [SystemMessage, …])

除了标准事件外，用户还可以派发自定义事件（如下所示）。

自定义事件仅会在API的V2版本中显示！

自定义事件具有以下格式

属性	类型	描述
名称	str	事件的用户定义名称。
数据	任意	与事件相关联的数据。这可以是任何东西，尽管我们建议使其可序列化为JSON。

以下是与上述标准事件关联的声明

format_docs:

def format_docs(docs: List[Document]) -> str:
    '''Format the docs.'''
    return ", ".join([doc.page_content for doc in docs])

format_docs = RunnableLambda(format_docs)

some_tool:

@tool
def some_tool(x: int, y: str) -> dict:
    '''Some_tool.'''
    return {"x": x, "y": y}

提示:

template = ChatPromptTemplate.from_messages(
    [("system", "You are Cat Agent 007"), ("human", "{question}")]
).with_config({"run_name": "my_template", "tags": ["my_template"]})

示例

from langchain_core.runnables import RunnableLambda

async def reverse(s: str) -> str:
    return s[::-1]

chain = RunnableLambda(func=reverse)

events = [
    event async for event in chain.astream_events("hello", version="v2")
]

# will produce the following events (run_id, and parent_ids
# has been omitted for brevity):
[
    {
        "data": {"input": "hello"},
        "event": "on_chain_start",
        "metadata": {},
        "name": "reverse",
        "tags": [],
    },
    {
        "data": {"chunk": "olleh"},
        "event": "on_chain_stream",
        "metadata": {},
        "name": "reverse",
        "tags": [],
    },
    {
        "data": {"output": "olleh"},
        "event": "on_chain_end",
        "metadata": {},
        "name": "reverse",
        "tags": [],
    },
]

示例：派发自定义事件

from langchain_core.callbacks.manager import (
    adispatch_custom_event,
)
from langchain_core.runnables import RunnableLambda, RunnableConfig
import asyncio


async def slow_thing(some_input: str, config: RunnableConfig) -> str:
    """Do something that takes a long time."""
    await asyncio.sleep(1) # Placeholder for some slow operation
    await adispatch_custom_event(
        "progress_event",
        {"message": "Finished step 1 of 3"},
        config=config # Must be included for python < 3.10
    )
    await asyncio.sleep(1) # Placeholder for some slow operation
    await adispatch_custom_event(
        "progress_event",
        {"message": "Finished step 2 of 3"},
        config=config # Must be included for python < 3.10
    )
    await asyncio.sleep(1) # Placeholder for some slow operation
    return "Done"

slow_thing = RunnableLambda(slow_thing)

async for event in slow_thing.astream_events("some_input", version="v2"):
    print(event)

参数

input (Any) – Runnable的输入。
config (Optional[RunnableConfig]) – 用于Runnable的配置。
version (Literal['v1', 'v2']) – 要使用的方案版本，既可以是 vill 或 v2。用户应使用 v2。 v1 用于向后兼容并在 0.4.0 中弃用。默认值将不在 API 稳定之前分配。自定义事件仅在 v2 中显示。
include_names (Optional[Sequence[str]]) – 仅包括具有匹配名称的runnables的事件。
include_types (Optional[Sequence[str]]) – 仅包括具有匹配类型的runnables的事件。
include_tags (Optional[Sequence[str]]) – 仅包括具有匹配标签的runnables的事件。
exclude_names (Optional[Sequence[str]]) – 排除具有匹配名称的runnables的事件。
exclude_types (Optional[Sequence[str]]) – 排除具有匹配类型的runnables的事件。
exclude_tags (Optional[Sequence[str]]) – 排除具有匹配标签的runnables的事件。
kwargs (Any) – 传递给Runnable的附加关键字参数。这些将通过 astream_log 传递，因为此 astream_events 实现是在 astream_log 之上构建的。

产出

StreamEvents 的异步流。

抛出

NotImplementedError – 如果版本不是 v1 或 v2。

返回类型

AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]

batch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → List[Output]

默认实现使用线程池执行器并行执行调用。

默认实现适用于IO密集型的运行程序。

如果子类能够更高效地批量处理，则应覆盖此方法；例如，如果底层的Runnable使用支持批量模式的API。

参数

inputs (列表[输入]) –
config (可选[Union[RunnableConfig，列表[RunnableConfig]]]) –
return_exceptions (布尔值) –
kwargs (可选[任何]) –

返回类型

列表[输出]

batch_as_completed(inputs: Sequence[Input], config: Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → Iterator[Tuple[int, Union[Output, Exception]]]¶

在输入列表上并行调用，按结果完成顺序输出。

参数

inputs (Sequence[Input]) –
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) –
return_exceptions (布尔值) –
kwargs (可选[任何]) –

返回类型

Iterator[Tuple[int, Union[Output, Exception]]]

configurable_alternatives(which: ConfigurableField, *, default_key: str = 'default', prefix_keys: bool = False, **kwargs: Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]) → RunnableSerializable[Input, Output]¶

配置可在运行时设置的运行实例的可选方案。

参数

which (ConfigurableField) – 将用于选择替代方案的 ConfigurableField 实例。
default_key (str) – 如果未选择任何替代方案，则使用的默认键。默认为“default”。
prefix_keys (bool) – 是否使用 ConfigurableField ID 作为键的前缀。默认为 False。
**kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到 Runnable 实例或返回 Runnable 实例的可调用对象的关键字对字典。

返回

配置了可选方案的新运行实例。

返回类型

RunnableSerializable[Input, Output]

from langchain_anthropic import ChatAnthropic
from langchain_core.runnables.utils import ConfigurableField
from langchain_openai import ChatOpenAI

model = ChatAnthropic(
    model_name="claude-3-sonnet-20240229"
).configurable_alternatives(
    ConfigurableField(id="llm"),
    default_key="anthropic",
    openai=ChatOpenAI()
)

# uses the default model ChatAnthropic
print(model.invoke("which organization created you?").content)

# uses ChatOpenAI
print(
    model.with_config(
        configurable={"llm": "openai"}
    ).invoke("which organization created you?").content
)

configurable_fields(**kwargs: Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) → RunnableSerializable[Input, Output]¶

实时配置特定的可运行程序字段。

参数: **kwargs (Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) – 一个配置的 ConfigurableField 实例的字典。
返回: 配置字段后的新可运行程序。
返回类型: RunnableSerializable[Input, Output]

from langchain_core.runnables import ConfigurableField
from langchain_openai import ChatOpenAI

model = ChatOpenAI(max_tokens=20).configurable_fields(
    max_tokens=ConfigurableField(
        id="output_token_number",
        name="Max tokens in the output",
        description="The maximum number of tokens in the output",
    )
)

# max_tokens = 20
print(
    "max_tokens_20: ",
    model.invoke("tell me something about chess").content
)

# max_tokens = 200
print("max_tokens_200: ", model.with_config(
    configurable={"output_token_number": 200}
    ).invoke("tell me something about chess").content
)

get_relative_path(file_path: str) → Path¶

获取相对路径，如果不受支持则返回错误。

参数: file_path (str) –
返回类型: 路径

invoke(input: Union[str, Dict, ToolCall], config: Optional[RunnableConfig] = None, **kwargs: Any) → Any¶

将单个输入转换为输出。重写以实施。

参数

input（《联合《str”、“Dict”，“ToolCall”）> – Runnable 的输入。
config（《可选《RunnableConfig》）> – 调用 Runnable 时使用的配置。配置支持标准键，如‘tags’，‘metadata’用于跟踪目的，‘max_concurrency’用于控制并行执行的工作量，以及其他键。请参阅 RunnableConfig 以获取更多详细信息。
kwargs (任意) –

返回

Runnable 的输出。

返回类型

任意

run(tool_input: Union[str, Dict[str, Any]], 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[str] = None, run_id: Optional[UUID] = None, config: Optional[RunnableConfig] = None, tool_call_id: Optional[str] = None, **kwargs: Any) → Any¶

运行工具。

参数

tool_input（《联合《str”、“Dict”（str，“Any”）>） – 工具的输入。
verbose (可选[bool]) – 是否记录工具的进度。默认值为None。
start_color (可选[str]) – 启动工具时使用的颜色。默认值为‘green’。
color (可选[str]) – 结束工具时使用的颜色。默认值为‘green’。
callbacks (可选[联合[List[BaseCallbackHandler], BaseCallbackManager]]) – 执行工具时调用的回调。默认值为None。
tags (可选[List[str]]) – 与工具相关联的可选标签列表。默认值为None。
metadata (可选[Dict[str, 任意]]) – 与工具相关联的可选元数据。默认值为None。
run_name (可选[str]) – 运行的名称。默认为 None。
run_id (可选[UUID]) – 运行的 ID。默认为 None。
config (可选[RunnableConfig]) – 工具的配置。默认为 None。
tool_call_id (可选[str]) – 工具调用的 ID。默认为 None。
kwargs (任何) – 传递给工具的额外参数

返回

工具的输出。

抛出

ToolException – 如果工具执行期间发生错误。

返回类型

任意

stream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) → Iterator[Output]¶

stream 的默认实现，调用 invoke。子类如果支持流输出的话应该重写此方法。

参数

input (Input) – Runnable 的输入。
config (可选[RunnableConfig]) – 用于 Runnable 的配置。默认为 None。
kwargs (可选[任何]) – 要传递给Runnable的额外关键字参数。

产出

Runnable 的输出。

返回类型

Iterator[Output]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将 Runnable 序列为 JSON。

返回: Runnable 的 JSON-序列化表示。
返回类型: Union[SerializedConstructor, SerializedNotImplemented]

property args: dict¶

property is_single_input: bool¶: 工具是否只接受单个输入。

属性 tool_call_schema: 类型[BaseModel]¶

使用MoveFileTool的示例¶

如何将工具转换为OpenAI函数

langchain_community.tools.file_management.move.MoveFileTool¶

使用MoveFileTool的示例¶

`langchain_community.tools.file_management.move`.MoveFileTool¶