langchain_experimental.tools.python.tool.PythonREPLTool

注意

PythonREPLTool 实现了标准 Runnable 接口。🏃

Runnable 接口 在可运行对象上提供额外的方法，例如 with_types、with_retry、assign、bind、get_graph 等。

class langchain_experimental.tools.python.tool.PythonREPLTool

基类：BaseTool

在 REPL 中运行 Python 代码的工具。

初始化工具。

param args_schema: Optional[TypeBaseModel] = None

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

参数模式应如下所述：

• A subclass of pydantic.BaseModel。

or - A subclass of pydantic.v1.BaseModel if accessing v1 namespace in pydantic 2

param callback_manager: Optional[BaseCallbackManager] = None

已弃用。请使用回调代替。

param callbacks: Callbacks = None

在工具执行期间调用的回调函数。

参数 描述: str = '一个Python外壳。使用这个来执行python命令。输入应该是一个有效的python命令。如果你想查看一个值的输出，你应该使用`print(...)`来打印出来。'

用于告诉模型何时以及如何使用此工具。

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

参数 handle_tool_error: 可选[Union[bool, str, Callable[[ToolException], str]]] = False

处理抛出的ToolException的内容。

参数 handle_validation_error: 可选[Union[bool, str, Callable[[ValidationError], str]]] = False

处理抛出的ValidationError的内容。

参数 metadata: 可选[Dict[str, Any]] = None

与该工具相关的可选元数据。默认为空。这些元数据将与每个对该工具的调用相关联，并作为参数传递给定义在 callbacks 中的处理程序。您可以使用这些数据来例如识别特定工具的特定实例及其使用场景。

param python_repl: PythonREPL [可选]

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

工具的响应格式。默认为 'content'。

如果为“content”，则工具的输出被视为 ToolMessage 的内容。如果为“content_and_artifact”，则期望输出是一个与 ToolMessage 的 (内容，工件) 对应的二元组。

param return_direct: bool = False

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

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

param sanitize_input: bool = True

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[[BaseCallbackHandler], BaseCallbackManager]]) –

返回类型

str

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

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

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

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

参数

• inputs (List[Input]) – Runnable的输入列表。

• config (Optional[Union[RunnableConfig, List[RunnableConfig]]]) – 在调用Runnable时使用的配置。配置支持标准键如‘tags’，‘metadata’用于跟踪目的，‘max_concurrency’用于控制并行执行的工作量，以及其他键。请参阅RunnableConfig以获取更多详细信息。默认为None。

• return_exceptions (bool) – 是否返回异常而不是抛出它们。默认为False。

• kwargs (Optional[Any]) – 传递给Runnable的附加关键字参数。

返回

Runnable的输出列表。

返回类型

List[Output]

asyncabatch_as_completed(inputs:Sequence[Input]]=None*,config:Optional[Union[RunnableConfig,Sequence[RunnableConfig]]]=None**,kwargs:Optional[Any]) → AsyncIterator[Tuple[int,Union[Output,Exception]]]]¶

并行在输入列表上运行invokes，按完成顺序产生结果。

参数

• inputs (Sequence[Input]) – Runnable的输入列表。

• return_exceptions (bool) – 是否返回异常而不是抛出它们。默认为False。

• kwargs (Optional[Any]) – 传递给Runnable的附加关键字参数。

返回类型

参数

返回类型

Any

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

参数

• 标签 (可选[列表[字符串]]) – 可选与工具关联的标签列表。默认为None。

• 元数据 (可选[字典[字符串，任何数据类型]]) – 与工具关联的可选元数据。默认为None。

• 运行名称 (可选[字符串]) – 运行的名称。默认为None。

• 运行ID (可选[UUID]) – 运行的ID。默认为None。

• 配置 (可选[RunnableConfig]) – 工具的配置。默认为None。

• 工具调用ID (可选[字符串]) – 工具调用的ID。默认为None。

