Class UpstashRatelimitHandler

Callback to handle rate limiting based on the number of requests or the number of tokens in the input.

It uses Upstash Ratelimit to track the rate limit which utilizes Upstash Redis to track the state.

Should not be passed to the chain when initializing the chain. This is because the handler has a state which should be fresh every time invoke is called. Instead, initialize and pass a handler every time you invoke.

Hierarchy

BaseCallbackHandler
- UpstashRatelimitHandler

Constructors

constructor

new UpstashRatelimitHandler(identifier, options): UpstashRatelimitHandler
Parameters
- identifier: string
  The identifier to rate limit, like a user ID or an IP address
- options: UpstashRatelimitHandlerOptions
  Ratelimit options
Returns UpstashRatelimitHandler
Overrides BaseCallbackHandler.constructor
- Defined in libs/langchain-community/src/callbacks/handlers/upstash_ratelimit.ts:85

Properties

awaitHandlers

awaitHandlers: boolean

identifier

identifier: string

ignoreAgent

ignoreAgent: boolean

ignoreChain

ignoreChain: boolean

ignoreCustomEvent

ignoreCustomEvent: boolean

ignoreLLM

ignoreLLM: boolean

ignoreRetriever

ignoreRetriever: boolean

includeOutputTokens

includeOutputTokens: boolean

llmOutputPromptTokenField

llmOutputPromptTokenField: string

llmOutputTokenUsageField

llmOutputTokenUsageField: string

llmOutputTotalTokenField

llmOutputTotalTokenField: string

name

name: string = "UpstashRatelimit"

raiseError

raiseError: boolean = true

`Optional`requestRatelimit

requestRatelimit?: RegionRatelimit

`Optional`tokenRatelimit

tokenRatelimit?: RegionRatelimit

Methods

copy

copy(): BaseCallbackHandler
Returns BaseCallbackHandler
Inherited from BaseCallbackHandler.copy
- Defined in langchain-core/dist/callbacks/base.d.ts:179

`Optional`handleAgentAction

handleAgentAction(action, runId, parentRunId?, tags?): void | Promise<void>
Called when an agent is about to execute an action, with the action and the run ID.
Parameters
- action: AgentAction
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
Returns void | Promise<void>
Inherited from BaseCallbackHandler.handleAgentAction
- Defined in langchain-core/dist/callbacks/base.d.ts:115

`Optional`handleAgentEnd

handleAgentEnd(action, runId, parentRunId?, tags?): void | Promise<void>
Called when an agent finishes execution, before it exits. with the final output and the run ID.
Parameters
- action: AgentFinish
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
Returns void | Promise<void>
Inherited from BaseCallbackHandler.handleAgentEnd
- Defined in langchain-core/dist/callbacks/base.d.ts:120

`Optional`handleChainEnd

handleChainEnd(outputs, runId, parentRunId?, tags?, kwargs?): any
Called at the end of a Chain run, with the outputs and the run ID.
Parameters
- outputs: ChainValues
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
- Optionalkwargs: {
  inputs?: Record<string, unknown>;
  }
  - Optionalinputs?: Record<string, unknown>
Returns any
Inherited from BaseCallbackHandler.handleChainEnd
- Defined in langchain-core/dist/callbacks/base.d.ts:90

`Optional`handleChainError

handleChainError(err, runId, parentRunId?, tags?, kwargs?): any
Called if a Chain run encounters an error
Parameters
- err: any
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
- Optionalkwargs: {
  inputs?: Record<string, unknown>;
  }
  - Optionalinputs?: Record<string, unknown>
Returns any
Inherited from BaseCallbackHandler.handleChainError
- Defined in langchain-core/dist/callbacks/base.d.ts:83

handleChainStart

handleChainStart(_chain, _inputs): Promise<void>
Run when the chain starts running.

This method is called multiple times during a chain execution. To ensure it only runs once, it checks and updates a _checked state.
Parameters
- _chain: Serialized
  Serialized chain
- _inputs: ChainValues
  Chain input values
