`langchain_community.llms.gpt4all`.GPT4All¶

注意：

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

Runnable 接口 提供了额外的方法，如 with_types、with_retry、assign、bind、get_graph 等。

class langchain_community.llms.gpt4all.GPT4All[source]¶

基类： LLM

GPT4All 语言模型。

要使用，您需要安装 gpt4all Python 包、预训练模型文件和模型的配置信息。

示例

from langchain_community.llms import GPT4All
model = GPT4All(model="./models/gpt4all-model.bin", n_threads=8)

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

param allow_download: bool = False¶: 如果模型不存在于 ~/.cache/gpt4all/ 中，则下载它。

param backend: Optional[str] = None¶

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

是否缓存响应。

如果为真，将使用全局缓存。
如果为假，不会使用缓存。
如果为None，如果有设置全局缓存，将使用全局缓存，否则不使用缓存。
如果为BaseCache实例，将使用提供的缓存。

当前不支持模型的流式方法的缓存。

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

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

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

参数 device: 类型 Optional[str] = 'cpu'¶: 设备名称: cpu, gpu, nvidia, intel, amd 或 DeviceName。

参数 echo: 可选[布尔值] = False¶: 是否输出提示信息。

参数 embedding: 布尔值 = False¶: 仅使用嵌入模式。

参数 f16_kv: 布尔值 = False¶: 使用半精度存储键/值缓存。

参数 logits_all: 布尔值 = False¶: 返回所有标记的 logits，而不仅仅是最后一个标记。

参数 max_tokens: int = 200¶: 标记上下文窗口。

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

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

参数 n_batch: int = 8¶: 提示处理批量大小。

参数 n_parts: int = -1¶: 将模型分成部分的数量。如果为-1，则自动确定部分数量。

参数 n_predict: Optional[int] = 256¶: 可以生成的最大令牌数。

参数 n_threads: Optional[int] = 4¶: 要使用的线程数。

参数 repeat_last_n: Optional[int] = 64¶: 要惩罚的最后n个令牌。

参数 repeat_penalty: Optional[float] = 1.18¶: 对重复令牌应用的惩罚。

参数 seed: int = 0¶: 随机数生成种子。如果为-1，则使用随机种子。

参数 stop: Optional[List[str]] = []¶: 当遇到时停止生成的字符串列表。

参数 streaming: bool = False¶: 是否流输出结果。

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

参数：temp: Optional[float]] = 0.7¶: 用于采样的温度值。

参数：top_k: Optional[int]] = 40¶: 用于采样的top-k值。

参数：top_p: Optional[float]] = 0.1¶: 用于采样的top-p值。

参数：use_mlock: bool = False¶: 强制系统将模型保存在RAM中。

参数：verbose: bool [可选]¶: 是否打印响应文本。

参数：vocab_only: bool = False¶: 仅加载词汇表，不加载权重。

__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 (可选[List[str]]) – 生成时使用的停止词。模型输出在首次出现这些子串之一时将截断。
callbacks (可选[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 要传递的回调。用于在生成过程中执行附加功能，如记录或流输出。
tags (可选[List[str]]) – 与提示关联的标签列表。
metadata (可选[Dict[str, Any]]) – 与提示关联的元数据。
**kwargs (任意的) – 额外的关键字参数。这些通常传递给模型提供者的API调用。

返回

生成的文本。

异常

ValueError – 如果提示（prompt）不是一个字符串。

返回类型

str

asyncabatch(inputs:List[Union[PromptValue,str,Sequence[Union[BaseMessage,List[str],Tuple[str,str],str,Dict[str,Any]]]], str,Sequence[Union[BaseMessage,List[str],Tuple[str,str],str,Dict[str,Any]]]]]]config:Optional[Union[RunnableConfig,List[RunnableConfig]]] = None *return_exceptions:bool = False **kwargs :Any) → List[str]¶

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

默认批量实现适用于I/O密集型runnables。

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

参数

inputs (List[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]]) – 要运行的可运行对象的可运行对象输入列表。
config (可选[联合[RunnableConfig, List[RunnableConfig]]]) – 在调用Runnable时使用的配置。此配置支持标准键，如'tags'、'metadata'（用于跟踪目的）、'max_concurrency'（用于控制并行执行的工作量）和其他键。请参阅RunnableConfig以获取更多详细信息。默认为None。
return_exceptions (布尔型) – 是否返回异常而不是抛出它们。默认为False。
kwargs (任何) – 传递给Runnable的附加关键字参数。

