`langchain_community.tools.polygon.financials`.PolygonFinancials¶

注意

PolygonFinancials 实现了标准 Runnable Interface。🏃

Runnable Interface 在可运行对象上提供了额外的方法，例如 with_types，with_retry，assign，bind，get_graph 以及更多。

class langchain_community.tools.polygon.financials.PolygonFinancials[source]¶

Bases: BaseTool

从 Polygon 获取股票财务信息的工具

初始化工具。

param api_wrapper: PolygonAPIWrapper [Required]¶

param args_schema: Type[BaseModel] = <class 'langchain_community.tools.polygon.financials.Inputs'>¶

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

参数规范应该是：

pydantic.BaseModel 的子类。

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

param callback_manager: Optional[BaseCallbackManager] = None¶: 已弃用。请使用回调代替。

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

param description: str = "Polygon的股票财务API的包装器。该工具适用于从资产负债表、利润表和现金流量表中获取股票的基本面财务数据。输入应该是您想获取最新基本面财务数据的股票代码。"¶

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

您可以在描述中提供少量示例。

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 mode: str = 'get_financials'¶

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

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

如果为“content”，则工具的输出被解释为ToolMessage的内容。如果为“content_and_artifact”，则输出应为一个与ToolMessage的(content, artifact)对应的二元组。

param return_direct: bool = False¶

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

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

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 并行运行 runnvie。

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

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

参数

inputs (列表[输入]) –Runnable的输入列表。
config (可选[Union[RunnableConfig, 列表[RunnableConfig]]]) – 在调用Runnable时使用的配置。该配置支持像'tags'、'metadata'这类用于追踪的标准密钥，'max_concurrency'用于控制并行执行的任务量，以及其他密钥。请参阅RunnableConfig以获取更多详细信息。默认为None。
return_exceptions (bool) – 是否返回异常而不是引发它们。默认为False。
kwargs (可选[任何]) – 传递给Runnable的附加关键字参数。

返回

Runnable的输出列表。

返回类型

列表[输出]

async abatch_as_completed(inputs: 测序[输入], config: 可选[联合[RunnableConfig, 序列[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: 可选[任何]) → 异步迭代器[元组[int, 联合[输出, 异常]]]¶

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

参数

inputs (序列[输入]) –Runnable的输入列表。
config (可选[集合[RunnableConfig, Sequence[RunnableConfig]]]) – 在调用Runnable时使用的配置。配置支持标准键，如'tags'、'metadata'（用于跟踪目的）、'max_concurrency'（用于控制并行工作量的多少）等键。请参阅RunnableConfig以获取更多详细信息。默认值为None。默认值为None。
return_exceptions (bool) – 是否返回异常而不是引发它们。默认为False。
kwargs (可选[任何]) – 传递给Runnable的附加关键字参数。

生成

Runnable输入和输出的索引元组。

返回类型

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

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

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

默认实现允许即使Runnable没有实现invoke的原生异步版本，也可以使用异步代码。

如果子类可以异步运行，则应该重写此方法。

参数

input (Union[str, Dict, ToolCall]) –
config (可选[RunnableConfig]) –
kwargs (Any) –

返回类型

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¶

异步运行工具。

参数

tool_input (Union[str, Dict]) – 工具的输入。
verbose (可选[bool]) – 是否记录工具的进度。默认值为None。
start_color (可选[str]) – 开始工具时使用的颜色。默认值为'green'。
color (可选[str]) – 结束工具时使用的颜色。默认值为'green'。
callbacks (可选[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 在工具执行期间调用的回调。默认值为None。
标签 (可选：字符串列表]) – 与工具关联的可选标签列表。默认为 None。
元数据 (可选字符串，任意类型字典]) – 与工具关联的可选元数据。默认为 None。
运行名称 (可选字符串]) – 运行的名称。默认为 None。
运行 ID (可选UUID]) – 运行的 ID。默认为 None。
配置 (可选RunnableConfig]) – 工具的配置。默认为 None。
工具调用 ID (可选字符串]) – 工具调用的 ID。默认为 None。
kwargs (任意类型) – 传递给工具的额外参数

返回

工具的输出。

抛出

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

返回类型

Any

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

测试版

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

从 Runnable 创建 BaseTool。

as_tool将从 Runnable 实例化一个带有名称、描述和 args_schema 的 BaseTool。尽可能从 runnable.get_input_schema 推断模式。作为替代方案（例如，如果 Runnable 接收一个字典作为输入且特定的字典键未指定类型），可以通过 args_schema 直接指定模式。您还可以传递 arg_types 以仅指定所需的参数及其类型。

参数

args_schema (可选[类型[BaseModel]]) – 工具的模式。默认为 None。
name (可选[str]) – 工具的名称。默认为 None。
description (可选[str]) – 工具的描述。默认为 None。
arg_types (可选[Dict[str, 类型]]) – 参数名称到类型的字典。默认为 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 (输入) – 可执行的输入。
config (可选[RunnableConfig]) – 使用可执行的配置。默认为 None。
kwargs (可选[任何]) – 传递给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 处于测试版，未来可能会有所变化。

生成事件流。

用于创建对提供关于可执行进度实时信息的 StreamEvents 的迭代器，包括中间结果的 StreamEvents。

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