Returns Promise<void>
Throws
UpstashRatelimitError - If the request rate limit is reached
Overrides BaseCallbackHandler.handleChainStart
- Defined in libs/langchain-community/src/callbacks/handlers/upstash_ratelimit.ts:115

`Optional`handleChatModelStart

handleChatModelStart(llm, messages, runId, parentRunId?, extraParams?, tags?, metadata?, runName?): any
Called at the start of a Chat Model run, with the prompt(s) and the run ID.
Parameters
- llm: Serialized
- messages: BaseMessage[][]
- runId: string
- OptionalparentRunId: string
- OptionalextraParams: Record<string, unknown>
- Optionaltags: string[]
- Optionalmetadata: Record<string, unknown>
- OptionalrunName: string
Returns any
Inherited from BaseCallbackHandler.handleChatModelStart
- Defined in langchain-core/dist/callbacks/base.d.ts:72

`Optional`handleCustomEvent

handleCustomEvent(eventName, data, runId, tags?, metadata?): any
Parameters
- eventName: string
- data: any
- runId: string
- Optionaltags: string[]
- Optionalmetadata: Record<string, any>
Returns any
Inherited from BaseCallbackHandler.handleCustomEvent
- Defined in langchain-core/dist/callbacks/base.d.ts:127

handleLLMEnd

handleLLMEnd(output, _runId, _parentRunId?, _tags?): Promise<void>
Run when the LLM ends running.

If the includeOutputTokens is set to true, the number of tokens in the LLM completion are counted for rate limiting.
Parameters
- output: LLMResult
  LLM result output
- _runId: string
- Optional_parentRunId: string
- Optional_tags: string[]
Returns Promise<void>
Throws
Error - If the LLM response does not include required token usage information
Overrides BaseCallbackHandler.handleLLMEnd
- Defined in libs/langchain-community/src/callbacks/handlers/upstash_ratelimit.ts:167

`Optional`handleLLMError

handleLLMError(err, runId, parentRunId?, tags?): any
Called if an LLM/ChatModel run encounters an error
Parameters
- err: any
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
Returns any
Inherited from BaseCallbackHandler.handleLLMError
- Defined in langchain-core/dist/callbacks/base.d.ts:61

`Optional`handleLLMNewToken

handleLLMNewToken(token, idx, runId, parentRunId?, tags?, fields?): any
Called when an LLM/ChatModel in streaming mode produces a new token
Parameters
- token: string
- idx: NewTokenIndices
  idx.prompt is the index of the prompt that produced the token (if there are multiple prompts) idx.completion is the index of the completion that produced the token (if multiple completions per prompt are requested)
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
- Optionalfields: HandleLLMNewTokenCallbackFields
Returns any
Inherited from BaseCallbackHandler.handleLLMNewToken
- Defined in langchain-core/dist/callbacks/base.d.ts:49

handleLLMStart

handleLLMStart(_llm, _prompts, _runId, _parentRunId?, _extraParams?, _tags?, _metadata?, _name?): Promise<void>
Run when the LLM starts running.
Parameters
- _llm: Serialized
  Serialized LLM
- _prompts: string[]
  Prompts passed to the LLM
- _runId: string
- Optional_parentRunId: string
- Optional_extraParams: Record<string, unknown>
- Optional_tags: string[]
- Optional_metadata: Record<string, unknown>
- Optional_name: string
Returns Promise<void>
Throws
UpstashRatelimitError - If the token rate limit is reached
Overrides BaseCallbackHandler.handleLLMStart
- Defined in libs/langchain-community/src/callbacks/handlers/upstash_ratelimit.ts:140

`Optional`handleRetrieverEnd

handleRetrieverEnd(documents, runId, parentRunId?, tags?): any
Parameters
- documents: DocumentInterface<Record<string, any>>[]
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
Returns any
Inherited from BaseCallbackHandler.handleRetrieverEnd
- Defined in langchain-core/dist/callbacks/base.d.ts:123

`Optional`handleRetrieverError

handleRetrieverError(err, runId, parentRunId?, tags?): any
Parameters
- err: any
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
Returns any
Inherited from BaseCallbackHandler.handleRetrieverError
- Defined in langchain-core/dist/callbacks/base.d.ts:125

