`langchain_community.llms.deepsparse`.DeepSparse¶

注意

DeepSparse实现了标准Runnable 接口。🏃

Runnable接口提供了额外的方法，这些方法在可运行对象中可用，例如with_types、with_retry、assign、bind、get_graph等。

class langchain_community.llms.deepsparse.DeepSparse[source]¶

基类：LLM

Neural Magic DeepSparse LLM接口。使用时，您需要安装deepsparse或deepsparse-nightly Python包。参见https://github.com/neuralmagic/deepsparse 此接口允许您直接从[SparseZoo](https://sparsezoo.neuralmagic.com/?useCase=text_generation)部署优化的LLM。.. rubric:: 示例

param cache: Union[BaseCache, bool, None] = None¶

是否缓存响应。

如果为true，将使用全局缓存。
如果为false，则不使用缓存。
如果为None，将在全局缓存已设置的情况下使用全局缓存，否则不使用缓存。
如果为BaseCache实例，则将使用提供的缓存。

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

参数 callback_manager: 可选[BaseCallbackManager] = None¶: [已废弃]

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

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

参数 generation_config :可选[None, str, Dict] = None¶: 包含用于控制每个提示生成的序列参数的GenerationConfig字典。常见参数包括：max_length，max_new_tokens，num_return_sequences，output_scores，top_p，top_k，repetition_penalty。

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

参数 model :str [必需]¶: 模型文件的路径或目录，或SparseZoo模型占位符的名称。

参数 model_config: Optional[Dict[str, Any]] = None¶: 传递给管道构建的关键字参数。常见参数包括序列长度、提示序列长度。

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

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

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

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

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

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

参数

prompt (str) – 要生成的提示。
stop (Optional[列表[str]]) – 当生成时要使用的停止词。模型输出将在出现这些子串的第一个位置被截断。
callbacks (Optional[Union[列表[BaseCallbackHandler], BaseCallbackManager]]) – 要传递的回调。在整个生成过程中用于执行额外的功能，例如记录或流式传输。
tags (Optional[列表[str]]) – 与提示关联的标签列表。
metadata (Optional[Dict[str, Any]]) – 与提示关联的元数据。
**kwargs (Any) – 随意的额外关键字参数。通常将这些参数传递给模型提供者API调用。

返回值

生成的文本。

引发

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

返回类型

str

async abatch(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]¶

默认实现采用asyncio.gather并行运行run_in_place。

默认的batch实现对于IO密集型runnables效果良好。

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

参数

输入 (列表[联合[PromptValue， str， Sequence[联合[BaseMessage，列表[str]， Tuple[str， str]， str， Dict[str， Any]]]]) – Runnable 的输入列表。
config (可选[联合[RunnableConfig，列表[RunnableConfig]]]) – 调用 Runnable 时使用的配置。配置支持用于跟踪的标准键，如 'tags'、'metadata'，'max_concurrency' 以控制并行工作的数量，以及其他键。有关详细信息，请参阅 RunnableConfig。默认为 None。
return_exceptions (bool) – 是否返回异常而不是引发它们。默认为 False。
kwargs (Any) – 要传递给 Runnable 的其他关键词参数。

返回值

Runnable 的输出列表。

返回类型

列表[str]

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 (可选：Union[RunnableConfig, Sequence[RunnableConfig]]]) – 当调用Runnable时使用的配置。该配置支持标准键，如用于跟踪的“tags”，‘metadata’；控制并行工作量的‘max_concurrency’等。有关更多详细信息，请参阅RunnableConfig。默认为None。默认为None。
return_exceptions (bool) – 是否返回异常而不是引发它们。默认为 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¶

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

当模型公开批处理API时，应使用此方法进行批处理调用。

在以下情况下使用此方法：

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

参数

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

返回值

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

