`langchain_community.retrievers.breebs`.BreebsRetriever¶

注意

BreebsRetriever 实现了标准 Runnable 接口. 🏃

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

classlangchain_community.retrievers.breebs.BreebsRetriever[source]¶

基类: BaseRetriever

用于 Breebs 的检索类。

更多请参阅 https://www.breebs.com/。 :param breeb_key: 触发 breeb 的密钥（特定主题的专项知识药丸） :param (specialized knowledge pill on a specific topic).

要获取所有可用的 breeb 列表：你可以调用 https://breebs.promptbreeders.com/web/listbreebs

parambreeb_key: str [Required]¶

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

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

参数 url: str = 'https://breebs.promptbreeders.com/knowledge'¶

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

默认实现通过 asyncio.gather 并行运行 run。

默认批处理实现对 I/O 密集型可运行程序效果良好。

如果子类可以更高效地进行批处理，应重写此方法；例如，如果底层的 Runnable 使用支持批处理模式的 API。

参数：

inputs (列表[Input]) – 要传递给可运行程序输入的列表。
config (可选[联合.DataGridViewColumn[RunnableConfig, List[RunnableConfig]]]) – 当调用Runnable时使用的配置。配置支持用于追踪的标准键，如‘tags’、‘metadata’，还有其他键，如‘max_concurrency’用于控制并行处理的工作量。请参阅RunnableConfig获取更多详情。默认为None。
return_exceptions (布尔值) – 是否返回异常而不是抛出异常。默认为False。
kwargs (可选[Any]) – 传递给Runnable的额外关键字参数。

返回

Runnable的输出列表。

返回类型

list[输出]

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 (可选[联合[RunnableConfig, Sequence[RunnableConfig]]]) – 调用Runnable时使用的配置。此配置支持标准键，如‘tags’，‘metadata’用于跟踪目的，‘max_concurrency’用于控制并行工作多少，以及其他键。请参阅RunnableConfig以获取更多详细信息。默认为None。默认为None。
return_exceptions (布尔值) – 是否返回异常而不是抛出异常。默认为False。
kwargs (可选[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 (可选[List[str]]) – 与检索器关联的可选标签列表。这些标签将与每次调用此检索器相关联，并作为参数传递给在callbacks中定义的处理程序。默认为None。
元数据 (可选]字典[str,Any]]) - 与检索器相关联的可选元数据。这些元数据将与对该检索器的每次调用相关联，并作为参数传递给在 callbacks 中定义的处理程序。默认值为 None。
运行名称 (可选]str]) - 运行的可选名称。默认值为 None。
kwargs (Any) - 要传递给检索器的其他参数。

返回

相关文档列表。

返回类型

List[Document]

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

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

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

参数：

input (str) – 查询字符串。
config (可选]RunnableConfig]) – 检索器的配置。默认值为 None。
kwargs (Any) - 要传递给检索器的其他参数。

返回

相关文档列表。

返回类型

List[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]] = 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指定schema。

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 (Optional[RunnableConfig]) – 为Runnable使用配置。默认为None。
kwargs (可选[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处于测试版本，未来可能有所改变。

生成一系列事件。

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

StreamEvent是一个具有以下schema的字典

event: str - 事件名称的格式为: on_[runnable_type]_(start|stream|end)。
name: str - 生成事件的Runnable的名称。
run_id: str - 与Runnable的执行相关的随机生成的ID。在Runnable执行过程中被调用的子Runnable将分配其唯一的ID。
parent_ids: List[str] - 生成事件的父Runnable的ID列表。根Runnable将是一个空列表。parent ID的顺序是从根到直接父级。仅适用于API v2版本。API v1版本的返回将是空列表。
tags: Optional[List[str]] - 生成事件的Runnable的标签。
metadata: Optional[Dict[str, Any]] - 生成事件的Runnable的元数据。
data: Dict[str, Any]
以下是可能由各种链发射的一些事件的示例表。出于简洁起见，省略了元数据字段。在整个表之后包括了链定义。
注意此参考表是针对schema的V2版本。
event
name
chunk

input

output

on_chat_model_start	名称	块	输入	输出
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	[模型名]		‘你好人类！’
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	用户定义的事件名称。
data	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)

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']) – 要使用的schema版本，可以是v2或v1。用户应使用v2。 v1用于向后兼容，将在0.4.0版本中弃用。直到API稳定，不会分配默认值。自定义事件只会出现在v2中。
include_names (Optional[Sequence[str]]) – 仅包括具有匹配名称的runnable的事件。
include_types (Optional[Sequence[str]]) – 仅包括具有匹配类型的runnable的事件。
include_tags (Optional[Sequence[str]]) – 仅包括具有匹配标签的runnable的事件。
exclude_names (Optional[Sequence[str]]) – 从具有匹配名称的runnable中排除事件。
exclude_types (Optional[Sequence[str]]) – 从具有匹配类型的runnable中排除事件。
exclude_tags (Optional[Sequence[str]]) – 从具有匹配标签的runnable中排除事件。
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]¶

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

默认批处理实现对 I/O 密集型可运行程序效果良好。

如果子类可以更高效地进行批处理，应重写此方法；例如，如果底层的 Runnable 使用支持批处理模式的 API。

参数：

inputs (列表[Input]) –
config (可选[Union[RunnableConfig, 列表[RunnableConfig]]]) –
return_exceptions (布尔) –
kwargs (可选[任何内容]) –

返回类型

list[输出]

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 (序列[输入]) –
config (可选[并集[可执行配置, 序列[可执行配置]]]) –
return_exceptions (布尔) –
kwargs (可选[任何内容]) –

返回类型

迭代器[元组[int, 并集[输出, 异常]]]

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]¶

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

参数：: **kwargs (Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) – 要配置的可配置字段实例的字典。
返回: 配置字段后的新可运行对象。
返回类型: 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 （回调）- 回调管理器或回调列表。默认为 None。
tags (可选[List[str]]) – 与检索器关联的可选标签列表。这些标签将与每次调用此检索器相关联，并作为参数传递给在callbacks中定义的处理程序。默认为None。
元数据 (可选]字典[str,Any]]) - 与检索器相关联的可选元数据。这些元数据将与对该检索器的每次调用相关联，并作为参数传递给在 callbacks 中定义的处理程序。默认值为 None。
运行名称 (可选]str]) - 运行的可选名称。默认值为 None。
kwargs (Any) - 要传递给检索器的其他参数。

返回

相关文档列表。

返回类型

List[Document]

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

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

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

参数：

input (str) – 查询字符串。
config (可选]RunnableConfig]) – 检索器的配置。默认值为 None。
kwargs (Any) - 要传递给检索器的其他参数。

返回

相关文档列表。

返回类型

List[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 (可选[Any]) – 传递给Runnable的额外关键字参数。

产生

Runnable的输出。

返回类型

Iterator[Output]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将可运行对象序列化成JSON。

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

BreebsRetriever的使用示例¶

BREEBS（开放知识）

langchain_community.retrievers.breebs.BreebsRetriever¶

BreebsRetriever的使用示例¶

`langchain_community.retrievers.breebs`.BreebsRetriever¶