`langchain_community.llms.vertexai`.VertexAIModelGarden¶

注意

VertexAIModelGarden实现了标准Runnable接口。🏃

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

class langchain_community.llms.vertexai.VertexAIModelGarden[源代码]¶

基类：_VertexAIBase，BaseLLM

自版本0.0.12开始已弃用: 请使用langchain_google_vertexai.VertexAIModelGarden代替。

Vertex AI模型花园的大型语言模型。

参数 allowed_model_args: Optional[List[str]]= None¶: 允许传递给模型的可选参数。

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

是否缓存响应。

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

当前不支持在模型的流式方法中使用缓存。

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

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

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

参数 endpoint_id: str [Required]¶: 模型已部署的端点的名称。

参数 location: str = 'us-central1'¶: 执行API调用时使用的默认位置。

参数 max_retries: int = 6¶: 生成时尝试的最大重试次数。

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

参数 model_name: Optional[str] = None¶: 底层模型名称。

参数 project: Optional[str] = None¶: 在执行Vertex API调用时使用的默认GCP项目。

参数 prompt_arg: str = 'prompt'¶

参数 request_parallelism: int = 5¶: 向VertexAI模型发出的请求允许的并行量。

参数 result_arg: Optional[str] = 'generated_text'¶: 如果模型的输出预期为字符串，则将result_arg设置为None。

参数 stop: Optional[List[str]] = None¶: 生成时使用的可选停用词列表。

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

param verbose: bool [Optional]¶: 是否打印出响应文本。

__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 (可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]) – 要传递的回调。用于在生成过程中执行附加功能，如日志记录或流输出。
tags (可选[列表[str]]) – 与提示相关联的标签列表。
metadata (可选[字典[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]]] = None, *, return_exceptions: bool = False, **kwargs: Any) → List[str]¶

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

默认的批量实现对于I/O密集型的runnables表现良好。

子类应在其能够更有效地批量处理的条件下覆盖此方法；例如，如果底层Runnable使用支持批量模式的API。

参数

inputs (列表[联合[[提示值，str，序列[[联合[[基础消息，str列表，元组[[str，str]，str，字典[str，任何]]]]]]]]) – Runnable的输入列表。
config (Optional[Union[RunnableConfig, List[RunnableConfig]]]) – 调用Runnable时使用的配置。该配置支持标准键，如用于追踪的‘tags’、‘metadata’，用于控制并行工作量的‘max_concurrency’和其他键。请参考RunnableConfig获取更多详情。默认为None。
return_exceptions (bool) – 是否返回异常而不是引发它们。默认为False。
kwargs (Any) – 传递给Runnable的附加关键字参数。

返回

Runnable的输出列表。

返回类型

List[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 (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用Runnable时使用的配置。该配置支持标准键，如用于追踪的‘tags’、‘metadata’，用于控制并行工作量的‘max_concurrency’和其他键。请参考RunnableConfig获取更多详情。默认为None。默认为None。
return_exceptions (bool) – 是否返回异常而不是引发它们。默认为False。
kwargs (Optional[Any]) – 传递给Runnable的附加关键字参数。

产生

Runnable的输入和输出索引的元组。

返回类型

AsyncIterator[_tuple[int, Union[Output, 异常]]]

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的模型，应使用本方法进行批量调用。

当您想

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

参数

提示 (str列表) – 字符串提示列表。
stop (可选[列表[str]]) – 生成时使用的停用词。模型输出会在任何这些子字符串首次出现时截断。
回调 (Union[[BaseCallbackHandler列表], BaseCallbackManager, None, [Optional [Union [[BaseCallbackHandler列表], BaseCallbackManager]]]]]) – 传递的回调。用于在整个生成过程中执行附加功能，如日志记录或流式处理。
标签 (Optional[[str列表, [str列表]]]) – 与每个提示关联的标签列表。如果提供，列表的长度必须与提示列表的长度匹配。
元数据 (Optional[[str, Any]]字典列表]) – 与每个提示关联的元数据字典列表。如果提供，列表的长度必须与提示列表的长度匹配。
运行名称 (Optional[[str, [str]]]) – 与每个提示关联的运行名称列表。如果提供，列表的长度必须与提示列表的长度匹配。
运行ID (Optional[[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 (可选[列表[str]]) – 生成时使用的停用词。模型输出会在任何这些子字符串首次出现时截断。
回调 (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, *, stop: Optional[List[str]] = None, **kwargs: Any) → str¶

ainvoke的默认实现，通过线程调用invoke。

默认实现允许即使Runnable没有实现原生async版本的invoke，也可以使用async代码。

子类应该覆盖此方法，如果它们能够异步运行。

参数

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将从可执行对象中实例化一个具有名称、描述和args_schema的BaseTool。尽可能从runnable.get_input_schema推断模式。如果可能（例如，如果Runnable接受字典作为输入且具体的字典键未进行类型化），则可以直接使用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]]]], 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的附加关键字参数。
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的迭代器，StreamEvents提供了关于Runnable进度的实时信息，包括中间结果的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版本的架构。

