`langchain_community.retrievers.asknews`.AskNewsRetriever¶

注意

AskNewsRetriever实现了标准的Runnable 接口。🏃

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

class langchain_community.retrievers.asknews.AskNewsRetriever[source]¶

基类: BaseRetriever

AskNews 检索器。

参数categories:List[Literal['All', 'Business', 'Crime', 'Politics', 'Science', 'Sports', 'Technology', 'Military', 'Health', 'Entertainment', 'Finance', 'Culture', 'Climate', 'Environment', 'World']] = ['All']¶

参数client_id:Optional[str] = None¶

参数client_secret:Optional[str] = None¶

参数end_timestamp:Optional[int] = None¶

参数historical :bool = False¶

参数k :int = 10¶

参数 kwargs: 可选[Dict[str, Any]] = {}¶

参数 metadata: 可选[Dict[str, Any]] = None¶: 与检索器相关联的可选元数据。默认为None。此元数据将与每次检索调用关联，并作为参数传递给在 callbacks 中定义的处理程序。您可以使用这些数据来例如识别具有特定用例的检索器实例。

参数 method: 字面量['nl', 'kw'] = 'nl'¶

参数 offset: int = 0¶

参数 similarity_score_threshold: float = 0.5¶

参数 start_timestamp: 可选[int] = None¶

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

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

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

默认的批量实现非常适合I/O密集型的runnables。

如果子类可以实现更有效的批量操作，应重写此方法；例如，如果底层的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]

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

对一系列输入并行运行ainvoke，在完成时输出结果。

参数

inputs (Sequence[Input]) – Runnable的输入列表。
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用Runnable时使用的配置。配置支持标准键，如’tags’、‘metadata’用于跟踪目的，‘max_concurrency’用于控制并行工作量的多少，以及其他键。请参阅RunnableConfig获取更多详细信息。默认为None。
return_exceptions (bool) – 是否返回异常而不是抛出它们。默认为False。
kwargs (Optional[Any]) – 传递给Runnable的额外关键字参数。

输出

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

返回类型

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

async aget_relevant_documents(query: str, *, callbacks: Callbacks = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, **kwargs: Any) → List[Document]¶

已废弃：自 langchain-core==0.1.46 版本起：使用 ainvoke 代替。

异步获取与查询相关的文档。

用户应优先使用 .ainvoke 或 .abatch，而不是直接使用 aget_relevant_documents。

参数

query (str) – 要查找相关文档的字符串。
callbacks (Callbacks) – 回调管理器或回调列表。
tags (Optional[List[str]]) – 与检索器相关联的可选标记列表。这些标记将与每次调用此检索器相关联，并作为参数传递给在 callbacks 中定义的处理程序。默认为 None。
metadata (Optional[Dict[str, Any]]) – 与检索器相关联的可选元数据。此元数据将与每次调用此检索器相关联，并作为参数传递给在 callbacks 中定义的处理程序。默认为 None。
run_name (Optional[str]) – 可选的运行名称。默认为 None。
kwargs (Any) – 传递给检索器的附加参数。

返回

相关文档列表。

返回类型

Document 列表

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

异步调用检索器以获取相关文档。

异步检索调用的主要入口点。

参数

输入 (str) – 查询字符串。
配置 (Optional[RunnableConfig]) – 检索器的配置。默认为 None。
kwargs (Any) – 传递给检索器的附加参数。

返回

相关文档列表。

返回类型

列表[Document]

示例

await retriever.ainvoke("query")

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

测试版

此 API 正在测试中，可能会在未来更改。

从可运行实体创建基础工具。

as_tool 会从 Runnable 实例化一个 BaseTool，并包含名称、描述和 args_schema。尽可能情况下，模式会从 runnable.get_input_schema 推断出。作为替代（例如，如果 Runnable 接受字典作为输入，并且特定的字典键没有类型），可以通过 args_schema 直接指定模式。您还可以传递 arg_types 仅指定必要的参数及其类型。

参数

args_schema (Optional[Type[BaseModel]]) – 工具的架构。默认为 None。
name (Optional[str]) – 工具的名称。默认为 None。
description (Optional[str]) – 工具的描述。默认为 None。
arg_types (Optional[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], **kwargs: Optional[Any]) → AsyncIterator[Output]¶

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

参数

input (Input) – Runnable 的输入。
config (Optional[RunnableConfig]) – 供 Runnable 使用的配置。默认为 None。
kwargs (Optional[Any]) – 传递给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 正在测试中，可能会在未来更改。

生成事件流。

用于创建一个迭代器，迭代提供 Runnable 进度实时信息的 StreamEvents，包括中间结果的 StreamEvents。

StreamEvent 是一个具有以下架构的字典

