langchain_community.llms.sambanova.Sambaverse

注意:

Sambaverse实现了标准Runnable 接口。🏃

Runnable 接口还提供了可用的额外方法,例如with_typeswith_retryassignbindget_graph等。

langchain_community.llms.sambanova.Sambaverse[源代码]

基类: LLM

Sambaverse大语言模型。

使用它,您应设置环境变量SAMBAVERSE_API_KEY为您自己的API密钥。

https://sambaverse.sambanova.ai获取,更多文档请阅读https://docs.sambanova.ai/sambaverse/latest/index.html

示例:.. code-block:: python

from langchain_community.llms.sambanova import Sambaverse Sambaverse(

sambaverse_url=”https://sambaverse.sambanova.ai”, sambaverse_api_key=”your-sambaverse-api-key”, sambaverse_model_name=”Meta/llama-2-7b-chat-hf”, streaming: = False model_kwargs={

“select_expert”: “llama-2-7b-chat-hf”, “do_sample”: False, “max_tokens_to_generate”: 100, “temperature”: 0.7, “top_p”: 1.0, “repetition_penalty”: 1.0, “top_k”: 50, “process_prompt”: False

},

)

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

是否缓存响应。

  • 如果为真,将使用全局缓存。

  • 如果为假,则不会使用缓存。

  • 如果为None,则如果设置了全局缓存,则使用它;否则不使用缓存。

  • 如果实例为BaseCache,将使用提供的缓存。

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

参数callback_manager: Optional[BaseCallbackManager] = None

[已废弃]

参数callbacks: Callbacks = None

要添加到运行跟踪中的回调。

参数custom_get_token_ids: Optional[Callable[[str], List[int]]] = None

用于计数的可选编码器。

参数metadata: Optional[Dict[str, Any]] = None

要添加到运行跟踪中的元数据。

参数model_kwargs: Optional[dict] = None

传递到模型的键值参数。

参数sambaverse_api_key: str = ''

Sambaverse API密钥

参数sambaverse_model_name: Optional[str] = None

将使用的Sambaverse专家模型

参数 sambaverse_url: str = ''

使用的 Sambaverse URL

参数 streaming: Optional[bool] = False

获取流式响应的标志。

参数 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]]) – 与提示关联的标签列表。

  • 元数据 (可选[字典][字符串, 任意类型]]) – 与提示关联的元数据。

  • **kwargs (任意类型) – 任意额外的关键字参数。这些通常传递给模型提供者API调用。

返回值

生成的文本。

抛出异常

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

返回类型

字符串

*kwargs: Any 字符串列表

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

默认的批量实现适用于绑定型的runnables。

子类应根据需要重写此方法以批处理更有效地;例如,如果底层runnable使用支持批量模式的API。

参数
  • 输入 (列表[联合[PromptValue, str, 序列[联合[BaseMessage, 列表[str], 元组[str, str], str, 字典[str, Any]]]]]) – Runnable 的输入列表。

  • config (可选[联合[RunnableConfig, 列表[RunnableConfig]]]) – 在调用 Runnable 时使用的配置。配置支持标准键,如“tags”(标签)、“metadata”(元数据)用于跟踪目的、“max_concurrency”(最大并发数)用于控制并行工作的量,以及其他键。有关更多详细信息,请参阅 RunnableConfig。默认为 None。

  • return_exceptions (布尔值) – 是否返回异常而不是引发它们。默认为 False。

  • kwargs (任意) – 传递给 Runnable 的额外关键字参数。

返回值

Runnable 的输出列表。

返回类型

列表[str]

async abatch_as_completed(inputs: 序列[输入], config: 可选[联合[RunnableConfig, 序列[RunnableConfig]]] = None, *, return_exceptions: 布尔值 = False, **kwargs: 可选[任意]) AsyncIterator[元组[int, 联合[输出, 异常]]]

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

参数
  • inputs (序列[输入]) – Runnable 的输入列表。

  • config (可选[联合[RunnableConfigSequence[RunnableConfig]]]) – 在调用可执行对象时使用的配置。该配置支持像'tags'、'metadata'这样的标准关键字(用于跟踪)、'max_concurrency'(用于控制并行工作多少)以及其他关键字。请参阅RunnableConfig以获取更多详细信息。默认值为None。默认值为None。

  • return_exceptions (布尔值) – 是否返回异常而不是引发它们。默认为 False。

  • kwargs (可选[任何]) – 传递给可执行对象的额外关键字参数。

产生

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

返回类型

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

异步地传递一个提示序列到一个模型并返回生成。

当你想使用批处理调用时应该使用此方法。