`Optional`handleRetrieverStart

handleRetrieverStart(retriever, query, runId, parentRunId?, tags?, metadata?, name?): any
Parameters
- retriever: Serialized
- query: string
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
- Optionalmetadata: Record<string, unknown>
- Optionalname: string
Returns any
Inherited from BaseCallbackHandler.handleRetrieverStart
- Defined in langchain-core/dist/callbacks/base.d.ts:121

`Optional`handleText

handleText(text, runId, parentRunId?, tags?): void | Promise<void>
Parameters
- text: string
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
Returns void | Promise<void>
Inherited from BaseCallbackHandler.handleText
- Defined in langchain-core/dist/callbacks/base.d.ts:110

`Optional`handleToolEnd

handleToolEnd(output, runId, parentRunId?, tags?): any
Called at the end of a Tool run, with the tool output and the run ID.
Parameters
- output: any
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
Returns any
Inherited from BaseCallbackHandler.handleToolEnd
- Defined in langchain-core/dist/callbacks/base.d.ts:108

`Optional`handleToolError

handleToolError(err, runId, parentRunId?, tags?): any
Called if a Tool run encounters an error
Parameters
- err: any
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
Returns any
Inherited from BaseCallbackHandler.handleToolError
- Defined in langchain-core/dist/callbacks/base.d.ts:103

`Optional`handleToolStart

handleToolStart(tool, input, runId, parentRunId?, tags?, metadata?, runName?): any
Called at the start of a Tool run, with the tool name and input and the run ID.
Parameters
- tool: Serialized
- input: string
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
- Optionalmetadata: Record<string, unknown>
- OptionalrunName: string
Returns any
Inherited from BaseCallbackHandler.handleToolStart
- Defined in langchain-core/dist/callbacks/base.d.ts:98

reset

reset(identifier?): UpstashRatelimitHandler
Creates a new UpstashRatelimitHandler object with the same ratelimit configurations but with a new identifier if it's provided.

Also resets the state of the handler.
Parameters
- Optionalidentifier: string
  Optional new identifier to use for the new handler instance
Returns UpstashRatelimitHandler
New UpstashRatelimitHandler instance
- Defined in libs/langchain-community/src/callbacks/handlers/upstash_ratelimit.ts:210

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseCallbackHandler.toJSON
- Defined in langchain-core/dist/callbacks/base.d.ts:180

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseCallbackHandler.toJSONNotImplemented
- Defined in langchain-core/dist/callbacks/base.d.ts:181

`Static`fromMethods