返回

Runnable的输出列表。

返回类型

字符串列表

async abatch_as_completed(inputs: 输入序列[Input], config: Optional[Union[RunnableConfig, 序列[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[任何]) → AsyncIterator[元组[int, Union[Output, Exception]]]¶

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

参数

inputs (序列[Input]) – Runnable的输入列表。
config (可选[联合[RunnableConfig, Sequence[RunnableConfig]]]) – 在调用可执行对象时使用的配置。配置支持标准键，如用于跟踪的‘tags’，‘metadata’，用于控制并行工作的数量的‘max_concurrency’，以及其他键。请参阅RunnableConfig获取更多详细信息。默认为None。默认为None。
return_exceptions (布尔型) – 是否返回异常而不是抛出它们。默认为False。
kwargs (可选[任何类型]) – 要传递给可执行对象的额外关键字参数。

生成

一个包含输入和输出索引的元组，来自可执行对象。

返回类型

AsyncIterator[Tuple[int, 联合[输出, 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¶

异步将一系列提示传递给模型并返回生成的文本。

当您使用暴露批量API的模型时应使用此方法

当您想要

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

参数

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

返回

一个LLMResult，其中包含每个输入提示的候选生成列表以及额外的模型提供程序特定输出。: 。

返回类型

LLMResult

异步 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]) – 提示值的列表。提示值是一个可以转换为与任何语言模型（纯文本生成模型的字符串和聊天模型的BaseMessages）兼容格式的对象。
stop (可选[List[str]]) – 生成时使用的停止词。模型输出在首次出现这些子串之一时将截断。
callbacks (联合[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[可选[联合[列表[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 的原生异步版本，仍可以使用异步代码。

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

参数

输入 (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) –
配置 (Optional[RunnableConfig]) –
停止条件 (Optional[List[str]]) –
关键字参数 (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]]) –
关键字参数 (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]]) –
关键字参数 (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。在可能的范围内，模式将从runnable.get_input_schema推断。或者（例如，如果可运行对象接受字典作为输入且特定的字典键未进行类型指定），可以直接通过args_schema指定模式。您还可以传递arg_types来仅指定所需参数及其类型。

参数

args_schema (可选[类型[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指定方案

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]]]], config: Optional[RunnableConfig] = None, *, 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 (任何) – 传递给Runnable的附加关键字参数。
停止条件 (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_[可执行类型]_(开始|流|结束).
name：str - 生成事件的可执行体的名称。
run_id：str - 与给定执行关联的随机生成的ID。该ID与触发事件的可执行体相关联。作为父可执行体执行的一部分被调用的子可执行体将分配其唯一的ID。
。
parent_ids：列表[str] - 生成事件的父可执行体的ID。根可执行体将有一个空列表。父ID的顺序是从根到直接父级的。仅适用于API的v2版本。API的v1版本将返回空列表。
。
tags：可选[列表[str]] - 生成事件的可执行体的标签。
。
metadata：可选[Dict[str, Any]] - 生成事件的可执行体的元数据。
。
data：Dict[str, Any]

下表展示了可能由各种链发出的某些事件。为了简洁起见，已经省略了元数据字段。链定义在表之后。

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

事件	名称	块	输入	输出
on_chat_model_start	[模型名称]		{“messages”: [[SystemMessage, HumanMessage]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content=”hello”)
on_chat_model_end	[模型名称]		{“messages”: [[SystemMessage, HumanMessage]]}	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	事件的自定义名称。
data	任意的	与事件关联的数据。这可以是任何东西，但我们建议使其可序列化为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（任意的）- 可执行体的输入。
config（可选[RunnableConfig]）- 使用可执行体的配置。
version（文本['v1'，'v2']）- 要使用的模式版本的版本，可以是v2或v1。用户应使用v2。v1是为了与后向兼容性，将在0.4.0中弃用。直到API稳定，不会分配默认值。自定义事件仅在使用v2时公开。
include_names（可选[Sequence[str]]）- 仅包括与匹配名称的可执行体相关的事件。
include_types（可选[Sequence[str]]）- 仅包括与匹配类型的可执行体相关的事件。
include_tags (可选[序列[字符串]]) – 仅包括具有匹配标签的runnable的条目。
exclude_names (可选[序列[字符串]]) – 排除具有匹配名称的runnable的条目。
exclude_types (可选[序列[字符串]]) – 排除具有匹配类型的runnable的条目。
exclude_tags (可选[序列[字符串]]) – 排除具有匹配标签的runnable的条目。
kwargs (任意) – 将传递给Runnable的额外关键字参数。这些将被传递给astream_log，因为astream_events的实现是基于astream_log构建的。

生成

异步流中的StreamEvents。

异常

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

返回类型

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

batch(inputs: List[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]] ]], config: Optional[Union[RunnableConfig, List[RunnableConfig]]]]"/>, *, return_exceptions: bool = False, **kwargs: Any) → List[str]¶

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

默认批量实现适用于I/O密集型runnables。

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

参数

inputs (列表【Union【PromptValue，str，Sequence【Union【BaseMessage，列表【str】，元组【str，str】，str，字典【str，Any】】】】） -
config (可选【Union【RunnableConfig，列表【RunnableConfig】】】） -
return_exceptions (bool） -
关键字参数 (Any) –

返回类型

字符串列表

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

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

参数

inputs ((em>Sequence[Input]) –
config ((em>Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) –
return_exceptions (bool） -
kwargs ((em>Optional[Any]) –

返回类型

em>Iterator[Tuple[int, em>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) – 是否在键前缀 ConfigurableField id。默认为False。
**kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到可运行对象实例或返回可运行对象实例的 callables 的字典。

返回

配置好可选方案的新可运行对象。

返回类型

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
)

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 (可选[List[str]]) – 生成时使用的停止词。模型输出在首次出现这些子串之一时将截断。
callbacks (联合[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。用于在生成过程中执行附加功能，如记录或流式传输。
tags (可选[联合[列表[str], 列表[列表[str]]]]]) – 与每个提示关联的标签列表。如果提供，列表的长度必须与提示列表的长度匹配。
metadata (可选[联合[字典[str, 任何类型], 列表[字典[str, 任何类型]]]]]) – 与每个提示关联的元数据字典列表。如果提供，列表的长度必须与提示列表的长度匹配。
run_name (可选[联合[str, 列表[str]]]]) – 与每个提示关联的运行名称列表。如果提供，列表的长度必须与提示列表的长度匹配。
run_id (可选[联合[UUID, 列表[可选[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]) – 提示值的列表。提示值是一个可以转换为与任何语言模型（纯文本生成模型的字符串和聊天模型的BaseMessages）兼容格式的对象。
stop (可选[List[str]]) – 生成时使用的停止词。模型输出在首次出现这些子串之一时将截断。
callbacks (联合[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。用于在生成过程中执行附加功能，如记录或流式传输。
**kwargs (任意的) – 额外的关键字参数。这些通常传递给模型提供者的API调用。

返回

一个LLMResult，其中包含每个输入提示的候选生成列表以及额外的模型提供程序特定输出。: 。

返回类型

LLMResult

get_num_tokens(text: str) → int¶

获取文本中存在的标记数目。

用于检查输入是否符合模型上下文窗口大小。

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

get_num_tokens_from_messages(messages: List[BaseMessage]) → int¶

获取消息中的标记数量。

用于检查输入是否符合模型上下文窗口大小。

参数: messages (List[BaseMessage]) - 要分词的消息输入。
返回: 消息中标记数的总和。
返回类型: 整型

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

返回文本中标记的有序ID。

参数

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

返回

与文本中的标记相对应的ID列表，顺序与文本中标记出现顺序一致。: 文本中的标记顺序ID列表。

返回类型

List[int]

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 以获取更多详细信息。
停止条件 (Optional[List[str]]) –
关键字参数 (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]]) –
关键字参数 (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]]) –
关键字参数 (Any) –

返回类型

BaseMessage

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 (任何) – 传递给Runnable的附加关键字参数。
停止条件 (Optional[List[str]]) –

生成

Runnable的输出。

返回类型

Iterator[str]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将可运行的实体序列化为JSON。

返回: 可运行的 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]]) –
关键字参数 (Any) –

返回类型

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

langchain_community.llms.gpt4all.GPT4All¶

使用 GPT4All 的示例¶

`langchain_community.llms.gpt4all`.GPT4All¶