用于以下情况:
  1. 利用批量调用,

  2. 需要比仅顶部的生成值更多的模型输出,

  3. 正在构建对底层语言模型类型(例如,纯文本完成模型与聊天模型)无知的链。

    类型。

参数
  • prompts (列表[str]) – 字符串提示列表。

  • stop (Optional[List[str]]) – 在生成时使用的停止词。模型输出在遇到这些子字符串的第一个时截断。

  • callbacks (联合[列表[BaseCallbackHandler]BaseCallbackManagerNone列表[可选[联合[列表[BaseCallbackHandler]BaseCallbackManager]]]]) – 要传递的回调。在整个生成过程中用于执行附加功能,如日志记录或流处理。

  • tags (可选[联合[列表[str]列表[列表[str]]]]]) – 与每个提示关联的标签列表。如果提供,则列表长度必须与提示列表的长度匹配。

  • metadata (可选[联合[Dict[strAny]列表[Dict[strAny]]]]]) – 与每个提示关联的元数据字典列表。如果提供,则列表长度必须与提示列表的长度匹配。

  • run_name (可选[联合[str列表[str]]]) – 与每个提示关联的运行名称列表。如果提供,则列表长度必须与提示列表的长度匹配。

  • run_id (可选[联合[UUID列表[可选[UUID]]]]) – 与每个提示关联的运行ID列表。如果提供,则列表长度必须与提示列表的长度匹配。

  • **kwargs (任意类型) – 任意额外的关键字参数。这些通常传递给模型提供者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

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

当你想使用批处理调用时应该使用此方法。

用于以下情况:
  1. 利用批量调用,

  2. 需要比仅顶部的生成值更多的模型输出,

  3. 正在构建对底层语言模型类型(例如,纯文本完成模型与聊天模型)无知的链。

    类型。

参数
  • prompts (列表[PromptValue]) – PromptValue 列表。PromptValue 是一个对象,可以被转换成任何语言模型可接受的格式(纯文本生成模型的字符串格式和聊天模型的 BaseMessages 格式)。

  • stop (Optional[List[str]]) – 在生成时使用的停止词。模型输出在遇到这些子字符串的第一个时截断。

  • callbacks (联合[列表[BaseCallbackHandler]BaseCallbackManagerNone列表[可选[联合[列表[BaseCallbackHandler]BaseCallbackManager]]]]) – 要传递的回调。在整个生成过程中用于执行附加功能,如日志记录或流处理。

  • **kwargs (任意类型) – 任意额外的关键字参数。这些通常传递给模型提供者API调用。

返回值

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

返回类型

LLMResult

async ainvoke(input: Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]], 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) –

返回类型

字符串

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) –

返回类型

字符串

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

Beta

该API处于测试阶段,未来可能会发生变化。

从可运行对象创建BaseTool。

as_tool将从Runnable中实例化一个具有名称、描述和args_schema的BaseTool。尽可能情况下,通过runnable.get_input_schema推断模式。另择方案(例如,如果Runnable接受字典作为输入且具体字典的键没有类型),可以直接通过args_schema指定模式。您还可以传递arg_types仅指定所需参数及其类型。

参数
  • args_schema (Optional[Type[BaseModel]]) – 工具的模式。默认为None。

  • name (Optional[str]) – 工具的名称。默认为None。

  • description (Optional[str]) – 工具的描述。默认为None。

  • arg_types (Optional[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 的额外关键字参数。

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

Beta

该API处于测试阶段,未来可能会发生变化。

生成事件流。

用于创建一个迭代器,对StreamEvents进行迭代,提供关于Runnable进度的实时信息,包括来自中间结果的事件流。

StreamEvent是一个包含以下模式的字典

  • event: str - 事件名称为:

    格式:on_[可运行类型]_(开始|流|结束)。

  • namestr - 生成事件的可运行对象的名称。

  • run_idstr - 与给定的可运行对象执行相关联的随机生成的ID。

    事件可运行对象的子可运行对象在作为父可运行对象执行的一部分被调用时,将被分配其自己的唯一ID。

  • parent_idsList[str] - 生成事件的父可运行对象的ID。

    根可运行对象将有一个空列表。父ID的顺序是从根到直接父级。仅适用于API的v2版本。v1版本的API将返回一个空列表。

  • tagsOptional[List[str]] - 生成事件的可运行对象的标签。

  • metadataOptional[Dict[str, Any]] - 生成事件的可运行对象的元数据。

  • dataDict[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

[文档(…)]

“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版本中才会呈现!

自定义事件的格式如下:

属性

类型

描述

名称

字符串

事件的用户定义名称。

数据

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']) – 要使用的模式版本的版本,可以是v2v1。用户应使用v2v1用于向后兼容,将在0.4.0版本中弃用。默认值将被分配直到API稳定。自定义事件仅在v2中呈现。

  • include_names (Optional[Sequence[str]]) – 只包括具有匹配名称的runnables的事件。

  • include_types (Optional[Sequence[str]]) – 只包括具有匹配类型的runnables的事件。

  • include_tags (Optional[Sequence[str]]) – 只包括具有匹配标签的runnables的事件。

  • exclude_names (Optional[Sequence[str]]) – 排除具有匹配名称的runnables的事件。

  • exclude_types (可选[序列[字符串]]) – 排除具有匹配类型的可运行事件。

  • exclude_tags (可选[序列[字符串]]) – 排除具有匹配标签的可运行事件。

  • kwargs (任何) – 传递给Runnable的额外关键字参数。这些将被传递给astream_log,因为astream_events的实现是在astream_log的基础上构建的。

产生

异步的StreamEvents流。

抛出异常

NotImplementedError – 如果版本不是v1v2

返回类型

AsyncIterator[联合[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]]]] = None, *, return_exceptions: bool = False, **kwargs: Any) List[str]

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

