langchain_community.llms.sambanova.SambaStudio

注意

SambaStudio 实现了标准 Runnable Interface。🏃

Runnable Interface 还提供了一些在可运行对象上可用的额外方法,例如 with_typeswith_retryassignbind 和更多。

class langchain_community.llms.sambanova.SambaStudio[source]

基:LLM

SambaStudio 大型语言模型。

使用时,您应该设置环境变量 SAMBASTUDIO_BASE_URL 为您的 SambaStudio 环境URL。将 SAMBASTUDIO_BASE_URI 设置为您的 SambaStudio API 基 URI。将 SAMBASTUDIO_PROJECT_ID 设置为您的 SambaStudio 项目 ID。将 SAMBASTUDIO_ENDPOINT_ID 设置为您的 SambaStudio 端点 ID。将 SAMBASTUDIO_API_KEY 设置为您的 SambaStudio 端点 API 密钥。

https://sambanova.ai/products/enterprise-ai-platform-sambanova-suite

https://docs.sambanova.ai/sambastudio/latest/index.html 中阅读额外的文档

示例:.. code-block:: python

from langchain_community.llms.sambanova import SambaStudio SambaStudio(

sambastudio_base_url="your-SambaStudio-environment-URL", sambastudio_base_uri="your-SambaStudio-base-URI", sambastudio_project_id="your-SambaStudio-project-ID", sambastudio_endpoint_id="your-SambaStudio-endpoint-ID", sambastudio_api_key="your-SambaStudio-endpoint-API-key", streaming=False, model_kwargs={

"do_sample": False, "max_tokens_to_generate": 1000, "temperature": 0.7, "top_p": 1.0, "repetition_penalty": 1, "top_k": 50, #"process_prompt": False, #"select_expert": “Meta-Llama-3-8B-Instruct”

},

)

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

是否缓存响应。

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

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

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

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

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

param callback_manager: Optional[BaseCallbackManager] = None

已弃用

param callbacks :Callbacks = None

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

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

用于计算标记的备选编码器。

param metadata: Optional[Dict[str, Any]] = None

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

param model_kwargs: Optional[dict] = None

传递给模型的键值参数。

参数 sambastudio_api_key: str = ''

SambaStudio API密钥

参数 sambastudio_base_uri: str = ''

端点基本URI

参数 sambastudio_base_url: str = ''

要使用的Base URL

参数 sambastudio_endpoint_id: str = ''

SambaStudio上的模型端点ID

参数 sambastudio_project_id: str = ''

SambaStudio上的模型项目ID

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

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

默认的批量处理实现适用于I/O密集型可运行对象。

如果子类可以更有效地批量处理,应该重写此方法;例如,如果底层可运行对象使用的API支持批量模式。

参数
  • 输入 (列表[联合[PromptValuestrSequence[联合[BaseMessage列表[str]元组[strstr]strDict[strAny]]]]]]) – Runnable的输入列表。

  • 配置 (可选[联合[RunnableConfig列表[RunnableConfig]]]) – 调用Runnable时使用的配置。配置支持标准键,如用于追踪的‘tags’和‘metadata’,用于控制并行工作量的‘max_concurrency’,以及其他键。请参阅RunnableConfig获取更多详细信息。默认为None。

  • 返回异常 (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,按完成顺序产生结果。

参数
  • 输入 (Sequence[Input]) – Runnable的输入列表。

  • config (可选可联合RunnableConfigSequence[RunnableConfig]]) – 在调用可执行程序时使用的配置。该配置支持标准键,例如用于跟踪的“tags”,'metadata',用于控制并行工作量的“max_concurrency”和其他键。请参阅RunnableConfig以获取更多详细信息。默认为None。

  • 返回异常 (bool) – 是否返回异常而不是抛出它们。默认为False。

  • kwargs (可选任意) – 传递给可执行程序的额外关键字参数。

产生

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

返回类型