fromMethods(methods): {
    awaitHandlers: boolean;
    ignoreAgent: boolean;
    ignoreChain: boolean;
    ignoreCustomEvent: boolean;
    ignoreLLM: boolean;
    ignoreRetriever: boolean;
    name: string;
    raiseError: boolean;
    copy(): BaseCallbackHandler;
    handleAgentAction?(action: AgentAction, runId: string, parentRunId?: string, tags?: string[]): void | Promise<void>;
    handleAgentEnd?(action: AgentFinish, runId: string, parentRunId?: string, tags?: string[]): void | Promise<void>;
    handleChainEnd?(outputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], kwargs?: {
        inputs?: Record<string, unknown>;
    }): any;
    handleChainError?(err: any, runId: string, parentRunId?: string, tags?: string[], kwargs?: {
        inputs?: Record<string, unknown>;
    }): any;
    handleChainStart?(chain: Serialized, inputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runType?: string, runName?: string): any;
    handleChatModelStart?(llm: Serialized, messages: BaseMessage[][], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): any;
    handleCustomEvent?(eventName: string, data: any, runId: string, tags?: string[], metadata?: Record<string, any>): any;
    handleLLMEnd?(output: LLMResult, runId: string, parentRunId?: string, tags?: string[]): any;
    handleLLMError?(err: any, runId: string, parentRunId?: string, tags?: string[]): any;
    handleLLMNewToken?(token: string, idx: NewTokenIndices, runId: string, parentRunId?: string, tags?: string[], fields?: HandleLLMNewTokenCallbackFields): any;
    handleLLMStart?(llm: Serialized, prompts: string[], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): any;
    handleRetrieverEnd?(documents: DocumentInterface<Record<string, any>>[], runId: string, parentRunId?: string, tags?: string[]): any;
    handleRetrieverError?(err: any, runId: string, parentRunId?: string, tags?: string[]): any;
    handleRetrieverStart?(retriever: Serialized, query: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, name?: string): any;
    handleText?(text: string, runId: string, parentRunId?: string, tags?: string[]): void | Promise<void>;
    handleToolEnd?(output: any, runId: string, parentRunId?: string, tags?: string[]): any;
    handleToolError?(err: any, runId: string, parentRunId?: string, tags?: string[]): any;
    handleToolStart?(tool: Serialized, input: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runName?: string): any;
    toJSON(): Serialized;
    toJSONNotImplemented(): SerializedNotImplemented;
}
Parameters
- methods: BaseCallbackHandlerMethodsClass
Returns {
    awaitHandlers: boolean;
    ignoreAgent: boolean;
    ignoreChain: boolean;
    ignoreCustomEvent: boolean;
    ignoreLLM: boolean;
    ignoreRetriever: boolean;
    name: string;
    raiseError: boolean;
    copy(): BaseCallbackHandler;
    handleAgentAction?(action: AgentAction, runId: string, parentRunId?: string, tags?: string[]): void | Promise<void>;
    handleAgentEnd?(action: AgentFinish, runId: string, parentRunId?: string, tags?: string[]): void | Promise<void>;
    handleChainEnd?(outputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], kwargs?: {
        inputs?: Record<string, unknown>;
    }): any;
    handleChainError?(err: any, runId: string, parentRunId?: string, tags?: string[], kwargs?: {
        inputs?: Record<string, unknown>;
    }): any;
    handleChainStart?(chain: Serialized, inputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runType?: string, runName?: string): any;
    handleChatModelStart?(llm: Serialized, messages: BaseMessage[][], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): any;
    handleCustomEvent?(eventName: string, data: any, runId: string, tags?: string[], metadata?: Record<string, any>): any;
    handleLLMEnd?(output: LLMResult, runId: string, parentRunId?: string, tags?: string[]): any;
    handleLLMError?(err: any, runId: string, parentRunId?: string, tags?: string[]): any;
    handleLLMNewToken?(token: string, idx: NewTokenIndices, runId: string, parentRunId?: string, tags?: string[], fields?: HandleLLMNewTokenCallbackFields): any;
    handleLLMStart?(llm: Serialized, prompts: string[], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): any;
    handleRetrieverEnd?(documents: DocumentInterface<Record<string, any>>[], runId: string, parentRunId?: string, tags?: string[]): any;
    handleRetrieverError?(err: any, runId: string, parentRunId?: string, tags?: string[]): any;
    handleRetrieverStart?(retriever: Serialized, query: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, name?: string): any;
    handleText?(text: string, runId: string, parentRunId?: string, tags?: string[]): void | Promise<void>;
    handleToolEnd?(output: any, runId: string, parentRunId?: string, tags?: string[]): any;
    handleToolError?(err: any, runId: string, parentRunId?: string, tags?: string[]): any;
    handleToolStart?(tool: Serialized, input: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runName?: string): any;
    toJSON(): Serialized;
    toJSONNotImplemented(): SerializedNotImplemented;
}
- awaitHandlers: boolean
- ignoreAgent: boolean
- ignoreChain: boolean
- ignoreCustomEvent: boolean
- ignoreLLM: boolean
- ignoreRetriever: boolean
- name: string
- raiseError: boolean
- copy:function
  - copy(): BaseCallbackHandler
  - Returns BaseCallbackHandler
    - Defined in langchain-core/dist/callbacks/base.d.ts:207
- handleAgentAction?:function
  - handleAgentAction(action, runId, parentRunId?, tags?): void | Promise<void>
  - Called when an agent is about to execute an action, with the action and the run ID.
    Parameters
    - action: AgentAction
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    Returns void | Promise<void>
    - Defined in langchain-core/dist/callbacks/base.d.ts:267