event: str - 事件名称采用以下格式：
格式：on_[runnable_type]_(start|stream|end)。
name: str - 生成事件的 Runnable 的名称。
run_id: str - 与给定执行随机生成的 ID 关联
触发事件的Runnable。作为父Runnable执行的一部分被调用的小孩Runnable会分配其唯一的ID。
parent_ids：《strong>》- 生成事件父Runnable的ID。根Runnable将有一个空列表。父ID的顺序是从根到直接父级。仅适用于API的第2版本。API第1版本将返回空列表。
tags：《strong>》- 生成事件的Runnable的标签。
metadata：《strong>》- 生成事件的Runnable的元数据。
data：《strong>》
以下是说明各种链可能发出的一些事件的表格。为了方便起见，省略了元数据字段。表格之后包含了链的定义。
注意此参考表适用于架构的第2版本。
事件

名称

块

输入	输出	on_chat_model_start	【模型名称】	(DialogueMessage([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		检索器名称
{“query”：“hello”}	on_retriever_start			检索器名称
on_retriever_end	[Document(…), ..]		on_prompt_start
模板名称	[Document(…), ..]		on_prompt_start	{“question”：“hello”}
on_prompt_end	ChatPromptValue(messages: [SystemMessage, …])		除了标准事件，用户还可以发出自定义事件（见下面的示例）。
自定义事件仅在第2版本的API中可见！	ChatPromptValue(messages: [SystemMessage, …])		除了标准事件，用户还可以发出自定义事件（见下面的示例）。	自定义事件具有以下格式

属性

类型

描述

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

示例：发出自定义事件

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"]})

Any

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": [],
    },
]

Runnable的输入。

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)

参数

配置
Optional[RunnableConfig]
使用Runnable的配置。
版本
Literal['v1', 'v2']
使用的架构版本，可以是《 инвестирует>('|v1'|, '|v2'|)。用户应使用《投资}|v2|。|v1|用于向后兼容性，并将自0.4.0版开始弃用。在API稳定之前不会分配任何默认值。自定义事件仅在第2版本中可见。
include_names
Optional[Sequence[str]]
仅包含具有匹配名称的runnables的事件。
kwargs (任意) – 传递给 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]

默认实现以并行的方式通过线程池执行器运行 invoke。

默认的批量实现非常适合I/O密集型的runnables。

如果子类可以实现更有效的批量操作，应重写此方法；例如，如果底层的Runnable使用支持批量模式的API。

参数

inputs (列表 –
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, *args, default_key: str = 'default', prefix_keys: bool = False, **kwargs) → RunnableSerializable[Input, Output]¶

配置可在运行时设置的运行可配置的替代品。

参数

which (ConfigurableField) – 将用于选择替代品的 ConfigurableField 实例。
default_key (str) – 如果未选择替代品则使用的默认键。默认为“default”。
prefix_keys (bool) – Whether to prefix the keys with the ConfigurableField id. Defaults to False.
**kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到运行实例或返回运行实例的可调用函数的字典。

返回

带配置替代品的新的运行可。

返回类型

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
)

get_relevant_documents(query: str, *, callbacks: Callbacks = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, **kwargs: Any) → List[Document]¶

已弃用自langchain-core==0.1.46版本：请使用 invoke 替代。

检索与查询相关的文档。

用户应优先使用 .invoke 或 .batch 而不是直接使用 get_relevant_documents。

参数

query (str) – 要查找相关文档的字符串。
callbacks (Callbacks) – 回调管理器或回调列表。默认为 None。
tags (Optional[List[str]]) – 与检索器相关联的可选标记列表。这些标记将与每次调用此检索器相关联，并作为参数传递给在 callbacks 中定义的处理程序。默认为 None。
metadata (Optional[Dict[str, Any]]) – 与检索器相关联的可选元数据。此元数据将与每次调用此检索器相关联，并作为参数传递给在 callbacks 中定义的处理程序。默认为 None。
run_name (Optional[str]) – 可选的运行名称。默认为 None。
kwargs (Any) – 传递给检索器的附加参数。

返回

相关文档列表。

返回类型

Document 列表

invoke(input: str, config: Optional[RunnableConfig] = None, **kwargs: Any) → List[Document]¶

调用检索器以获取相关文档。

同步检索器调用的主要入口点。

参数

输入 (str) – 查询字符串。
配置 (Optional[RunnableConfig]) – 检索器的配置。默认为 None。
kwargs (Any) – 传递给检索器的附加参数。

返回

相关文档列表。

返回类型

列表[Document]

示例

retriever.invoke("query")

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

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

参数

input (Input) – Runnable 的输入。
config (Optional[RunnableConfig]) – 供 Runnable 使用的配置。默认为 None。
kwargs (Optional[Any]) – 传递给Runnable的额外关键字参数。

输出

Runnable 的输出。

返回类型

Iterator[Output]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将Runnable序列化为JSON。

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

使用AskNewsRetriever的示例¶

AskNews

langchain_community.retrievers.asknews.AskNewsRetriever¶

使用AskNewsRetriever的示例¶

`langchain_community.retrievers.asknews`.AskNewsRetriever¶