langchain_experimental.chat_models.llm_wrapper
.Vicuna¶
注意
Vicuna 实现了标准 Runnable 接口
。🏃
Runnable 接口
有额外的可用方法,例如 with_types
、with_retry
、assign
、bind
、get_graph
以及更多。
- class langchain_experimental.chat_models.llm_wrapper.Vicuna[source]¶
基类:
ChatWrapper
为 Vicuna 风格的模型提供包装。
- param ai_n_beg: str = 'ASSISTANT: '¶
- param ai_n_end: str = ' </s>'¶
- 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 rate_limiter :Optional[BaseRateLimiter] = None¶
用于限制请求数量的可选速率限制器。
- 参数 sys_beg: str = ''¶
- 参数 sys_end: str = ' '¶
- 参数 system_message : SystemMessage = SystemMessage(content="你是 一个 有用、 尊重、 真诚的助手。 在尽可能安全的情况下回答,并提供帮助。 你的回答不应包含任何有害、不道德、种族歧视、性别歧视、有毒、危险或非法的内容。 请确保你的回答在性质上是社会无偏见和积极的。\n\n如果问题没有意义,或者不是事实上的连贯的,解释原因而不是回答不正确的内容。 如果你不知道问题的答案,请不要提供错误信息。")¶
- 参数 tags: Optional[List[str]] = None¶
添加到运行跟踪的标签。
- 参数 usr_0_beg: Optional[str] = None¶
- 参数 usr_0_end: 可选[str] = None¶
- 参数 usr_n_beg: str = 'USER: '¶
- 参数 usr_n_end: str = ' '¶
- 参数 verbose: bool [可选]¶
是否打印输出文本。
- __call__(messages: List[BaseMessage], stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]], **kwargs: Any) BaseMessage ¶
自langchain-core==0.1.7版本弃用: 请使用
invoke
代替。- 参数
messages (列表[BaseMessage]) –
stop (可选[列表[str]]) –
callbacks (可选[Union[列表[BaseCallbackHandler], BaseCallbackManager]]) –
kwargs (任何类型) –
- 返回类型
- async abatch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) List[Output] ¶
默认实现并行运行 run_invoke 使用 asyncio.gather。
批处理默认实现适用于 IO 密集型的可运行对象。
子类应该覆盖此方法,如果它们能够更有效地批处理,例如,如果底层 Runnable 使用支持批处理模式的 API。
- 参数
inputs (列表[Input]) – Runnable 的输入列表。
config (可选[Union[RunnableConfig, 列表[RunnableConfig]]]) – 调用 Runnable 时使用的配置。该配置支持标准的键,如’tags’、’metadata’用于跟踪目的,’max_concurrency’用于控制并行执行的工作量,以及其他键。请参阅 RunnableConfig 以获取更多详细信息。默认为 None。
return_exceptions (bool) – 是否返回异常而不是抛出它们。默认为 False。
kwargs (可选[任何类型]) – 传递给 Runnable 的额外关键字参数。
- 返回
Runnable的输出列表。
- 返回类型
列表[输出]
- async abatch_as_completed(inputs: Sequence[Input], config: Optional[Union[RunnableConfig, Sequence[RunnableConfig]]] = None, **kwargs: Optional[Any]) AsyncIterator[Tuple[int, Union[Output, Exception]]]¶
并行执行列表输入上的runnable,按完成顺序返回结果。
- 参数
inputs (Sequence[Input]) – 可运行的输入列表。
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 启用可运行时使用的配置。该配置支持例如用于跟踪的'tags'、'metadata'等标准键,'max_concurrency'用于控制并行执行的工作量量,以及其他键。请参见RunnableConfig以获取更多详细信息。默认值为None。
return_exceptions (bool) – 是否返回异常而不是抛出它们。默认为 False。
kwargs (可选[任何类型]) – 传递给 Runnable 的额外关键字参数。
- 产出
输入索引和可运行的输出组成的元组。
- 返回类型
AsyncIterator[Tuple[int, Union[Output, Exception]]]
- async agenerate(messages: List[List[BaseMessage]], stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, run_id: Optional[UUID] = None, **kwargs: Any) LLMResult ¶
异步传递一系列提示到一个模型并返回生成结果。
该方法应利用支持批量调用的模型中的批量调用。
- 当您想要
利用批量调用时,请使用此方法。
模型需要比只生成的顶级值更多的输出,
- 正构建对这些底层语言模型类型(例如,纯文本完成模型和聊天模型)盲目无差别的链。
类型。
- 参数
消息(列表[列表[BaseMessage]])- 消息列表的列表。
停止使用(可选[列表[字符串]])- 生成时使用的停止词。模型输出在遇到以上任意子串的第一个位置时截断。
回调(可选[联合[列表[BaseCallbackHandler],BaseCallbackManager]])- 要传递的回调。用于在生成过程中执行额外的功能,例如记录或流式传输。
**kwargs(任意)(Any)- 额外的额外关键字参数。这些通常传递给模型提供商的API调用。
标签(可选[列表[字符串]])-
元数据(可选[字典[字符串,Any]])-
run_name(可选[字符串])-
run_id(可选[UUID])-
**kwargs –
- 返回
- 包含每个输入提示的候选生成列表以及附加模型提供商特定输出的LLMResult。
结果。
- 返回类型
- 异步 agenerate_prompt(prompts: List[PromptValue], stop: Optional[List[str]] = None, callbacks: Optional[联合[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) LLMResult ¶
异步传递一组提示并返回模型生成。
该方法应利用支持批量调用的模型中的批量调用。
- 当您想要
利用批量调用时,请使用此方法。
模型需要比只生成的顶级值更多的输出,
- 正构建对这些底层语言模型类型(例如,纯文本完成模型和聊天模型)盲目无差别的链。
类型。
- 参数
提示 (列表[PromptValue]) – PromptValue 的列表。PromptValue 是一个对象,可以被转换为与任何语言模型匹配的格式(纯文本生成模型的字符串和基消息(BaseMessages)聊天模型)。
停止使用(可选[列表[字符串]])- 生成时使用的停止词。模型输出在遇到以上任意子串的第一个位置时截断。
回调(可选[联合[列表[BaseCallbackHandler],BaseCallbackManager]])- 要传递的回调。用于在生成过程中执行额外的功能,例如记录或流式传输。
**kwargs(任意)(Any)- 额外的额外关键字参数。这些通常传递给模型提供商的API调用。
- 返回
- 包含每个输入提示的候选生成列表以及附加模型提供商特定输出的LLMResult。
结果。
- 返回类型
- async ainvoke(input: LanguageModelInput, config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) BaseMessage¶
ainvoke 的默认实现,从线程中调用 invoke。
默认实现允许即使可运行的 Runnable 没有实现 invoke 的本地异步版本也能使用异步代码。
子类应在能够异步运行时重写此方法。
- 参数
input (LanguageModelInput) –
config (Optional[RunnableConfig]) –
stop (可选[列表[str]]) –
kwargs (任何类型) –
- 返回类型
- 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 (任何类型) –
- 返回类型
str
- async apredict_messages(messages: List[BaseMessage], *, stop: Optional[Sequence[str]] = None, **kwargs: Any) BaseMessage ¶
自 langchain-core==0.1.7 版本以来已弃用: 请使用
ainvoke
代替。- 参数
messages (列表[BaseMessage]) –
stop (Optional[Sequence[str]]) –
kwargs (任何类型) –
- 返回类型
- 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 (可选 [ str ]) – 工具的名称。默认为 None。
description (可选 [ str ]) – 工具的描述。默认为 None。
arg_types (可选 [ Dict [字符串 , 类型 ] ]) – 参数名称到类型的字典。默认为 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: LanguageModelInput, config: Optional[RunnableConfig], *, stop: Optional[List[str]], **kwargs: Any) AsyncIterator[BaseMessageChunk]
默认的 astream 实现,它调用 ainvoke。子类应该覆盖此方法以支持流式输出。
- 参数
input (LanguageModelInput) – Runnable 的输入。
config (可选 [ RunnableConfig ]) – 用作 Runnable 的配置。默认为 None。
kwargs (Any) – 传递给 Runnable 的其他关键字参数。
stop (可选[列表[str]]) –
- 产出
Runnable 的输出。
- 返回类型
异步迭代器[BaseMessageChunk]
- 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, …])
除了标准事件之外,用户还可以分发自定义事件(见下面的示例)。
自定义事件仅在API的V2版本中公开!
自定义事件的格式如下
属性
类型
描述
名称
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)
- 参数
input (Any) – Runnable的输入。
config (Optional[RunnableConfig]) – 要为Runnable使用配置。
版本 (文字]['v1', 'v2'rove]) - 要使用的模式版本,可以是 v2 或 v1。用户应使用 v2。 v1 用于向后兼容,将在 0.4.0 版中弃用。直到 API 稳定前将不会分配默认版本。自定义事件仅在 v2 中可见。
include_names (可选[序列[str]]) - 仅包含具有匹配名称的可运行事件。
include_types (可选[序列[str]]) - 仅包含具有匹配类型的事件。
include_tags (可选[序列[str]]) - 仅包含具有匹配标签的事件。
exclude_names (可选[序列[str]]) - 排除具有匹配名称的事件。
exclude_types (可选[序列[str]]) - 排除具有匹配类型的事件。
exclude_tags (可选[序列[str]]) - 排除具有匹配标签的事件。
kwargs (任何) - 传递给 Runnable 的额外关键字参数。这些将被传递到 astream_log,因为 astream_events 的实现基于 astream_log。
- 产出
StreamEvents 的异步流。
- 引发
NotImplementedError - 如果版本不是 v1 或 v2。
- 返回类型
AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]
- batch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) List[Output] ¶
默认实现使用线程池执行器并行调用 invoke。
批处理默认实现适用于 IO 密集型的可运行对象。
子类应该覆盖此方法,如果它们能够更有效地批处理,例如,如果底层 Runnable 使用支持批处理模式的 API。
- 参数
inputs (列表[Input]) -
config (可选[联合[RunnableConfig,列表[RunnableConfig]]]) -
return_exceptions (布尔值) -
kwargs (可选[任何]) -
- 返回类型
列表[输出]
- batch_as_completed(inputs: 序列[输入], config: Optional[Union[RunnableConfig, 序列[RunnableConfig]]], *, return_exceptions: 布尔值 = False, **kwargs: Optional[任何]) 迭代器[元组[int,Union[输出,异常]]]¶
并行在输入列表上运行调用,等待结果完成时产生。
- 参数
inputs (序列[输入]) -
config (可选[联合[RunnableConfig,序列[RunnableConfig]]]) -
return_exceptions (布尔值) -
kwargs (可选[任何]) -
- 返回类型
元组[元组[int,Union[Output,Exception]]]
- bind_tools(tools: Sequence[Union[Dict[str, Any], Type, Callable, BaseTool]], **kwargs: Any) Runnable[LanguageModelInput, BaseMessage] ¶
- 参数
tools (序列[联合[字典[字符串, 任何]
kwargs (任何类型) –
- 返回类型
可运行对象[LanguageModelInput, BaseMessage]
- call_as_llm(message: str, stop: Optional[List[str]] = None, **kwargs: Any) str ¶
自langchain-core==0.1.7版本弃用: 请使用
invoke
代替。- 参数
message (str) -
stop (可选[列表[str]]) –
kwargs (任何类型) –
- 返回类型
str
- 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 (字符串) – 未选择任何可选方案时使用的基本键。默认为“默认”。
prefix_keys (布尔值) – 是否在键前加上 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(messages: List[List[BaseMessage]], stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, run_id: Optional[UUID] = None, *kwargs: Any) LLMResult ¶
将一系列提示传递给模型并返回模型生成的内容。
该方法应利用支持批量调用的模型中的批量调用。
- 当您想要
利用批量调用时,请使用此方法。
模型需要比只生成的顶级值更多的输出,
- 正构建对这些底层语言模型类型(例如,纯文本完成模型和聊天模型)盲目无差别的链。
类型。
- 参数
消息(列表[列表[BaseMessage]])- 消息列表的列表。
停止使用(可选[列表[字符串]])- 生成时使用的停止词。模型输出在遇到以上任意子串的第一个位置时截断。
回调(可选[联合[列表[BaseCallbackHandler],BaseCallbackManager]])- 要传递的回调。用于在生成过程中执行额外的功能,例如记录或流式传输。
**kwargs(任意)(Any)- 额外的额外关键字参数。这些通常传递给模型提供商的API调用。
标签(可选[列表[字符串]])-
元数据(可选[字典[字符串,Any]])-
run_name(可选[字符串])-
run_id(可选[UUID])-
**kwargs –
- 返回
- 包含每个输入提示的候选生成列表以及附加模型提供商特定输出的LLMResult。
结果。
- 返回类型
- generate_prompt(prompts: List[PromptValue], stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) LLMResult
将一系列提示传递给模型并返回模型生成的内容。
该方法应利用支持批量调用的模型中的批量调用。
- 当您想要
利用批量调用时,请使用此方法。
模型需要比只生成的顶级值更多的输出,
- 正构建对这些底层语言模型类型(例如,纯文本完成模型和聊天模型)盲目无差别的链。
类型。
- 参数
提示 (列表[PromptValue]) – PromptValue 的列表。PromptValue 是一个对象,可以被转换为与任何语言模型匹配的格式(纯文本生成模型的字符串和基消息(BaseMessages)聊天模型)。
停止使用(可选[列表[字符串]])- 生成时使用的停止词。模型输出在遇到以上任意子串的第一个位置时截断。
回调(可选[联合[列表[BaseCallbackHandler],BaseCallbackManager]])- 要传递的回调。用于在生成过程中执行额外的功能,例如记录或流式传输。
**kwargs(任意)(Any)- 额外的额外关键字参数。这些通常传递给模型提供商的API调用。
- 返回
- 包含每个输入提示的候选生成列表以及附加模型提供商特定输出的LLMResult。
结果。
- 返回类型
- get_num_tokens(text: str) int
获取文本中存在的令牌数量。
用于检查输入是否适合模型的上下文窗口。
- 参数
text (str) – 要进行分词的字符串输入。
- 返回
文本中令牌的整数数量。
- 返回类型
int
- get_num_tokens_from_messages(messages: List[BaseMessage]) int
获取消息中的令牌数量。
用于检查输入是否适合模型的上下文窗口。
- 参数
messages (List[BaseMessage]) – 要进行分词的消息输入。
- 返回
消息中令牌数量的总和。
- 返回类型
int
- get_token_ids(text: str) List[int]
返回文本中标记的有序ID。
- 参数
text (str) – 要进行分词的字符串输入。
- 返回
- 与文本中标记对应的一组ID列表,按照它们在文本中出现的顺序。
- 返回类型
列表[整型]
- 调用来调用(input: LanguageModelInput, config: Optional[RunnableConfig] = None, **kwargs: Any) BaseMessage ¶
将单个输入转换为输出。重写以实现。
- 参数
input (LanguageModelInput) – Runnable 的输入。
config (Optional[RunnableConfig]) – 用于调用Runnable时使用的配置。该配置支持标准键如‘tags’,‘metadata’(用于跟踪目的),‘max_concurrency’(用于控制并行执行的工作量)以及其他键。请参阅RunnableConfig获取更多详细信息。
stop (可选[列表[str]]) –
kwargs (任何类型) –
- 返回
Runnable 的输出。
- 返回类型
- 预测(text: str, **kwargs: Any) str ¶
自langchain-core==0.1.7版本弃用: 请使用
invoke
代替。- 参数
text (str) –
stop (Optional[Sequence[str]]) –
kwargs (任何类型) –
- 返回类型
str
- predict_messages(messages: List[BaseMessage], *, stop: Optional[Sequence[str]] = None, **kwargs: Any) BaseMessage ¶
自langchain-core==0.1.7版本弃用: 请使用
invoke
代替。- 参数
messages (列表[BaseMessage]) –
stop (Optional[Sequence[str]]) –
kwargs (任何类型) –
- 返回类型
- stream(input: LanguageModelInput, config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) Iterator[BaseMessageChunk] ¶
stream的默认实现,调用invoke。子类应覆盖此方法以支持流式输出。
- 参数
input (LanguageModelInput) – Runnable 的输入。
config (可选 [ RunnableConfig ]) – 用作 Runnable 的配置。默认为 None。
kwargs (Any) – 传递给 Runnable 的其他关键字参数。
stop (可选[列表[str]]) –
- 产出
Runnable 的输出。
- 返回类型
Iterator[BaseMessageChunk]
- with_structured_output(schema: Union[Dict, Type], *, include_raw: bool = False, **kwargs: Any) Runnable[LanguageModelInput, Union[Dict, BaseModel]] ¶
返回符合给定模式的输出的模型包装器。
- 参数
schema (Union[Dict, Type]) –
- 输出模式。可以传入
一个OpenAI函数/工具模式,
一个JSON Schema,
一个TypedDict类(支持从0.2.26开始),
或一个Pydantic类。
如果
schema
是一个Pydantic类,则模型输出将是该类的一个Pydantic实例,模型生成的字段将由Pydantic类进行验证。否则,模型输出将是一个字典,不会进行验证。有关如何在指定Pydantic或TypedDict类时正确指定模式字段的类型和描述的更多信息,请参阅langchain_core.utils.function_calling.convert_to_openai_tool()
。自版本0.2.26以来已更改: 添加对TypedDict类的支持。
(布尔值) – 如果设置为False,则只返回解析后的结构化输出。如果在模型输出解析期间发生错误,则将引发错误。如果设置为True,则返回原始模型响应(一个BaseMessage)和解析后的模型响应。如果在解析输出时发生错误,它将被捕获并作为错误返回。最终输出始终是一个字典,键为“raw”、“parsed”和“parsing_error”。 kwargs (任何类型) –
- 返回
一个可执行的类,它接受与langchain_core.language_models.chat.BaseChatModel相同的输入。
如果include_raw为False且schema是Pydantic类,Runnable将输出schema的实例(即Pydantic对象)。
否则,如果include_raw为False,Runnable则输出一个字典。
- 如果include_raw为True,Runnable输出一个字典,键包括:
"raw":BaseMessage
"parsed":如果有解析错误,则为None,否则类型取决于上述描述的schema。
"parsing_error":(可选)BaseException
- 返回类型
Runnable[LanguageModelInput, Union[Dict, langchain_experimental.video_captioning.models.BaseModel]]
- 示例:Pydantic schema(include_raw=False)
from langchain_core.pydantic_v1 import BaseModel class AnswerWithJustification(BaseModel): '''An answer to the user question along with justification for the answer.''' answer: str justification: str llm = ChatModel(model="model-name", temperature=0) structured_llm = llm.with_structured_output(AnswerWithJustification) structured_llm.invoke("What weighs more a pound of bricks or a pound of feathers") # -> AnswerWithJustification( # answer='They weigh the same', # justification='Both a pound of bricks and a pound of feathers weigh one pound. The weight is the same, but the volume or density of the objects may differ.' # )
- 示例:Pydantic schema(include_raw=True)
from langchain_core.pydantic_v1 import BaseModel class AnswerWithJustification(BaseModel): '''An answer to the user question along with justification for the answer.''' answer: str justification: str llm = ChatModel(model="model-name", temperature=0) structured_llm = llm.with_structured_output(AnswerWithJustification, include_raw=True) structured_llm.invoke("What weighs more a pound of bricks or a pound of feathers") # -> { # 'raw': AIMessage(content='', additional_kwargs={'tool_calls': [{'id': 'call_Ao02pnFYXD6GN1yzc0uXPsvF', 'function': {'arguments': '{"answer":"They weigh the same.","justification":"Both a pound of bricks and a pound of feathers weigh one pound. The weight is the same, but the volume or density of the objects may differ."}', 'name': 'AnswerWithJustification'}, 'type': 'function'}]}), # 'parsed': AnswerWithJustification(answer='They weigh the same.', justification='Both a pound of bricks and a pound of feathers weigh one pound. The weight is the same, but the volume or density of the objects may differ.'), # 'parsing_error': None # }
- 示例:Dict schema(include_raw=False)
from langchain_core.pydantic_v1 import BaseModel from langchain_core.utils.function_calling import convert_to_openai_tool class AnswerWithJustification(BaseModel): '''An answer to the user question along with justification for the answer.''' answer: str justification: str dict_schema = convert_to_openai_tool(AnswerWithJustification) llm = ChatModel(model="model-name", temperature=0) structured_llm = llm.with_structured_output(dict_schema) structured_llm.invoke("What weighs more a pound of bricks or a pound of feathers") # -> { # 'answer': 'They weigh the same', # 'justification': 'Both a pound of bricks and a pound of feathers weigh one pound. The weight is the same, but the volume and density of the two substances differ.' # }