- handleAgentEnd?:function
  - handleAgentEnd(action, runId, parentRunId?, tags?): void | Promise<void>
  - Called when an agent finishes execution, before it exits. with the final output and the run ID.
    Parameters
    - action: AgentFinish
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    Returns void | Promise<void>
    - Defined in langchain-core/dist/callbacks/base.d.ts:272
- handleChainEnd?:function
  - handleChainEnd(outputs, runId, parentRunId?, tags?, kwargs?): any
  - Called at the end of a Chain run, with the outputs and the run ID.
    Parameters
    - outputs: ChainValues
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    - Optionalkwargs: {
      inputs?: Record<string, unknown>;
      }
      Optionalinputs?: Record<string, unknown>
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:246
- handleChainError?:function
  - handleChainError(err, runId, parentRunId?, tags?, kwargs?): any
  - Called if a Chain run encounters an error
    Parameters
    - err: any
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    - Optionalkwargs: {
      inputs?: Record<string, unknown>;
      }
      Optionalinputs?: Record<string, unknown>
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:240
- handleChainStart?:function
  - handleChainStart(chain, inputs, runId, parentRunId?, tags?, metadata?, runType?, runName?): any
  - Called at the start of a Chain run, with the chain name and inputs and the run ID.
    Parameters
    - chain: Serialized
    - inputs: ChainValues
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    - Optionalmetadata: Record<string, unknown>
    - OptionalrunType: string
    - OptionalrunName: string
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:236
- handleChatModelStart?:function
  - handleChatModelStart(llm, messages, runId, parentRunId?, extraParams?, tags?, metadata?, runName?): any
  - Called at the start of a Chat Model run, with the prompt(s) and the run ID.
    Parameters
    - llm: Serialized
    - messages: BaseMessage[][]
    - runId: string
    - OptionalparentRunId: string
    - OptionalextraParams: Record<string, unknown>
    - Optionaltags: string[]
    - Optionalmetadata: Record<string, unknown>
    - OptionalrunName: string
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:231
- handleCustomEvent?:function
  - handleCustomEvent(eventName, data, runId, tags?, metadata?): any
  - Parameters
    - eventName: string
    - data: any
    - runId: string
    - Optionaltags: string[]
    - Optionalmetadata: Record<string, any>
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:276
- handleLLMEnd?:function
  - handleLLMEnd(output, runId, parentRunId?, tags?): any
  - Called at the end of an LLM/ChatModel run, with the output and the run ID.
    Parameters
    - output: LLMResult
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:226
- handleLLMError?:function
  - handleLLMError(err, runId, parentRunId?, tags?): any
  - Called if an LLM/ChatModel run encounters an error
    Parameters
    - err: any
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:222
- handleLLMNewToken?:function
  - handleLLMNewToken(token, idx, runId, parentRunId?, tags?, fields?): any
  - Called when an LLM/ChatModel in streaming mode produces a new token
    Parameters
    - token: string
    - idx: NewTokenIndices
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    - Optionalfields: HandleLLMNewTokenCallbackFields
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:218
- handleLLMStart?:function
  - handleLLMStart(llm, prompts, runId, parentRunId?, extraParams?, tags?, metadata?, runName?): any
  - Called at the start of an LLM or Chat Model run, with the prompt(s) and the run ID.
    Parameters
    - llm: Serialized
    - prompts: string[]
    - runId: string
    - OptionalparentRunId: string
    - OptionalextraParams: Record<string, unknown>
    - Optionaltags: string[]
    - Optionalmetadata: Record<string, unknown>
    - OptionalrunName: string
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:214
- handleRetrieverEnd?:function
  - handleRetrieverEnd(documents, runId, parentRunId?, tags?): any
  - Parameters
    - documents: DocumentInterface<Record<string, any>>[]
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:274
- handleRetrieverError?:function
  - handleRetrieverError(err, runId, parentRunId?, tags?): any
  - Parameters
    - err: any
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:275
- handleRetrieverStart?:function
  - handleRetrieverStart(retriever, query, runId, parentRunId?, tags?, metadata?, name?): any
  - Parameters
    - retriever: Serialized
    - query: string
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    - Optionalmetadata: Record<string, unknown>
    - Optionalname: string
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:273
- handleText?:function
  - handleText(text, runId, parentRunId?, tags?): void | Promise<void>
  - Parameters
    - text: string
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    Returns void | Promise<void>
    - Defined in langchain-core/dist/callbacks/base.d.ts:262