• kwargs (任何) – 传递给工具的额外参数

返回

工具的输出。

引发异常

ToolException – 如果工具执行过程中发生错误。

返回类型

Any

as_tool(args_schema: Optional[Type[BaseModel]] = None, *, name: Optional[str] = None, description: Optional[str] = None, arg_types: Optional[字典[字符串，类型]] = None) → BaseTool

测试版

此API处于测试版，可能会在未来更改。

从Runnable创建BaseTool。

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

参数

• args_schema (可选) – 工具的模式。默认为None。

• name (可选) – 工具的名称。默认为None。

• description (可选) – 工具的描述。默认为None。

• arg_types (可选) – 参数名称到类型的字典。默认为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起引入。

asyncastream(input: Input, config: Optional[RunnableConfig], **kwargs: Optional[Any]) → AsyncIterator[Output]

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

参数

• input (输入) – Runnable的输入。

• config (可选) – 用于Runnable的配置。默认为None。

• kwargs (Optional[Any]) – 传递给Runnable的附加关键字参数。

Runnable的输出。

返回类型

AsyncIterator[输出]

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处于测试版，可能会在未来更改。

生成一系列事件。

用于创建用于提供关于Runnable进度的实时信息（包括中间结果的事件）的StreamEvents迭代器。

StreamEvent是一个具有以下模式的字典

• event: 字符串 - 事件名称的格式为

  on_[runnable_type]_(start|stream|end)。

• name: 字符串 - 生成事件的Runnable的名称。

• run_id： 字符串 - 与给定可执行任务关联的随机生成ID。

  触发事件的运行任务的子运行任务将被分配其独有的ID。

• parent_ids： 字符串列表 - 生成事件的父运行任务的ID列表。根运行任务将有一个空列表。父ID的顺序是从根到直接父级。仅适用于API的v2版本。API的v1版本将返回空列表。

  tags： 可选字符串列表 - 生成事件的运行任务的标记。

• metadata： 可选字典（str，任何类型） - 生成事件的运行任务的元数据。

  data： 字典（str，任何类型） -

• 以下是一个表格，说明了各种链条可能发出的某些事件。为了简洁起见，省略了元数据字段。表格之后包括链定义。

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

• 事件

名称

块

输入	输出	on_chat_model_start	【模型名称】	{“消息”：[[SystemMessage，HumanMessage]]}
on_chat_model_stream	AIMessageChunk(content="hello")		on_chat_model_end
AIMessageChunk(content="hello world")	AIMessageChunk(content="hello")	on_llm_start
{‘input’：‘hello’}	AIMessageChunk(content="hello")		on_chat_model_end	on_llm_stream
‘Hello’	AIMessageChunk(content="hello")		on_llm_end
‘Hello human!’	AIMessageChunk(content="hello")	on_chain_start
format_docs	AIMessageChunk(content="hello")		on_chain_stream
“hello world!， goodbye world!”	on_chain_end
[Document(…)]	on_chain_end	on_tool_start
some_tool	on_chain_end		{“x”：1，“y”： “2”}	on_tool_start
on_tool_end	on_retriever_start		[检索器名称]
{“查询”： “hello”}	on_retriever_start			[检索器名称]
on_retriever_end	[Document(…)， ..]		on_prompt_start
[模板名称]	[Document(…)， ..]		on_prompt_start	{“问题”： “hello”}
on_prompt_end	ChatPromptValue(messages: [SystemMessage， …])		除了标准事件外，用户还可以调度自定义事件（见下例）。
注意 自定义事件仅在API的v2版本中展现！	ChatPromptValue(messages: [SystemMessage， …])		除了标准事件外，用户还可以调度自定义事件（见下例）。	自定义事件具有以下格式

属性

类型

描述

事件的用户定义名称。	data	与事件关联的数据。这可以是任何东西，尽管我们建议使其可JSON序列化。
输出	str	以下是与上述标准事件相关的声明
prompt	Any	示例