返回类型

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]) – 提示值列表。提示值是一个可以将自己转换为适应任何语言模型格式的对象（纯文本生成模型的字符串和聊天模型的BaseMessages）。
stop (Optional[列表[str]]) – 当生成时要使用的停止词。模型输出将在出现这些子串的第一个位置被截断。
callbacks (联合：Union[列表：BaseCallbackHandler, BaseCallbackManager, None, 列表：Optional[Union[列表：BaseCallbackHandler, BaseCallbackManager]]]]) – 要传递的回调。用于在整个生成过程中执行附加功能，如记录或流式传输。
**kwargs (Any) – 随意的额外关键字参数。通常将这些参数传递给模型提供者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 * **, 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 (可选[[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 (列表[BaseMessage]) –
stop (可选[[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将从可运行的实体实例化一个具有名称、描述和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 指定架构

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]]]], Optional[RunnableConfig] = None, %kwargs: Any) → AsyncIterator[str]¶

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

参数

输入 (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) - 可运行的输入。
配置 (Optional[RunnableConfig]) - 用于可运行的配置。默认为 None。
kwargs (Any) – 要传递给 Runnable 的其他关键词参数。
stop (Optional[List[str]]) –

产生

可运行的输出。

返回类型

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 的迭代器，提供有关可运行进度（包括中间结果）的真实信息。

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

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将有一个空列表。父ID的顺序是从根到直接父级。仅适用于API的v2版本。API的v1版本将返回一个空列表。
tags：Optional[List[str]] - 生成事件的Runnable的标签。
metadata：Optional[Dict[str, Any]] - 生成事件的Runnable的元数据。
data：Dict[str, Any]

以下是一个表格，说明了可能由各种链发出的某些事件。为了简洁起见，已省略元数据字段。链定义在表格之后。

注意此参考表是针对架构的V2版本。

event	name	chunk	input	output
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版本中公开！

自定义事件具有以下格式

属性	类型	描述
name	str	用户定义的事件名称。
data	Any	与事件关联的数据。这可以是一切东西，尽管我们建议使其可序列化。

以下是与上述标准事件相关的声明

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 （任何）- Runnable的输入。
config （可选）- 可用于Runnable的配置。
version （文字）[‘v1’，‘v2’] - 要使用的架构版本的版本，即v2或v1。用户应使用v2。 v1是为了向后兼容，将在0.4.0版本中弃用。API稳定前不会分配默认值。自定义事件仅在v2中公开。
include_names （可选）- 仅包含具有匹配名称的runnables的事件。
include_types （可选）- 仅包含具有匹配类型的runnables的事件。
include_tags （可选）- 仅包含具有匹配标签的runnables的事件。
exclude_names （可选）- 排除具有匹配名称的runnables的事件。
exclude_types (可选【序列【str】】) – 排除具有匹配类型的运行可执行事件。
exclude_tags (可选【序列【str】】) – 排除具有匹配标签的运行可执行事件。
kwargs (任意) – 用于传递给运行可执行体的额外关键字参数。这些将传递给astream_log，因为本实现基于astream_log构建astream_events。

产生

流事件的一个异步流。

引发

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

返回类型

AsyncIterator[联合[StandardStreamEvent, CustomStreamEvent]]

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

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

默认的batch实现对于IO密集型runnables效果良好。

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

参数

inputs (列表[Union[PromptValue, str, Sequence[Union[BaseMessage, 列表[str], 元组[str, str], str, 字典[str, Any]]]]]) –
config (可选[Union[RunnableConfig, List[RunnableConfig]]]) –
return_exceptions (布尔值) –
kwargs (Any) –

返回类型

列表[str]

batch_as_completed(inputs: 序列[输入], config: 可选[Union[RunnableConfig, 序列[RunnableConfig]]] = None, *, return_exceptions: 布尔值 = False, **kwargs: 可选[任何]) → 迭代器[元组[整数, Union[输出, 异常]]]¶

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

参数

inputs (序列[输入]) –
config (可选[Union[RunnableConfig, 序列[RunnableConfig]]]) –
return_exceptions (布尔值) –
kwargs (可选[任何]) –

返回类型

迭代器[元组[整数, Union[输出, 异常]]]

configurable_alternatives(which: ConfigurableField, *args, 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） – 如果没有选择替代方案，则使用的默认键。默认为“默认”。
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
)

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 (Optional[列表[str]]) – 当生成时要使用的停止词。模型输出将在出现这些子串的第一个位置被截断。
callbacks (联合：Union[列表：BaseCallbackHandler, BaseCallbackManager, None, 列表：Optional[Union[列表：BaseCallbackHandler, BaseCallbackManager]]]]) – 要传递的回调。用于在整个生成过程中执行附加功能，如记录或流式传输。
tags (可选：联合：Union[列表：str, 列表：列表：str]]) – 与每个提示关联的标签列表。如果提供，则列表的长度必须与提示列表的长度匹配。
metadata (可选：联合：Union[字典：str，Any], 列表：字典：str，Any]]) – 与每个提示关联的元数据字典列表。如果提供，则列表的长度必须与提示列表的长度匹配。
run_name (可选：联合：Union[str, 列表：str]]) – 与每个提示关联的运行名称列表。如果提供，则列表的长度必须与提示列表的长度匹配。
run_id (可选：联合：Union[UUID, 列表：Optional[UUID]]]) – 与每个提示关联的运行ID列表。如果提供，则列表的长度必须与提示列表的长度匹配。
**kwargs (Any) – 随意的额外关键字参数。通常将这些参数传递给模型提供者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 (Optional[列表[str]]) – 当生成时要使用的停止词。模型输出将在出现这些子串的第一个位置被截断。
callbacks (联合：Union[列表：BaseCallbackHandler, BaseCallbackManager, None, 列表：Optional[Union[列表：BaseCallbackHandler, BaseCallbackManager]]]]) – 要传递的回调。用于在整个生成过程中执行附加功能，如记录或流式传输。
**kwargs (Any) – 随意的额外关键字参数。通常将这些参数传递给模型提供者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) → 列表[int]¶

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

参数

text (str) – 要进行标记的字符串输入。

返回值

与文本中的标记对应的ID列表，按照它们的顺序排列。: 文本中标记按顺序排列的ID列表。

返回类型

列表[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¶

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

参数

输入 (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) - 可运行的输入。
config (可选＜＜a class="reference internal" href="#langchain_core.runnables.config.RunnableConfig" title="langchain_core.runnables.config.RunnableConfig"＞＜em＞RunnableConfig＜/em＞＜/a＞＜em＞]＜/em＞) －调用可运行时使用的配置。配置支持标准键，例如用于跟踪的‘tags’、‘metadata’，用于控制并行工作的‘max_concurrency’以及其他键。有关更多详细信息，请参阅RunnableConfig。
stop (Optional[List[str]]) –
kwargs (Any) –

返回值

可运行的输出。

返回类型

str

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

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

参数

text (str) –
stop (可选[[str]]) –
kwargs (Any) –

返回类型

str

predict_messages(messages: List[BaseMessage]) → BaseMessage¶

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

参数

messages (列表[BaseMessage]) –
stop (可选[[str]]) –
kwargs (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")

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

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

参数

输入 (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) - 可运行的输入。
配置 (Optional[RunnableConfig]) - 用于可运行的配置。默认为 None。
kwargs (Any) – 要传递给 Runnable 的其他关键词参数。
stop (Optional[List[str]]) –

产生

可运行的输出。

返回类型

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]]) –
kwargs (Any) –

返回类型

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

DeepSparse的使用示例¶

DeepSparse

langchain_community.llms.deepsparse.DeepSparse¶

DeepSparse的使用示例¶

`langchain_community.llms.deepsparse`.DeepSparse¶