langchain_community.llms.solar
.Solar¶
备注
太阳能实现了标准 Runnable Interface
. 🏃
Runnable Interface
有一些额外的可用方法,比如 with_types
、with_retry
、assign
、bind
、get_graph
等。
- class langchain_community.llms.solar.Solar[source]¶
Bases:
SolarCommon
,LLM
太阳能大型语言模型。
使用时,您应该在环境中设置
SOLAR_API_KEY
变量,使用您的 API 密钥。详细信息见https://console.upstage.ai/services/solar- param base_url: str = 'https://api.upstage.ai/v1/solar'¶
- param cache: Union[BaseCache, bool, None] = None¶
是否缓存响应。
如果为 true,将使用全局缓存。
如果为 false,则不使用缓存。
如果为 None,则在设置全局缓存的情况下使用全局缓存,否则不使用缓存。
如果是 BaseCache 的实例,将使用提供的缓存。
当前模型流式方法不支持缓存。
- 参数 callback_manager: 可选[BaseCallbackManager] = None¶
[已弃用]
- 参数 callbacks :Callbacks = None¶
要添加到运行跟踪的回调函数。
- 参数 custom_get_token_ids :可选[Callable[[str], List[int]]] = None¶
用于计数令牌的可选编码器。
- 参数 max_tokens :int = 1024¶
- 参数 metadata :可选[Dict[str, Any]] = None¶
添加到运行跟踪的元数据。
- 参数 model_name :str = 'solar-1-mini-chat' (别称 'model')¶
模型名称。可用的模型在此处列出:https://console.upstage.ai/services/solar
- 参数 solar_api_key :可选[SecretStr] = None (别称 'api_key')¶
Solar API密钥。在此获取:https://console.upstage.ai/services/solar
- 约束
类型 = 字符串
writeOnly = 读取阻止
格式 = 密码
- 参数 tags: 可选[字符串列表] = None¶
添加到运行跟踪的标记。
- 参数 temperature: 浮点数 = 0.3¶
- 参数 verbose: 布尔型 [可选]¶
是否打印出响应文本。
- __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 – 如果提示不是字符串。
- 返回类型
字符串
- 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) List[str]¶
默认实现使用asyncio.guild并行运行ainvoke。
默认实现的批处理对于I/O密集型runnables效果良好。
如果子类能够更有效地批量操作,则应该重写此方法;例如,如果底层runnable使用支持批量模式的API。
- 参数
inputs (列表[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]]) – Runnable的输入列表。
config (可选[联合[RunnableConfig,列表[RunnableConfig]]]) – 运行时可使用的配置。该配置支持标准键,如用于跟踪的’tags’和’metadata’,用于控制并行工作的‘max_concurrency’以及其他键。请参阅RunnableConfig获取更多详细信息。默认值为None。
return_exceptions (布尔值) – 是否返回异常而不是引发它们。默认值为False。
kwargs (任何类型) – 传递给Runnable的额外关键字参数。
- 返回
Runnable的输出列表。
- 返回类型
字符串列表
- 异步 abatch_as_completed(inputs: 序列[输入], config: 可选[联合[RunnableConfig, 序列[RunnableConfig]]] = None, *, return_exceptions: 布尔值 = False, **kwargs: 可选[任何类型]) 异步迭代器[元组[整数, 联合[输出, 异常]]]¶
并行地对输入列表执行ainvoke,按完成顺序产生结果。
- 参数
inputs (序列[输入]) – Runnable的输入列表。
config (可选[联合[RunnableConfig,序列[RunnableConfig]]]) – 运行时可使用的配置。该配置支持标准键,如用于跟踪的’tags’和’metadata’,用于控制并行工作的‘max_concurrency’以及其他键。请参阅RunnableConfig获取更多详细信息。默认值为None。
return_exceptions (布尔值) – 是否返回异常而不是引发它们。默认值为False。
kwargs (可选[任意类型]) – 传递给 Runnable 的额外关键字参数。
- 生成项
Runnable 输入索引和输出的元组。
- 返回类型
一个异步迭代器[元组[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 ¶
异步地传递一个提示序列到模型并返回生成内容。
当模型提供批量 API 时,此方法应该利用批量调用来执行。
- 当您希望
利用批量调用,
需要模型输出的内容比仅顶部生成的值更多,
- 构建的是对底层语言模型类型(例如,纯文本完成模型与聊天模型)无感知的链路
类型时,请使用此方法。
- 参数
prompts (字符串列表) – 字符串提示列表。
stop (Optional[List[str]]) – 生成时使用的停用词。模型输出将在第一次出现这些子字符串之一时被截断。
callbacks (联合类型[字符串列表[BaseCallbackHandler], BaseCallbackManager, None, 字符串列表[可选类型[联合类型[字符串列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。在整个生成过程中用于执行额外的功能,如记录或流。
tags (可选[联合类型[字符串列表, 字符串列表列表]]]) – 与每个提示关联的标签列表。如果有提供,列表的长度必须与提示列表的长度匹配。
metadata (可选[联合类型[字典[字符串,任意类型], 字典列表[字典[字符串,任意类型]]]]) – 与每个提示关联的元数据字典列表。如果有提供,列表的长度必须与提示列表的长度匹配。
run_name (可选[联合类型[字符串, 字符串列表]]) – 与每个提示关联的运行名称列表。如果有提供,列表的长度必须与提示列表的长度匹配。
run_id (可选[联合类型[UUID, 可选类型[UUID]]]) – 与每个提示关联的运行 ID 列表。如果有提供,列表的长度必须与提示列表的长度匹配。
**kwargs (Any) – 随意额外的关键字参数。这些通常传递给模型提供者API调用。
- 返回
- 一个包含每个输入提示的候选生成列表以及额外模型提供商特定输出的 LLMResult。
- 返回类型
- async agenerate_prompt(prompts: List[PromptValue], stop: Optional[List[str]] = None, callbacks: Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]]] = None, **kwargs: Any) LLMResult¶
异步传递一组提示并返回模型生成。
当模型提供批量 API 时,此方法应该利用批量调用来执行。
- 当您希望
利用批量调用,
需要模型输出的内容比仅顶部生成的值更多,
- 构建的是对底层语言模型类型(例如,纯文本完成模型与聊天模型)无感知的链路
类型时,请使用此方法。
- 参数
prompts (列表[PromptValue]) – 一组 PromptValue 对象。PromptValue 对象可以转换为匹配任何语言模型的格式(纯文本生成模型的字符串和聊天模型的 BaseMessages)。
stop (Optional[List[str]]) – 生成时使用的停用词。模型输出将在第一次出现这些子字符串之一时被截断。
callbacks (联合类型[字符串列表[BaseCallbackHandler], BaseCallbackManager, None, 字符串列表[可选类型[联合类型[字符串列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。在整个生成过程中用于执行额外的功能,如记录或流。
**kwargs (Any) – 随意额外的关键字参数。这些通常传递给模型提供者API调用。
- 返回
- 一个包含每个输入提示的候选生成列表以及额外模型提供商特定输出的 LLMResult。
- 返回类型
- async ainvoke(input: Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) str ¶
ainvoke的默认实现,通过线程调用invoke。
默认实现允许即使Runnable没有实现invoke的本地异步版本,也可以使用异步代码。
子类应该如果能够异步运行的话,重写此方法。
- 参数
输入 (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) –
配置 (Optional[RunnableConfig]) –
停止 (Optional[List[str]]) –
kwargs (Any) –
- 返回类型
字符串
- 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) –
- 返回类型
- 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
将从可运行的类中实例化一个带有名称、描述和args_schema
的BaseTool。尽可能情况下,模式从runnable.get_input_schema
推断。另可直接使用args_schema
指定模式。您还可以通过传递arg_types
来仅指定必须的参数和它们的类型。- 参数
args_schema (可选[Type[BaseModel]]) – 工具的规范。默认为None。
name (可选[字符串]) - 工具的名称。默认为None。
description (可选[字符串]) - 工具的描述。默认为None。
arg_types (可选[字典[字符串, 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 (任何类型) – 传递给Runnable的额外关键字参数。
停止 (Optional[List[str]]) –
- 生成项
Runnable 的输出。
- 返回类型
AsyncIterator[str]
- astream_events(input: Any, config: Optional[RunnableConfig] = None, *, version: Literal['v1', 'v2'], include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[Sequence[str]] = None, exclude_names: Optional[Sequence[str]] = None, exclude_types: Optional[Sequence[str]] = None, exclude_tags: Optional[Sequence[str]] = None, **kwargs: Any) AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]] ¶
Beta
本API处于测试阶段,未来可能会发生变化。
生成事件流。
用于创建一个迭代器,遍历提供有关 Runnable 进展的实时信息的 StreamEvents,包括中间结果的 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版本中呈现!
自定义事件具有以下格式
属性
类型
描述
名称
字符串
事件的用户定义名称。
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 (Optional[Sequence[str]]) – 仅包括具有匹配类型的runnables的事件。
include_tags (Optional[Sequence[str]]) – 仅包括具有匹配标签的runnables的事件。
exclude_names (Optional[Sequence[str]]) – 排除具有匹配名称的runnables的事件。
exclude_types (可选[字符串序列[str]]) – 排除匹配类型的可运行对象的事件。
exclude_tags (可选[字符串序列[str]]) – 排除匹配标签的可运行对象的事件。
kwargs (任何类型) – 传递给可运行对象的额外关键字参数。这些参数将传递给astype_log,因为astype_events的实现是基于astype_log。
- 生成项
一个异步的StreamEvents流。
- 抛出
NotImplementedError – 如果版本不是v1或v2。
- 返回类型
AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]
- batch(inputs: List[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]], Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]], str, Dict[str, Any]]]] = None, *, return_exceptions: bool = False, **kwargs: Any) List[str] ¶
默认实现使用线程池执行器并行运行 invoke。
默认实现的批处理对于I/O密集型runnables效果良好。
如果子类能够更有效地批量操作,则应该重写此方法;例如,如果底层runnable使用支持批量模式的API。
- 参数
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) –
kwargs (Any) –
- 返回类型
字符串列表
- 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_exceptions (bool) –
kwargs (Optional[Any]) –
- 返回类型
Iterator[Tuple[int, Union[Output, Exception]]]
- configurable_alternatives(which: ConfigurableField, *args, default_key: str = 'default', prefix_keys: bool = False, **kwargs) RunnableSerializable[Input, Output] ¶
配置可在运行时设置的Runnables的替代方案。
- 参数
which (ConfigurableField) – 用于选择替代方案的ConfigurableField实例。
default_key (str) – 如果未选择替代方案,则使用默认键。默认为“default”。
prefix_keys (bool) – 是否将键前缀与ConfigurableField id相连接。默认为False。
**kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到Runnable实例或返回Runnable实例的可调用对象字典。
- 返回
配置了替代方案的新Runnable。
- 返回类型
RunnableSerializable[Input, Output]
from langchain_anthropic import ChatAnthropic from langchain_core.runnables.utils import ConfigurableField from langchain_openai import ChatOpenAI model = ChatAnthropic( model_name="claude-3-sonnet-20240229" ).configurable_alternatives( ConfigurableField(id="llm"), default_key="anthropic", openai=ChatOpenAI() ) # uses the default model ChatAnthropic print(model.invoke("which organization created you?").content) # uses ChatOpenAI print( model.with_config( configurable={"llm": "openai"} ).invoke("which organization created you?").content )
- configurable_fields(**kwargs: Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) RunnableSerializable[Input, Output]¶
在运行时配置特定的Runnable字段。
- 参数
**kwargs (Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) – 一个包含可配置字段的字典,用于配置。
- 返回
配置字段后生成的新的Runnable。
- 返回类型
RunnableSerializable[Input, Output]
from langchain_core.runnables import ConfigurableField from langchain_openai import ChatOpenAI model = ChatOpenAI(max_tokens=20).configurable_fields( max_tokens=ConfigurableField( id="output_token_number", name="Max tokens in the output", description="The maximum number of tokens in the output", ) ) # max_tokens = 20 print( "max_tokens_20: ", model.invoke("tell me something about chess").content ) # max_tokens = 200 print("max_tokens_200: ", model.with_config( configurable={"output_token_number": 200} ).invoke("tell me something about chess").content )
- generate(prompts: List[str], stop: Optional[List[str]] = None, callbacks: Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]]] = None, *, tags: Optional[Union[List[str], List[List[str]]]] = None, metadata: Optional[Union[Dict[str, Any], List[Dict[str, Any]]]] = None, run_name: Optional[Union[str, List[str]]] = None, run_id: Optional[Union[UUID, List[Optional[UUID]]]] = None, **kwargs: Any) LLMResult ¶
将一系列提示传递给模型并返回生成的内容。
当模型提供批量 API 时,此方法应该利用批量调用来执行。
- 当您希望
利用批量调用,
需要模型输出的内容比仅顶部生成的值更多,
- 构建的是对底层语言模型类型(例如,纯文本完成模型与聊天模型)无感知的链路
类型时,请使用此方法。
- 参数
prompts (字符串列表) – 字符串提示列表。
stop (Optional[List[str]]) – 生成时使用的停用词。模型输出将在第一次出现这些子字符串之一时被截断。
callbacks (联合类型[字符串列表[BaseCallbackHandler], BaseCallbackManager, None, 字符串列表[可选类型[联合类型[字符串列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。在整个生成过程中用于执行额外的功能,如记录或流。
tags (可选[联合类型[字符串列表, 字符串列表列表]]]) – 与每个提示关联的标签列表。如果有提供,列表的长度必须与提示列表的长度匹配。
metadata (可选[联合类型[字典[字符串,任意类型], 字典列表[字典[字符串,任意类型]]]]) – 与每个提示关联的元数据字典列表。如果有提供,列表的长度必须与提示列表的长度匹配。
run_name (可选[联合类型[字符串, 字符串列表]]) – 与每个提示关联的运行名称列表。如果有提供,列表的长度必须与提示列表的长度匹配。
run_id (可选[联合类型[UUID, 可选类型[UUID]]]) – 与每个提示关联的运行 ID 列表。如果有提供,列表的长度必须与提示列表的长度匹配。
**kwargs (Any) – 随意额外的关键字参数。这些通常传递给模型提供者API调用。
- 返回
- 一个包含每个输入提示的候选生成列表以及额外模型提供商特定输出的 LLMResult。
- 返回类型
- generate_prompt(prompts: List[PromptValue], stop: Optional[List[str]] = None, callbacks: Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]]] = None, **kwargs: Any) LLMResult ¶
将一系列提示传递给模型,并返回模型的生成结果。
当模型提供批量 API 时,此方法应该利用批量调用来执行。
- 当您希望
利用批量调用,
需要模型输出的内容比仅顶部生成的值更多,
- 构建的是对底层语言模型类型(例如,纯文本完成模型与聊天模型)无感知的链路
类型时,请使用此方法。
- 参数
prompts (列表[PromptValue]) – 一组 PromptValue 对象。PromptValue 对象可以转换为匹配任何语言模型的格式(纯文本生成模型的字符串和聊天模型的 BaseMessages)。
stop (Optional[List[str]]) – 生成时使用的停用词。模型输出将在第一次出现这些子字符串之一时被截断。
callbacks (联合类型[字符串列表[BaseCallbackHandler], BaseCallbackManager, None, 字符串列表[可选类型[联合类型[字符串列表[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 (列表[BaseMessage]) – 要进行标记化的消息输入。
- 返回
消息中标记数之和。
- 返回类型
int
- get_token_ids(text: str) List[int] ¶
返回文本中标记的有序ID。
- 参数
text (str) – 需要分词的字符串输入。
- 返回
- 与文本中的标记对应的ID列表,按其在文本中出现的顺序。
文本中标记的ID列表。
- 返回类型
整数列表
- 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以获取更多信息。
停止 (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) –
- 返回类型
- save(file_path: Union[Path, str]) None ¶
保存LLM。
- 参数
file_path (Union[][]) – 保存LLM的文件路径。
- 抛出
ValueError – 如果文件路径不是字符串或Path对象。
- 返回类型
None
示例: .. code-block:: python
llm.save(file_path="path/llm.yaml")
- stream(input: Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) Iterator[str] ¶
stream的默认实现,调用invoke。子类应覆盖此方法以支持流式输出。
- 参数
input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – Runnable 的输入。
config (Optional[RunnableConfig]) – 用于 Runnable 的配置。默认为 None。
kwargs (任何类型) – 传递给Runnable的额外关键字参数。
停止 (Optional[List[str]]) –
- 生成项
Runnable 的输出。
- 返回类型
str[]
- to_json() Union[SerializedConstructor, SerializedNotImplemented] ¶
将Runnable序列化为JSON。
- with_structured_output(schema: Union[Dict, Type[BaseModel]], **kwargs: Any) Runnable[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], Union[Dict, BaseModel]]¶
此类未实现。
- 参数
schema (Union[Dict, Type[BaseModel]]) –
kwargs (Any) –
- 返回类型
Runnable[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], Union[Dict, BaseModel]]