示例：调度自定义事件

on_chain_end:

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

format_docs = RunnableLambda(format_docs)

on_retriever_start:

@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)

参数

• config

• 可选[RunnableConfig]

• 使用运行任务的配置。

• 版本

• 文字['v1'，'v2']

• 要使用的方案版本，要么是v2，要么是v1。用户应使用v2。v1是向后兼容的，将在0.4.0中弃用。直到API稳定之前，不会分配默认值。自定义事件仅在v2中展现。

• 只包含与匹配名称的运行任务的事件。

• 只包含与匹配类型相匹配的运行任务的事件。

• exclude_tags (可选]序列[str]]) – 从带有匹配标签的可运行中排除事件。

• kwargs (任何值) – 用于传递给Runnable的额外关键字参数。这些参数将传递给astream_log，因为astream_events的此实现是基于astream_log构建的。

异步流中的StreamEvents。

引发异常

NotImplementedError – 如果版本不是$cite{v1}$或$cite{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 (列表[Input]) –

• config (可选]Union[RunnableConfig, 列表[RunnableConfig]]]) –

• return_exceptions (布尔值) –

• kwargs (可选]任何值]) –

返回类型

List[Output]

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]

配置运行时可以设置的Runnables替代方案。

参数

• which (ConfigurableField) – 用于选择替代方案的ConfigurableField实例。

• default_key (str) – 如果未选择替代方案，将使用默认键。默认为“default”。

• prefix_keys (bool) – 是否在键前加上ConfigurableField ID。默认为False。

• **kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到Runnable实例或返回Runnable实例的Callable的字典。

返回

配置了替代方案的新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: TypeUnion[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) → RunnableSerializable[Input, Output]

在运行时配置特定的Runnable字段。

参数

**kwargs (TypeUnion[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) – 配置的ConfigurableField实例的字典。

返回

带有配置字段的新的Runnable。

返回类型

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
)

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

将单个输入转换为输出。覆盖以实现。

参数

• input (TypeUnion[str, Dict, ToolCall]) –Runnable的输入。

• config (可选;RunnableConfig]) – 召唤时可使用的配置。配置支持像 'tags'、'metadata' 这样的标准键，用于追踪目的，'max_concurrency' 用于控制并行的工作量，以及其他键。请参阅 RunnableConfig 获取更多信息。

返回

Runnable的输出。

返回类型

Any

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]]) – 工具的输入。

• 标签 (可选[列表[字符串]]) – 可选与工具关联的标签列表。默认为None。

• 元数据 (可选[字典[字符串，任何数据类型]]) – 与工具关联的可选元数据。默认为None。

• 运行名称 (可选[字符串]) – 运行的名称。默认为None。

• 运行ID (可选[UUID]) – 运行的ID。默认为None。

• 配置 (可选[RunnableConfig]) – 工具的配置。默认为None。

• 工具调用ID (可选[字符串]) – 工具调用的ID。默认为None。

• kwargs (任何) – 传递给工具的额外参数

返回

工具的输出。

引发异常

ToolException – 如果工具执行过程中发生错误。

返回类型

Any

stream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) → 迭代器[输出]

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

参数

• input (输入) – Runnable的输入。

• config (可选) – 用于Runnable的配置。默认为None。

• kwargs (Optional[Any]) – 传递给Runnable的附加关键字参数。

Runnable的输出。

返回类型

迭代器[输出]

to_json() → 联合[SerializedConstructor, SerializedNotImplemented]

将 Runnable 序列化为 JSON。

返回

Runnable 的可 JSON 序列化表示。

返回类型

联合[SerializedConstructor, SerializedNotImplemented]

属性args：dict

属性is_single_input：bool

工具是否只接受单个输入。

属性 tool_call_schema: 类型[BaseModel]

使用PythonREPLTool的示例

• Python