`langchain_community.llms.rwkv`.RWKV¶

注解

RWKV实现了标准的Runnable Interface。🏃

Runnable接口除了运行方法外，还有其他方法可用，例如：with_types、with_retry、assign、bind和get_graph等。

class langchain_community.llms.rwkv.RWKV[source]¶

继承自：LLM、BaseModel

RWKV语言模型。

使用时，您应安装rwkv Python包、预训练模型文件和模型配置信息。

示例

from langchain_community.llms import RWKV
model = RWKV(model="./models/rwkv-3b-fp16.bin", strategy="cpu fp32")

# Simplest invocation
response = model.invoke("Once upon a time, ")

参数 CHUNK_LEN : int = 256¶: 提示处理的批量大小。

参数 cache : Union[BaseCache, bool, None] = None¶

是否缓存响应。

如果设置为true，将使用全局缓存。
如果设置为false，将不使用缓存。
如果为None，如果设置了全局缓存，则使用全局缓存，否则不使用缓存。
如果是BaseCache的实例，将使用提供的缓存。

对于模型的流方法，当前不支持缓存。

参数 callback_manager: Optional[BaseCallbackManager] = None¶: [已弃用]

参数 callbacks: Callbacks = None¶: 要添加到运行跟踪的回调。

参数 custom_get_token_ids: Optional[Callable[[str], List[int]]] = None¶: 用于计数标记的可选编码器。

参数 max_tokens_per_generation: int = 256¶: 生成标记的最大数量。

参数 metadata: Optional[Dict[str, Any]] = None¶: 要添加到运行跟踪的元数据。

参数 model: str [必需]¶: 预训练RWKV模型文件的路径。

参数 penalty_alpha_frequency: float = 0.4¶: 正值根据文本中现有频率对新的标记进行惩罚，降低模型重复相同行文本的可能性。

参数 penalty_alpha_presence: float = 0.4¶: 正值根据新标记是否已在文本中出现进行惩罚，增加模型讨论新主题的可能性。

参数 rwkv_verbose: bool = True¶: 打印调试信息。

参数 strategy: str = 'cpu fp32'¶: 标记上下文窗口。

参数 tags: Optional[List[str]] = None¶: 添加到运行跟踪的标签。

参数 temperature: float = 1.0¶: 用于采样的温度值。

参数 tokens_path: str [必需]¶: RWKV标记文件路径。

参数 top_p: float = 0.5¶: 用于采样的top-p值。

参数 verbose: bool [可选]¶: 是否打印输出文本。

__call__(prompt: str, stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → str¶

自 langchain-core==0.1.7 版本开始弃用：请使用 invoke 代替。

检查缓存并运行 LLM 在给定的提示和输入上。

参数

prompt (str) – 用于生成的提示。
stop (可选：str 列表) – 生成时使用的停用词。模型输在首次出现这些子串时截断。
callbacks (可选：Union[[BaseCallbackHandler 列表], BaseCallbackManager]) – 要传递的回调。用于在整个生成过程中执行其他功能，如日志记录或流式传输。
tags (可选：str 列表) – 与提示关联的标签列表。
元数据 (可选[字典]） - 与提示相关联的元数据。
**kwargs (任何类型) - 任意额外的关键字参数。这些通常传递给模型提供者API调用。

返回

生成的文本。

引发

ValueError - 如果提示不是字符串。

返回类型

str

async abatch(inputs: 列表[联合[PromptValue, str, 序列[联合[BaseMessage, 列表[str], 元组[str, str], str, 字典[str, 任何]]]]], config: 可选[联合[RunnableConfig, 列表[RunnableConfig]] = None, *, return_exceptions: bool = False, **kwargs: 任何) → 列表[str]¶

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

默认批处理实现对于IO密集型可运行程序表现良好。

子类应覆盖此方法以实现更有效的批量处理；例如，如果底层可运行程序使用支持批量模式的API。

参数

输入 (列表：联合：PromptValue、str、列表：联合：BaseMessage、列表：str、元组：str、str、字典：str：Any]) – Runnable函数的输入参数列表。
config (可选：联合：RunnableConfig、列表：RunnableConfig]) – 调用Runnable时使用的配置。该配置支持标准键，如’tags’、‘metadata’用于跟踪目的，‘max_concurrency’用于控制并行执行的工作量，和其他键。请参阅RunnableConfig获取更多详细信息。默认为None。
return_exceptions (布尔值) – 是否返回异常而不是引发异常。默认为False。
kwargs (Any) – 传递给Runnable的额外关键字参数。

返回

Runnable的输出列表。

返回类型

列表[str]

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

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

参数

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 agenerate(prompts: List[str], stop: Optional[List[str]] = None, callbacks: Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]]] = None, *, tags: Optional[Union[List[str], List[List[str]]]] = None, metadata: Optional[Union[Dict[str, Any], List[Dict[str, Any]]]] = None, run_name: Optional[Union[str, List[str]]] = None, run_id: Optional[Union[UUID, List[Optional[UUID]]]] = None, **kwargs: Any) → LLMResult¶

