`langchain_community.callbacks.upstash_ratelimit_callback`.UpstashRatelimitHandler¶

class langchain_community.callbacks.upstash_ratelimit_callback.UpstashRatelimitHandler(identifier: str, *, token_ratelimit: None = None, request_ratelimit: None = None, include_output_tokens: bool = False)[源代码]¶

根据请求数量或输入中的令牌数量处理速率限制的回调。

它使用Upstash Ratelimit来跟踪速率限制，该速率限制利用Upstash Redis来跟踪状态。

在初始化链时，不应将其传递到链中。这是因为处理程序有一个状态，每次调用时应保持新鲜。相反，每次调用时都初始化并传递一个处理程序。

创建UpstashRatelimitHandler。必须传递一个标识符，类似于用户ID或IP地址。

此外，必须传递至少一个token_ratelimit或request_ratelimit参数。

参数

联合：int (identifier) - 标识符
str：标识符
可选：Ratelimit：request_ratelimit - 限制令牌数量的速率限制。仅与OpenAI模型协同工作，因为只有这些模型在其输出中提供令牌数量作为信息。
可选：Ratelimit：- 限制请求数量的速率限制
bool (include_output_tokens) - 在根据令牌数量进行速率限制时是否计数输出令牌。仅在传递token_ratelimit时使用。默认值为False。
identifier (str) -
token_ratelimit (None) -
request_ratelimit (None) -
include_output_tokens (bool) -

示例

from upstash_redis import Redis
from upstash_ratelimit import Ratelimit, FixedWindow

redis = Redis.from_env()
ratelimit = Ratelimit(
    redis=redis,
    # fixed window to allow 10 requests every 10 seconds:
    limiter=FixedWindow(max_requests=10, window=10),
)

user_id = "foo"
handler = UpstashRatelimitHandler(
    identifier=user_id,
    request_ratelimit=ratelimit
)

# Initialize a simple runnable to test
chain = RunnableLambda(str)

# pass handler as callback:
output = chain.invoke(
    "input",
    config={
        "callbacks": [handler]
    }
)

属性

`ignore_agent`	是否忽略代理回调。
`ignore_chain`	是否忽略链回调。
`ignore_chat_model`	是否忽略聊天模型回调。
`ignore_custom_event`	忽略自定义事件。
`ignore_llm`	是否忽略LLM回调。
`ignore_retriever`	是否忽略检索器回调。
`ignore_retry`	是否忽略重试回调。
`raise_error`	是否在出现异常时引发错误。
`run_inline`	是否以内联方式运行回调。

方法

`__init__`(identifier, *[, token_ratelimit, ...])	创建UpstashRatelimitHandler。
`on_agent_action`(action, *, run_id[, ...])	在代理操作上运行。
`on_agent_finish`(finish, *, run_id[, ...])	在代理端运行。
`on_chain_end`(outputs, *, run_id[, parent_run_id])	当链结束时运行。
`on_chain_error`(error, *, run_id[, parent_run_id])	当链出错时运行。
`on_chain_start`(serialized, inputs, **kwargs)	当链开始运行时运行。
`on_chat_model_start`(serialized, messages, *, ...)	当聊天模型开始运行时运行。
`on_custom_event`(name, data, *, run_id[, ...])	覆盖以定义对自定义事件的处理程序。
`on.llm_end`(response, **kwargs)	当LLM运行结束时运行。
`on_llm_error`(error, *, run_id[, parent_run_id])	当LLM出错时运行。
`on_llm_new_token`(token, *[, chunk, ...])	当新LLM令牌出现时运行。
`on_llm_start`(serialized, prompts, **kwargs)	当LLM开始运行时运行。
`on_retriever_end`(documents, *, run_id[, ...])	当Retriever运行结束时运行。
`on_retriever_error`(error, *, run_id[, ...])	当Retriever出错时运行。
`on_retriever_start`(serialized, query, *, run_id)	当Retriever开始运行时运行。
`on_retry`(retry_state, *, run_id[, parent_run_id])	在重试事件上运行。
`on_text`(text, *, run_id[, parent_run_id])	在任意文本上运行。
`on_tool_end`(output, *, run_id[, parent_run_id])	在工具运行结束时运行。
`on_tool_error`(error, *, run_id[, parent_run_id])	在工具出错时运行。
`on_tool_start`(serialized, input_str, *, run_id)	在工具开始运行时运行。
`reset`([identifier])	如果提供了标识符，创建一个新的 UpstashRatelimitHandler 对象，但具有相同的速率限制配置。

__init__(identifier: str, *, token_ratelimit: None = None, request_ratelimit: None = None, include_output_tokens: bool = False)[source]¶

创建UpstashRatelimitHandler。必须传递一个标识符，类似于用户ID或IP地址。

此外，必须传递至少一个token_ratelimit或request_ratelimit参数。

参数

联合：int (identifier) - 标识符
str：标识符
可选：Ratelimit：request_ratelimit - 限制令牌数量的速率限制。仅与OpenAI模型协同工作，因为只有这些模型在其输出中提供令牌数量作为信息。
可选：Ratelimit：- 限制请求数量的速率限制
bool (include_output_tokens) - 在根据令牌数量进行速率限制时是否计数输出令牌。仅在传递token_ratelimit时使用。默认值为False。
identifier (str) -
token_ratelimit (None) -
request_ratelimit (None) -
include_output_tokens (bool) -