默认的批量实现适用于绑定型的runnables。

子类应根据需要重写此方法以批处理更有效地;例如,如果底层runnable使用支持批量模式的API。

参数
返回类型

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

在输入列表上并行运行invocation,按完成顺序生成结果。

参数
  • 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) – 如果没有选择替代项时将使用的默认键。默认为“默认”。

  • prefix_keys (bool) – 是否使用ConfigurableField id作为键的前缀。默认为False。

  • **kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到Runnable实例或返回Runnable实例的Callable的字典。

返回值

已配置了替代项的新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

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

当你想使用批处理调用时应该使用此方法。

用于以下情况:
  1. 利用批量调用,

  2. 需要比仅顶部的生成值更多的模型输出,

  3. 正在构建对底层语言模型类型(例如,纯文本完成模型与聊天模型)无知的链。

    类型。

参数
  • prompts (列表[str]) – 字符串提示列表。

  • stop (Optional[List[str]]) – 在生成时使用的停止词。模型输出在遇到这些子字符串的第一个时截断。

  • callbacks (联合[列表[BaseCallbackHandler]BaseCallbackManagerNone列表[可选[联合[列表[BaseCallbackHandler]BaseCallbackManager]]]]) – 要传递的回调。在整个生成过程中用于执行附加功能,如日志记录或流处理。

  • tags (可选[联合[列表[str]列表[列表[str]]]]]) – 与每个提示关联的标签列表。如果提供,则列表长度必须与提示列表的长度匹配。

  • metadata (可选[联合[Dict[strAny]列表[Dict[strAny]]]]]) – 与每个提示关联的元数据字典列表。如果提供,则列表长度必须与提示列表的长度匹配。

  • 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

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

当你想使用批处理调用时应该使用此方法。

用于以下情况:
  1. 利用批量调用,

  2. 需要比仅顶部的生成值更多的模型输出,

  3. 正在构建对底层语言模型类型(例如,纯文本完成模型与聊天模型)无知的链。

    类型。

参数
  • prompts (列表[PromptValue]) – PromptValue 列表。PromptValue 是一个对象,可以被转换成任何语言模型可接受的格式(纯文本生成模型的字符串格式和聊天模型的 BaseMessages 格式)。

  • stop (Optional[List[str]]) – 在生成时使用的停止词。模型输出在遇到这些子字符串的第一个时截断。

  • callbacks (联合[列表[BaseCallbackHandler]BaseCallbackManagerNone列表[可选[联合[列表[BaseCallbackHandler]BaseCallbackManager]]]]) – 要传递的回调。在整个生成过程中用于执行附加功能,如日志记录或流处理。

  • **kwargs (任意类型) – 任意额外的关键字参数。这些通常传递给模型提供者API调用。

返回值

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

返回类型

LLMResult

get_num_tokens(text: str) int

获取文本中的标记数。

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

参数

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

返回值

文本中的标记整数数。

返回类型

int

get_num_tokens_from_messages(messages: List[BaseMessage]) int

获取消息中的标记数。

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

参数

messages (列表[\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],*,stop: Optional[List[str]],**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的输出。

返回类型

字符串

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) –

返回类型

字符串

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

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, *, *args:Any, 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 的额外关键字参数。

  • stop (Optional[List[str]]) –

产生

Runnable的输出。

返回类型

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

使用 Sambaverse 的示例