async agenerate_prompt(prompts: List[PromptValue], stop: Optional[List[str]] = None, callbacks: Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]] = None, **kwargs: Any) → LLMResult¶

异步传递一系列提示并返回模型生成结果。

对于公开批量API的模型，此方法应利用批处理调用。

当您想

利用批处理调用时，
需要模型比仅顶部生成值更多的输出时，
正在构建不依赖于底层语言模型类型（例如，纯文本完成模型与聊天模型）的无感知链。
类型。

参数

prompts （列表[[PromptValue]]） – PromptValue对象的列表。PromptValue是一个可以转换以匹配任何语言模型格式的对象（纯文本生成模型是字符串，聊天模型是BaseMessages）。
stop (可选：str 列表) – 生成时使用的停用词。模型输在首次出现这些子串时截断。
callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[Optional[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。用于在整个生成过程中执行附加功能，例如记录或流式传输。
**kwargs (任何类型) - 任意额外的关键字参数。这些通常传递给模型提供者API调用。

返回

一个包含每个输入提示的候选生成列表以及附加的模型提供商特定输出的LLMResult。

返回类型

LLMResult

async ainvoke(input: Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]], config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) → str¶

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

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

子类应覆盖此方法，如果它们可以异步运行。

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) –
config (Optional[RunnableConfig]) –
stop (Optional[List[str]]) –
kwargs (Any) –

返回类型

str

async apredict(text: str, *, stop: Optional[Sequence[str]] = None, **kwargs: Any) → str¶

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

参数

text (str) –
stop (Optional[Sequence[str]]) –
kwargs (Any) –

返回类型

str

async apredict_messages(messages: List[BaseMessage], *, stop: Optional[Sequence[str]] = None, **kwargs: Any) → BaseMessage¶

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

参数

messages (List[BaseMessage]) –
stop (Optional[Sequence[str]]) –
kwargs (Any) –

返回类型

BaseMessage

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 从一个可执行对象实例化一个 BaseTool，其中包含名称、描述和 args_schema。在可能的情况下，schema 会从 runnable.get_input_schema 推断。另外（例如，如果可执行对象以字典作为输入且特定字典键未指定类型），可以通过 args_schema 直接指定 schema。您还可以传递 arg_types 仅指定所需的参数及其类型。

参数

args_schema (可选[Type[BaseModel]]) – 工具的 schema。默认为 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 指定 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: Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], *, stop: Optional[List[str]] = None, **kwargs: Any) → AsyncIterator[str]¶

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

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – Runnable的输入。
config (Optional[RunnableConfig]) – 使用Runnable的配置。默认为None。
kwargs (Any) – 传递给Runnable的额外关键字参数。
stop (Optional[List[str]]) –

产生

Runnable的输出。

返回类型

AsyncIterator[str]

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进度的实时信息，包括中间结果的事件。

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