示例

from upstash_redis import Redis
from upstash_ratelimit import Ratelimit, FixedWindow

redis = Redis.from_env()
ratelimit = Ratelimit(
    redis=redis,
    # fixed window to allow 10 requests every 10 seconds:
    limiter=FixedWindow(max_requests=10, window=10),
)

user_id = "foo"
handler = UpstashRatelimitHandler(
    identifier=user_id,
    request_ratelimit=ratelimit
)

# Initialize a simple runnable to test
chain = RunnableLambda(str)

# pass handler as callback:
output = chain.invoke(
    "input",
    config={
        "callbacks": [handler]
    }
)

on_agent_action(action: AgentAction, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在代理操作上运行。

参数

action (AgentAction) – 代理动作。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在代理端运行。

参数

finish (AgentFinish) – 代理完成。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

当链结束时运行。

参数

outputs (Dict[str, Any]) – 链的输出。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_chain_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

当链出错时运行。

参数

error (BaseException) – 发生的错误。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any) → Any[source]¶

当链开始运行时运行。

on_chain_start 会在链执行过程中多次运行。为了确保它只被调用一次，我们保持一个布尔状态 _checked。如果没有 self._checked，我们将使用 request_ratelimit 调用限制，并在标识符被限制速率时抛出 UpstashRatelimitError。

参数

序列化 (Dict[str, Any]) –
输入参数 (Dict[str, Any]) –
kwargs (Any) –

返回类型

Any

on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], *args, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs) → Any¶

当聊天模型开始运行时运行。

注意：此方法用于聊天模型。如果您正在实现: 非聊天模型的处理程序，则应使用 on_llm_start。

参数

序列化 (Dict[str, Any]) – 序列化的聊天模型。
消息 (List[List[BaseMessage]]) – 消息。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
标签 (Optional[List[str]]) – 标签。
元数据 (Optional[Dict[str, Any]]) – 元数据。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_custom_event(name: str, data: Any, *, run_id: UUID, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any¶

覆盖以定义对自定义事件的处理程序。

参数

name (str) – 自定义事件的名称。
data (Any) – 自定义事件的数据。格式将与用户指定的格式相匹配。
run_id (UUID) – 运行的ID。
tags (Optional[List[str]]) – 与自定义事件关联的标签（包括继承的标签）。
metadata (Optional[Dict[str, Any]]) – 与自定义事件关联的元数据（包括继承的元数据）。
kwargs (Any) –

返回类型

Any

新增于版本0.2.15。

on_llm_end(response: LLMResult, **kwargs: Any) → None[source]¶

当LLM运行结束时运行。

如果将 include_output_tokens 设置为True，将计算LLM完成中的token数进行速率限制。

参数

response (LLMResult) –
kwargs (Any) –

返回类型

None

on_llm_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

当LLM出错时运行。

参数

error (BaseException) – 发生的错误。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_llm_new_token(token: str, *, chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在新的LLM令牌上运行。仅当启用流式传输时可用。

参数

token (str) – 新令牌。
chunk (GenerationChunk | ChatGenerationChunk) – 新生成的内容块，包含内容和其他信息。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None[source]¶

当LLM开始运行时运行。

参数

序列化 (Dict[str, Any]) –
prompts (列表[字符串]) –
kwargs (Any) –

返回类型

None

on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

当Retriever运行结束时运行。

参数

documents (序列[Document]) – 检索到的文档。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

当Retriever出错时运行。

参数

error (BaseException) – 发生的错误。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_retriever_start(serialized: Dict[str, Any], query: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any¶

当Retriever开始运行时运行。

参数

serialized (Dict[str, Any]) – 序列化的检索器。
query (str) – 查询。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
标签 (Optional[List[str]]) – 标签。
元数据 (Optional[Dict[str, Any]]) – 元数据。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在重试事件上运行。

参数

retry_state (RetryCallState) – 重试状态。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_text(text: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在任意文本上运行。

参数

text (str) – 文本内容。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_tool_end(output: Any, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在工具运行结束时运行。

参数

output (Any) – 工具的输出结果。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_tool_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在工具出错时运行。

参数

error (BaseException) – 发生的错误。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

on_tool_start(serialized: Dict[str, Any], input_str: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, inputs: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any¶

在工具开始运行时运行。

参数

serialized (Dict[str, Any]) – 序列化的工具。
input_str (str) – 输入字符串。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
标签 (Optional[List[str]]) – 标签。
元数据 (Optional[Dict[str, Any]]) – 元数据。
inputs (Optional[Dict[str, Any]]) – 输入。
kwargs (Any) – 额外的关键字参数。

返回类型

Any

reset(identifier: Optional[str] = None) → UpstashRatelimitHandler[source]¶

创建一个新的 UpstashRatelimitHandler 对象，具有相同的速率限制配置，如果提供了标识符，则具有新的标识符。

同时重置处理器的状态。

参数: identifier (Optional[str]) –
返回类型: UpstashRatelimitHandler

langchain_community.callbacks.upstash_ratelimit_callback.UpstashRatelimitHandler¶

`langchain_community.callbacks.upstash_ratelimit_callback`.UpstashRatelimitHandler¶