事件	名称	块	输入	输出
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 (可选：序列[str]) – 只包含具有匹配类型的可运行事件的。
include_tags (可选：序列[str]) – 只包含具有匹配标签的可运行事件的。
exclude_names (可选：序列[str]) – 排除具有匹配名称的可运行事件。
exclude_types (可选：序列[str]) – 排除具有匹配类型的可运行事件。
exclude_tags (可选：序列[str]) – 排除具有匹配标签的可运行事件。
kwargs (任何) – 向可运行对象传递的额外关键字参数。这些参数将传递给astream_log，因为astream_events的实现建立在astream_log之上。

产生

StreamEvents的异步流。

引发

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

返回类型

AsyncIterator [Union [StandardStreamEvent, CustomStreamEvent]]

批量(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]¶

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

默认的批量实现对于I/O密集型的runnables表现良好。

子类应在其能够更有效地批量处理的条件下覆盖此方法；例如，如果底层Runnable使用支持批量模式的API。

参数

inputs (List[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]]) –
config (可选[并集[RunnableConfig, 列表[RunnableConfig]]]) –
return_exceptions (布尔型) –
kwargs （Any） –

返回类型

List[str]

batch_as_completed(inputs: 序列[输入], config: 可选[并集[RunnableConfig, 序列[RunnableConfig]]] = None, *, return_exceptions: 布尔型 = False, **kwargs: 可选[任何]) → 迭代器[元组[int, 并集[输出, Exception]]]]¶

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

参数

inputs (序列[输入]) –
config (可选[并集[RunnableConfig, 序列[RunnableConfig]]) –
return_exceptions (布尔型) –
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]¶

配置可运行对象的可选配置。

参数

which (ConfigurableField) – 用于选择可选配置的 ConfigurableField 实例。
default_key (str) – 如果未选择任何可选配置，则使用的默认键。默认为“default”。
prefix_keys (bool) – 是否将键以 ConfigurableField id 为前缀。默认为 False。
**kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到可运行对象实例或返回可运行对象实例的调用功能的字典。

返回

配置可选配置的新可运行对象。

返回类型

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的模型，应使用本方法进行批量调用。

当您想

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

参数

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

返回

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

返回类型

LLMResult

get_num_tokens(text: str) → int¶

获取文本中现有的token数量。

有助于检查输入是否适合模型的前景窗口。

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

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

获取消息中的token数量。

有助于检查输入是否适合模型的前景窗口。

参数: 消息 (列表[BaseMessage]) – 要进行分词的消息输入。
返回: 消息中标记数目的总和。
返回类型: int

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

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

参数

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

返回

对应文本中标记的 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¶

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

参数

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]], **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]], **kwargs: Any) → BaseMessage¶

自 langchain-core==0.1.7 版本以来已弃用: 请使用 invoke 代替。

参数

messages (List[BaseMessage]) –
stop (Optional[Sequence[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]]]], 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]]]], 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]]

property endpoint_path: str¶

task_executor: ClassVar[Optional[Executor]] = FieldInfo(exclude=True, extra={})¶

langchain_community.llms.vertexai.VertexAIModelGarden¶

VertexAIModelGarden的示例用法¶

`langchain_community.llms.vertexai`.VertexAIModelGarden¶