异步迭代器[元组(int, 可联合(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的模型进行批处理调用。

当您想
  1. 利用批量调用时,

  2. 需要从模型获得比只是顶级生成值更多的输出时,

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

    类型

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

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

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

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

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

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

  • run_id (可选可联合UUID列表[可选项[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的模型进行批处理调用。

当您想
  1. 利用批量调用时,

  2. 需要从模型获得比只是顶级生成值更多的输出时,

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

    类型

参数
  • prompts (]PromptValue]) – Promp值列表。Promp值是一个可以转换为与任何语言模型匹配的格式的对象(对于纯文本生成模型是字符串,对于聊天模型是BaseMessages)。

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

  • callbacks (可联合列表[BaseCallbackHandler],BaseCallbackManagerNone列表[可选项[可联合(列表[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]]]], Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) str

ainvoke 的默认实现,从线程中调用 invoke。

默认实现允许即使 Runnable 没有实现原生的异步 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(文本: str, *, stop: Optional[序列[str]] = None, **kwargs: Any) str

自版本 langchain-core==0.1.7 已弃用: 使用 ainvoke 代替。

参数
  • text (str) –

  • stop (Optional[序列[str]]) –

  • kwargs (Any) –

返回类型

str

async apredict_messages(messages: List[BaseMessage], *, stop: Optional[序列[str]] = None, **kwargs: Any) BaseMessage

自版本 langchain-core==0.1.7 已弃用: 使用 ainvoke 代替。

参数
  • messages (列表[BaseMessage]) –

  • stop (Optional[序列[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实例。

返回类型

基工具

类型化字典输入

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,提供关于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, …])

除了标准事件之外,用户还可以调度自定义事件(下面有示例)。

自定义事件仅在第 v2 版本的API中可见!

自定义事件具有以下格式:

属性

类型

描述

名称

str

事件的用户定义名称。

数据

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)
参数
  • 输入Any) – Runnable的输入。

  • 配置Optional[RunnableConfig]) – 要用于Runnable的配置。

  • 版本Literal['v1', 'v2']) – 要使用的模式版本,可以是 v2v1。用户应使用 v2v1 用于向后兼容,将在 0.4.0 中弃用。在API稳定之前将不会分配默认值。自定义事件仅在第 v2 中可见。

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

  • include_types (可选 *序列[str] *) - 仅包含具有匹配类型的可运行事件。

  • include_tags (可选 *序列[str] *) - 仅包含具有匹配标记的可运行事件。

  • exclude_names (可选 *序列[str] *) - 排除具有匹配名称的可运行事件。

  • exclude_types (可选 *序列[str] *) - 排除具有匹配类型的可运行事件。

  • exclude_tags (可选 *序列[str] *) - 排除具有匹配标记的可运行事件。

  • kwargs (任何) – 传递给Runnable的额外关键字参数。这些将被传递到astream_log,因为astream_event的实现是基于astream_log。

产生

异步StreamEvent流。

抛出

NotImplementedError – 如果版本不是v1v2

返回类型

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

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

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

默认的批量处理实现适用于I/O密集型可运行对象。

如果子类可以更有效地批量处理,应该重写此方法;例如,如果底层可运行对象使用的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]]]

并行地对输入列表中的调用进行运行,随着调用完成时产出结果。

参数
  • inputs (Sequence[Input]) –

  • config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]) –

  • return_exceptionsbool) –

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

在运行时可以设置的运行能力的备用配置。

参数
  • which (ConfigurableField) – 用于选择备选方案的 ConfigurableField 实例。

  • default_key (str) – 如果未选择备选方案,则使用的默认键。默认为“default”。

  • 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]) – 要配置的 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的模型进行批处理调用。

当您想
  1. 利用批量调用时,

  2. 需要从模型获得比只是顶级生成值更多的输出时,

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

    类型

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

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

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

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

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

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

  • run_id (可选可联合UUID列表[可选项[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的模型进行批处理调用。

当您想
  1. 利用批量调用时,

  2. 需要从模型获得比只是顶级生成值更多的输出时,

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

    类型

参数
  • prompts (]PromptValue]) – Promp值列表。Promp值是一个可以转换为与任何语言模型匹配的格式的对象(对于纯文本生成模型是字符串,对于聊天模型是BaseMessages)。

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

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

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

返回

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

返回类型

LLMResult

get_num_tokens(text: str) int

获取文本中的标记(token)数量。

用于检查输入是否适合模型的环境窗口中。

参数

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列表。

按文本中出现的顺序排列。

返回类型

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 以了解更多详细信息。

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

  • kwargs (Any) –

返回

Runnable 的输出。

返回类型

str

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

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

参数
  • text (str) –

  • stop (Optional[序列[str]]) –

  • kwargs (Any) –

返回类型

str

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

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

参数
  • messages (列表[BaseMessage]) –

  • stop (Optional[序列[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], 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]]

使用 SambaStudio 的示例