`langchain_community.llms.layerup_security`.LayerupSecurity¶

注意

LayerupSecurity实现了标准Runnable 接口。🏃

Runnable 接口还包括在runnables中可用的额外方法，如with_types、with_retry、assign、bind和更多。

class langchain_community.llms.layerup_security.LayerupSecurity[source]¶

基类: LLM

Layerup Security LLM 服务。

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

是否缓存响应。

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

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

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

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

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

参数 handle_prompt_guardrail_violation: Callable[[dict], str] = <function default_guardrail_violation_handler>¶

参数 handle_response_guardrail_violation: Callable[[dict], str] = <function default_guardrail_violation_handler>¶

参数 layerup_api_base_url::str = 'https://api.uselayerup.com/v1'¶

参数 :layerup_api_key:str[必需]¶

参数 :llm:LLM[必需]¶

参数 :mask:bool = False¶

参数 :metadata:Optional[Dict[str, Any]]] = {}¶: 将在运行跟踪中添加的元数据。

参数 :prompt_guardrails:Optional[List[str]]]=[]¶

参数 :response_guardrails:Optional[List[str]]]=[]¶

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

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

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

默认批处理实现适用于 I/O 密集型的 Runnable。

子类应在其能更有效地批处理时重写此方法；例如，如果底层 Runnable 使用支持批处理模式的 API。

参数

输入 (列表：联合：PromptValue，str，Sequence：联合：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

asyncabatch_as_completed(inputs: Sequence[Input], config: Optional[Union[RunnableConfig, Sequence[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → AsyncIterator[Tuple[int, 联合：[Output, Exception]]]

并行在输入列表上运行 ainvoke，并异步地返回完成的结果。

参数

inputs (Sequence：Input]) – Runnable 的输入列表。
config （可选：Union[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¶

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

当模型公开了批量API时，应使用此方法批量调用模型。

您想在以下情况下使用此方法

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

参数

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

返回

对于每个提示，包含候选生成内容的列表。: 和额外的模型提供者特定的输出。

返回类型

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 (Optional[List[str]]) – 生成时使用的停用词。模型输出将在首次出现任何一个这些子串时截断。
callbacks （Union：Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]]]]]） – 传递的回调。用于在整个生成过程中执行附加功能，例如日志记录或流。
**kwargs (任意) – 任意额外的关键字参数。这些参数通常传递给模型提供者API调用。

返回

对于每个提示，包含候选生成内容的列表。: 和额外的模型提供者特定的输出。

返回类型

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

返回类型

str

async apredict(文本: str, *, stop: 可选[str序列] = None, **kwargs: 任意的) → str¶

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

参数

文本 (str) –
stop (可选[str序列]) –
kwargs (Any) –

返回类型

str

async apredict_messages(messages: List[BaseMessage], *, stop: 可选[str序列] = None, **kwargs: 任意的) → BaseMessage¶

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

参数

messages (List[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 (可选[类型[BaseModel]]) – 工具的模式。默认为None。
name (可选[字符串]) – 工具的名称。默认为None。
description (可选[字符串]) – 工具的描述。默认为None。
arg_types (可选[字典[字符串, 类型]]) – 表示参数名称到类型的字典。默认为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 (Any) – 传递给 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 进度的实时信息，包括中间结果的 StreamEvents。

StreamEvent 是一个具有以下模式的字典

event: str - 事件名称为
格式: on_[runnable_type]_(start|stream|end)。
name： str - 产生事件的Runnable的名称。
run_id： str - 与给定执行的Runnable关联的随机生成的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”: [[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	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']) – 要使用的模式版本，可以是v2或v1。用户应使用v2。v1是为了后向兼容性，并在0.4.0中将弃用。直到API稳定之前，不会分配默认值。自定义事件仅会在v2中披露。
include_names (Optional[Sequence[str]]) – 仅包括具有匹配名称的runnables的事件。
include_types (可选[序列[字符串]]) – 仅包括类型匹配的执行程序的事件。
include_tags (可选[序列[字符串]]) – 仅包括具有匹配标签的执行程序的事件。
exclude_names (可选[序列[字符串]]) – 排除具有匹配名称的执行程序的事件。
exclude_types (可选[序列[字符串]]) – 排除具有匹配类型的执行程序的事件。
exclude_tags (可选[序列[字符串]]) – 排除具有匹配标签的执行程序的事件。
kwargs (任意) – 传递给 Runnable 的额外关键字参数。这些将传递给 astream_log，因为 astream_events 的实现是基于 astream_log 构建的。

生成

异步流中的 StreamEvents。

抛出

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

返回类型

AsyncIterator[并集[StandardStreamEvent, CustomStreamEvent]]

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

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

默认批处理实现适用于 I/O 密集型的 Runnable。

子类应在其能更有效地批处理时重写此方法；例如，如果底层 Runnable 使用支持批处理模式的 API。

参数

inputs (列表[Union[PromptValue, str, Sequence[Union[BaseMessage, 列表[str], 元组[str, str], str, 字典[str, Any]]]]]) –
config (Optional[Union[RunnableConfig, 列表[RunnableConfig]]]) –
return_exceptions (bool) –
kwargs (Any) –

返回类型

列表：str

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

在输入列表上并行运行 invoke，并发送已完成的结果。

参数

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

返回类型

Iterator[Tuple[int, Union[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实例的callables的字典。

返回

配置可选方案的新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]¶

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

返回

对于每个提示，包含候选生成内容的列表。: 和额外的模型提供者特定的输出。

返回类型

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 (Optional[List[str]]) – 生成时使用的停用词。模型输出将在首次出现任何一个这些子串时截断。
callbacks （Union：Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]]]]]） – 传递的回调。用于在整个生成过程中执行附加功能，例如日志记录或流。
**kwargs (任意) – 任意额外的关键字参数。这些参数通常传递给模型提供者API调用。

返回

对于每个提示，包含候选生成内容的列表。: 和额外的模型提供者特定的输出。

返回类型

LLMResult

get_num_tokens(text: str) → int¶

获取文本中的标记数。

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

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

获取消息中的token数量。

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

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

返回文本中token的有序ID。

参数

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

返回

一个列表，包含文本中token对应的ID，按出现顺序排列。: 在文本中按顺序出现。

返回类型

列表[整数]

invoke(input: 联合[PromptValue, str, Sequence[联合[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]], config: 可选[RunnableConfig] = None, *, stop: 可选[列表[str]] = None, **kwargs: Any) → str¶

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

参数

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

返回

Runnable 的输出。

返回类型

str

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

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

参数

文本 (str) –
stop (可选[str序列]) –
kwargs (Any) –

返回类型

str

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

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

参数

messages (List[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")

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 的附加关键字参数。
停止 (Optional[List[str]]) –

生成

Runnable 的输出。

返回类型

Iterator[str]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]

将 Runnable 序列化为 JSON。

返回: Runnable 的 JSON 序列化表示形式。
返回类型: 集合[序列化构造函数, 序列化未实现]

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

LayerupSecurity 使用示例¶

Layerup Security

langchain_community.llms.layerup_security.LayerupSecurity¶

LayerupSecurity 使用示例¶

`langchain_community.llms.layerup_security`.LayerupSecurity¶