event: str - 事件名称具有以下格式：
格式：on_[runnable_type]_(start|stream|end)。
name: str - 生成事件的可执行名称。
run_id: str - 与给定的执行相关的随机生成的 ID。
引发事件的Runnable。作为父Runnable执行部分而调用的子Runnable被分配一个独一无二的ID。
parent_ids：列表[str] - 生成事件的父Runnable的ID。
根Runnable将有一个空列表。父ID的顺序是从根到直接父级。仅适用于API的v2版本。API的v1版本将返回空列表。
tags：Optional[List[str]] - 产生事件的Runnable的标签。
metadata：Optional[Dict[str, Any]] - 产生事件的Runnable的元数据。
data：Dict[str, Any]

下面是一个表格，说明各种链可能会抛出的一些事件。为简洁，省略了元数据字段。链定义在表格之后。

注意此参考表是针对模式V2版本的。

事件	名称	块	输入	输出
on_chat_model_start	[模型名称]		{“messages”：[[系统消息，人类消息]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content="hello")
on_chat_model_end	[模型名称]		{“messages”：[[系统消息，人类消息]]}	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		[文档(…)]	“hello world!, goodbye world!”
on_tool_start	一些工具		{“x”：1，"y"："2”}
on_tool_end	一些工具			{“x”：1，"y"："2”}
on_retriever_start	[检索器名称]		{“query”：“hello”}
on_retriever_end	[检索器名称]		{“query”：“hello”}	[Document(…), ..]
on_prompt_start	[模板名称]		{“问题”： “hello”}
on_prompt_end	[模板名称]		{“问题”： “hello”}	ChatPromptValue(messages: [SystemMessage, …])

除了标准事件，用户还可以调度自定义事件（见下面的示例）。

自定义事件将在API的v2版本中显示出来！

自定义事件的格式如下

属性	类型	描述
名称	str	用户定义的事件名称。
数据	Any	与事件关联的数据。这可以是任何东西，尽管我们建议使其可序列化为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)

一些工具:

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

参数

输入（Any） - Runnable的输入。
配置（Optional[RunnableConfig]） - 用于Runnable的配置。
版本（Literal['v1', 'v2']） - 要使用的模式版本，可以是v2或v1。用户应使用v2。v1用于向后兼容，将在0.4.0中弃用。默认值将不分配，直到API稳定。自定义事件仅在v2中显示。
包含名称（Optional[Sequence[str]]） - 仅包括具有匹配名称的runnables的事件。
包含类型（Optional[Sequence[str]]） - 仅包括具有匹配类型的runnables的事件。
包含标签（Optional[Sequence[str]]） - 仅包括具有匹配标签的runnables的事件。
排除名称（Optional[Sequence[str]]） - 排除具有匹配名称的runnables的事件。
排除类型（Optional[Sequence[str]]） - 排除具有匹配类型的runnables的事件。
exclude_tags (可选[序列[字符串]]) – 从具有匹配标签的可运行对象中排除事件。
kwargs (任意类型) – 将传递给Runnable的附加关键字参数。这些将通过astream_log传递，因为astream_events的实现建立在astream_log之上。

生成

一个异步流，包含StreamEvents。

抛出

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

返回类型

异步迭代器[联合[StandardStreamEvent, CustomStreamEvent]]

batch(inputs: Input[], config: Optional[Union[RunnableConfig, RunnableConfig[]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[任意类型]) → Output[]¶

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

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

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

参数

inputs (Input[]) –
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]¶

配置可在运行时设置的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实例的可调用字典。

返回

配置了替代方案的新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]¶

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

参数: **kwargs (Union[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: Union[str, Dict, ToolCall], config: Optional[RunnableConfig] = None, **kwargs: Any) → Any¶

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

参数

input (Union[str, Dict, ToolCall]) – Runnable的输入。
config (可选[RunnableConfig]) – 在调用可执行时使用的配置。该配置支持标准键，如用于跟踪的'tags'、'metadata'，用于控制并行工作量的'max_concurrency'和其他键。请参阅RunnableConfig以获取更多详细信息。
kwargs (Any) –

返回

可执行的结果。

返回类型

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]]) – 工具的输入。
verbose (可选[bool]) – 是否记录工具的进度。默认值为None。
start_color (可选[str]) – 开始工具时使用的颜色。默认值为'green'。
color (可选[str]) – 结束工具时使用的颜色。默认值为'green'。
callbacks (可选[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 在工具执行期间调用的回调。默认值为None。
标签 (可选：字符串列表]) – 与工具关联的可选标签列表。默认为 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]) → Iterator[Output]¶

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

参数

input (输入) – 可执行的输入。
config (可选[RunnableConfig]) – 使用可执行的配置。默认为 None。
kwargs (可选[任何]) – 传递给Runnable的附加关键字参数。

生成

可执行的结果。

返回类型

Output迭代器

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将可执行序列化为JSON。

返回: 可执行的JSON序列化表示。
返回类型: Union[SerializedConstructor, SerializedNotImplemented]

属性args：字典

属性is_single_input：布尔值: 工具是否只接受单个输入。

属性 tool_call_schema: Type[BaseModel]¶

使用 PolygonFinancials 的示例¶

Polygon 股票市场 API 工具

langchain_community.tools.polygon.financials.PolygonFinancials¶

使用 PolygonFinancials 的示例¶

`langchain_community.tools.polygon.financials`.PolygonFinancials¶