- handleToolEnd?:function
  - handleToolEnd(output, runId, parentRunId?, tags?): any
  - Called at the end of a Tool run, with the tool output and the run ID.
    Parameters
    - output: any
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:261
- handleToolError?:function
  - handleToolError(err, runId, parentRunId?, tags?): any
  - Called if a Tool run encounters an error
    Parameters
    - err: any
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:257
- handleToolStart?:function
  - handleToolStart(tool, input, runId, parentRunId?, tags?, metadata?, runName?): any
  - Called at the start of a Tool run, with the tool name and input and the run ID.
    Parameters
    - tool: Serialized
    - input: string
    - runId: string
    - OptionalparentRunId: string
    - Optionaltags: string[]
    - Optionalmetadata: Record<string, unknown>
    - OptionalrunName: string
    Returns any
    - Defined in langchain-core/dist/callbacks/base.d.ts:253
- toJSON:function
  - toJSON(): Serialized
  - Returns Serialized
    - Defined in langchain-core/dist/callbacks/base.d.ts:208
- toJSONNotImplemented:function
  - toJSONNotImplemented(): SerializedNotImplemented
  - Returns SerializedNotImplemented
    - Defined in langchain-core/dist/callbacks/base.d.ts:209
Inherited from BaseCallbackHandler.fromMethods
- Defined in langchain-core/dist/callbacks/base.d.ts:182

Class UpstashRatelimitHandler

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UpstashRatelimitHandler

Properties

awaitHandlers

identifier

ignoreAgent

ignoreChain

ignoreCustomEvent

ignoreLLM

ignoreRetriever

includeOutputTokens

llmOutputPromptTokenField

llmOutputTokenUsageField

llmOutputTotalTokenField

name

raiseError

OptionalrequestRatelimit

OptionaltokenRatelimit

Methods

copy

Returns BaseCallbackHandler

OptionalhandleAgentAction

Parameters

Returns void | Promise<void>

OptionalhandleAgentEnd

Parameters

Returns void | Promise<void>

OptionalhandleChainEnd

Parameters

Optionalinputs?: Record<string, unknown>

Returns any

OptionalhandleChainError

Parameters

Optionalinputs?: Record<string, unknown>

Returns any

handleChainStart

Parameters

Returns Promise<void>

Throws

OptionalhandleChatModelStart

Parameters

Returns any

OptionalhandleCustomEvent

Parameters

Returns any

handleLLMEnd

Parameters

Returns Promise<void>

Throws

OptionalhandleLLMError

Parameters

Returns any

OptionalhandleLLMNewToken

Parameters

Returns any

handleLLMStart

Parameters

Returns Promise<void>

Throws

OptionalhandleRetrieverEnd

Parameters

Returns any

OptionalhandleRetrieverError

Parameters

Returns any

OptionalhandleRetrieverStart

Parameters

Returns any

OptionalhandleText

Parameters

Returns void | Promise<void>

OptionalhandleToolEnd

`Optional`requestRatelimit

`Optional`tokenRatelimit

`Optional`handleAgentAction

`Optional`handleAgentEnd

`Optional`handleChainEnd

`Optional`inputs?: Record<string, unknown>

`Optional`handleChainError

`Optional`inputs?: Record<string, unknown>

`Optional`handleChatModelStart

`Optional`handleCustomEvent

`Optional`handleLLMError

`Optional`handleLLMNewToken

`Optional`handleRetrieverEnd

`Optional`handleRetrieverError

`Optional`handleRetrieverStart

`Optional`handleText

`Optional`handleToolEnd

`Optional`handleToolError

`Optional`handleToolStart

`Static`fromMethods

`Optional`inputs?: Record<string, unknown>

`Optional`inputs?: Record<string, unknown>