event: str - 事件名称的格式为
on_[runnable_type]_(start|stream|end)。
name: str - 产生事件的 Runnable 的名称。
run_id: str - 与指定执行关联的随机生成的 ID。
该 Runnable 匹配到的子 Runnable 在执行父 Runnable 时会被分配其唯一的 ID。
parent_ids: List[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		[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	事件的用户定义名称。
数据	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']) – 要使用的模式方案的版本，either 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 (可选[字符串序列]) – 从具有匹配类型的可运行命令中排除事件。
exclude_tags (可选[字符串序列]) – 从带有匹配标签的可运行命令中排除事件。
kwargs (任何类型) – 传递给可运行命令的额外关键字参数。这些参数将被传递给astream_log，因为astream_events的实现是基于astream_log。

产生

异步StreamEvents流。

引发

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

返回类型

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

batch(inputs: 列表[联合[PromptValue, str, 序列[联合[BaseMessage, 列表(str), 元组(str, str), 字典(str, Any)]]]], config: 可选[联合[RunnableConfig, 配置文件列表(RunnableConfig)]] = None, *, **kwargs: 任何类型) → str列表

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

默认批处理实现对于IO密集型可运行程序表现良好。

子类应覆盖此方法以实现更有效的批量处理；例如，如果底层可运行程序使用支持批量模式的API。

参数

输入 (列表[联合[PromptValue，str，序列[联合[BaseMessage，列表[str]，元组[str，str]，str，字典[str，任意]]]]]]) –
config (可选[联合[RunnableConfig，列表[RunnableConfig]]]) –
return_exceptions (bool) –
kwargs (Any) –

返回类型

列表[str]

batch_as_completed(inputs: 序列[Input], config: 可选[联合[RunnableConfig，序列[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: 可选[任意]) → 迭代器[元组[int，联合[Output，Exception]]]¶

对一系列输入并行运行调用，按完成顺序生成结果。

参数

inputs (Sequence[Input]) –
config (可选[Union[RunnableConfig，Sequence[RunnableConfig]]]) –
return_exceptions (bool) –
kwargs (可选[任意]) –

返回类型

迭代器[元组[int, 联合[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]¶

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

参数: **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
)

generate(prompts: List[str], stop: Optional[List[str]] = None, callbacks: Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]]] = None, *, tags: Optional[Union[List[str], List[List[str]]]] = None, metadata: Optional[Union[Dict[str, Any], List[Dict[str, Any]]]] = None, run_name: Optional[Union[str, List[str]]] = None, run_id: Optional[Union[UUID, List[Optional[UUID]]]] = None, **kwargs: Any) → LLMResult¶

将一系列提示传递给模型并返回生成的内容。

对于公开批量API的模型，此方法应利用批处理调用。

当您想

利用批处理调用时，
需要模型比仅顶部生成值更多的输出时，
正在构建不依赖于底层语言模型类型（例如，纯文本完成模型与聊天模型）的无感知链。
类型。

参数

prompts (列表[str]) – 字符串提示列表。
stop (可选：str 列表) – 生成时使用的停用词。模型输在首次出现这些子串时截断。
callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[Optional[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。用于在整个生成过程中执行附加功能，例如记录或流式传输。
tags (可选[Union[列表[str], 列表[列表[str]]]]) – 与每个提示关联的标签列表。如果提供，则列表长度必须与提示列表长度匹配。
metadata (可选[Union[Dict[str, Any], 列表[Dict[str, Any]]]]) – 与每个提示关联的元数据字典列表。如果提供，则列表长度必须与提示列表长度匹配。
run_name (可选[Union[str, 列表[str]]]) – 与每个提示关联的运行名称列表。如果提供，则列表长度必须与提示列表长度匹配。
run_id (可选[Union[UUID, 列表[Optional[UUID]]]]) – 与每个提示关联的运行ID列表。如果提供，则列表长度必须与提示列表长度匹配。
**kwargs (任何类型) - 任意额外的关键字参数。这些通常传递给模型提供者API调用。

返回

一个包含每个输入提示的候选生成列表以及附加的模型提供商特定输出的LLMResult。

返回类型

LLMResult

generate_prompt(prompts: List[PromptValue], stop: Optional[List[str]] = None, callbacks: Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]] = None, **kwargs: Any) → LLMResult

将一系列提示传递给模型并返回模型生成的内容。

对于公开批量API的模型，此方法应利用批处理调用。

当您想

利用批处理调用时，
需要模型比仅顶部生成值更多的输出时，
正在构建不依赖于底层语言模型类型（例如，纯文本完成模型与聊天模型）的无感知链。
类型。

参数

prompts （列表[[PromptValue]]） – PromptValue对象的列表。PromptValue是一个可以转换以匹配任何语言模型格式的对象（纯文本生成模型是字符串，聊天模型是BaseMessages）。
stop (可选：str 列表) – 生成时使用的停用词。模型输在首次出现这些子串时截断。
callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[Optional[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。用于在整个生成过程中执行附加功能，例如记录或流式传输。
**kwargs (任何类型) - 任意额外的关键字参数。这些通常传递给模型提供者API调用。

返回

一个包含每个输入提示的候选生成列表以及附加的模型提供商特定输出的LLMResult。

返回类型

LLMResult

get_num_tokens(text: str) → int

获取文本中的令牌数量。

用于检查输入是否适合模型的环境窗口。

参数: text (str) – 要分词的字符串输入。
返回: 文本中的令牌整数数量。
返回类型: 整数

get_num_tokens_from_messages(messages: List[BaseMessage]) → int

获取消息中的令牌数量。

用于检查输入是否适合模型的环境窗口。

参数: messages (列表[BaseMessage]) – 待分词的消息输入。
返回: 所有消息中令牌数量的总和。
返回类型: 整数

get_token_ids(text: str) → List[int]¶

返回文本中令牌的有序ID。

参数

text (str) – 要分词的字符串输入。

返回

文本中对应令牌的ID列表，按其在文本中出现的顺序。: 排序。

返回类型

整数列表

invoke(input: Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) → str¶

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

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – Runnable的输入。
config (可选[RunnableConfig]) – 在调用Runnable时使用的配置。此配置支持标准键，如用于跟踪的‘tags’，‘metadata’，用于控制并行工作量的‘max_concurrency’，以及其他键。请参阅RunnableConfig以获取更多详细信息。
stop (Optional[List[str]]) –
kwargs (Any) –

返回

Runnable的输出。

返回类型

str

predict(text: str, *, stop: Optional[Sequence[str]] = None, **kwargs: Any) → str¶

自 langchain-core==0.1.7 版本开始弃用：请使用 invoke 代替。

参数

text (str) –
stop (Optional[Sequence[str]]) –
kwargs (Any) –

返回类型

str

predict_messages(messages: List[BaseMessage], *, stop: Optional[Sequence[str]] = None, **kwargs: Any) → BaseMessage¶

自 langchain-core==0.1.7 版本开始弃用：请使用 invoke 代替。

参数

messages (List[BaseMessage]) –
stop (Optional[Sequence[str]]) –
kwargs (Any) –

返回类型

BaseMessage

run_rnn(_tokens: List[str], newline_adj: int = 0) → Any[source]¶

参数

_tokens (列表[字符串]) –
newline_adj (整数) –

返回类型

Any

rwkv_generate(prompt: str) → str[源码]¶

参数: prompt (str) –
返回类型: str

save(file_path: Union[Path, str]) → None¶

保存 LLM。

参数: file_path (Union[Path, str]) – 要保存 LLM 的文件路径。
引发: ValueError – 如果文件路径不是字符串或 Path 对象。
返回类型: None

示例：.. code-block:: python

llm.save(file_path="path/llm.yaml")

stream(input: Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) → Iterator[str]¶

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

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – Runnable的输入。
config (Optional[RunnableConfig]) – 使用Runnable的配置。默认为None。
kwargs (Any) – 传递给Runnable的额外关键字参数。
stop (Optional[List[str]]) –

产生

Runnable的输出。

返回类型

Iterator[str]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将Runnable序列化为JSON。

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

with_structured_output(schema: Union[Dict, Type[BaseModel]], **kwargs: Any) → Runnable[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], Union[Dict, BaseModel]]]¶

此类中未实现。

参数

schema (Union[Dict, Type[BaseModel]]) –
kwargs (Any) –

返回类型

Runnable[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], Union[Dict, BaseModel]]

使用 RWKV 的示例¶

RWKV-4

langchain_community.llms.rwkv.RWKV¶

使用 RWKV 的示例¶

`langchain_community.llms.rwkv`.RWKV¶