id
stringlengths
14
16
text
stringlengths
20
3.26k
source
stringlengths
65
181
766ccdb1d9b2-5
Parameters token (str) – chunk (Optional[Union[GenerationChunk, ChatGenerationChunk]]) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Run on_llm_start(serialized: Dict[str, Any], prompts: List[str], *, run_id: UUID, tags: Optional[List[str]] = None, parent_run_id: Optional[UUID] = No...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.wandb.WandbTracer.html
766ccdb1d9b2-6
run_id (UUID) – kwargs (Any) – Return type Run 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, name: Optional[str] = None, **kwargs: Any) → Run¶ Run when Retriever starts runn...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.wandb.WandbTracer.html
766ccdb1d9b2-7
run_id (UUID) – kwargs (Any) – Return type Run on_tool_error(error: BaseException, *, run_id: UUID, **kwargs: Any) → Run¶ Handle an error for a tool run. Parameters error (BaseException) – run_id (UUID) – kwargs (Any) – Return type Run on_tool_start(serialized: Dict[str, Any], input_str: str, *, run_id: UUID, tags...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.wandb.WandbTracer.html
94dd7c02db1a-0
langchain_community.callbacks.streamlit.streamlit_callback_handler.ToolRecord¶ class langchain_community.callbacks.streamlit.streamlit_callback_handler.ToolRecord(name: str, input_str: str)[source]¶ Tool record as a NamedTuple. Create new instance of ToolRecord(name, input_str) Attributes input_str Alias for field numb...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.streamlit_callback_handler.ToolRecord.html
a5957e241840-0
langchain_core.callbacks.base.AsyncCallbackHandler¶ class langchain_core.callbacks.base.AsyncCallbackHandler[source]¶ Async callback handler that handles callbacks from LangChain. Attributes ignore_agent Whether to ignore agent callbacks. ignore_chain Whether to ignore chain callbacks. ignore_chat_model Whether to igno...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.AsyncCallbackHandler.html
a5957e241840-1
Run on retriever error. on_retriever_start(serialized, query, *, run_id) Run on retriever start. on_retry(retry_state, *, run_id[, parent_run_id]) Run on a retry event. on_text(text, *, run_id[, parent_run_id, tags]) Run on arbitrary text. on_tool_end(output, *, run_id[, ...]) Run when tool ends running. on_tool_error(...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.AsyncCallbackHandler.html
a5957e241840-2
kwargs (Any) – Return type None async on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None[source]¶ Run when chain ends running. Parameters outputs (Dict[str, Any]) – run_id (UUID) – parent_run_id (Optional[UUID]) – tags...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.AsyncCallbackHandler.html
a5957e241840-3
kwargs (Any) – Return type None async on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any[source]¶ Run when a chat model starts running...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.AsyncCallbackHandler.html
a5957e241840-4
- response (LLMResult): The response which was generated before the error occurred. run_id (UUID) – parent_run_id (Optional[UUID]) – tags (Optional[List[str]]) – Return type None async on_llm_new_token(token: str, *, chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None, run_id: UUID, parent_run_id: Op...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.AsyncCallbackHandler.html
a5957e241840-5
kwargs (Any) – Return type None async on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None[source]¶ Run on retriever end. Parameters documents (Sequence[Document]) – run_id (UUID) – parent_run_id (Optional[UUID]...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.AsyncCallbackHandler.html
a5957e241840-6
kwargs (Any) – Return type None async on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any[source]¶ Run on a retry event. Parameters retry_state (RetryCallState) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any async on_t...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.AsyncCallbackHandler.html
a5957e241840-7
tags (Optional[List[str]]) – kwargs (Any) – Return type None async 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) → Non...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.AsyncCallbackHandler.html
9a64801feb2d-0
langchain_community.callbacks.labelstudio_callback.get_default_label_configs¶ langchain_community.callbacks.labelstudio_callback.get_default_label_configs(mode: Union[str, LabelStudioMode]) → Tuple[str, LabelStudioMode][source]¶ Get default Label Studio configs for the given mode. Parameters mode (Union[str, LabelStudi...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.labelstudio_callback.get_default_label_configs.html
d79c3435f993-0
langchain_community.callbacks.utils.import_textstat¶ langchain_community.callbacks.utils.import_textstat() → Any[source]¶ Import the textstat python package and raise an error if it is not installed. Return type Any
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.utils.import_textstat.html
abf065525473-0
langchain_core.callbacks.manager.ahandle_event¶ async langchain_core.callbacks.manager.ahandle_event(handlers: List[BaseCallbackHandler], event_name: str, ignore_condition_name: Optional[str], *args: Any, **kwargs: Any) → None[source]¶ Generic event handler for AsyncCallbackManager. Note: This function is used by langs...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.ahandle_event.html
abfee760ce15-0
langchain_core.callbacks.manager.ParentRunManager¶ class langchain_core.callbacks.manager.ParentRunManager(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, inheritable_tags: Optional[List[str]] ...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.ParentRunManager.html
abfee760ce15-1
on_text(text, **kwargs) Run when text is received. __init__(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, inheritable_tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = No...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.ParentRunManager.html
abfee760ce15-2
kwargs (Any) – Return type None on_text(text: str, **kwargs: Any) → Any¶ Run when text is received. Parameters text (str) – The received text. kwargs (Any) – Returns The result of the callback. Return type Any
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.ParentRunManager.html
3415a7165bbd-0
langchain_core.callbacks.manager.trace_as_chain_group¶ langchain_core.callbacks.manager.trace_as_chain_group(group_name: str, callback_manager: Optional[CallbackManager] = None, *, inputs: Optional[Dict[str, Any]] = None, project_name: Optional[str] = None, example_id: Optional[Union[str, UUID]] = None, run_id: Optiona...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.trace_as_chain_group.html
3415a7165bbd-1
group_name (str) – callback_manager (Optional[CallbackManager]) – inputs (Optional[Dict[str, Any]]) – project_name (Optional[str]) – example_id (Optional[Union[str, UUID]]) – run_id (Optional[UUID]) – tags (Optional[List[str]]) – metadata (Optional[Dict[str, Any]]) – Example llm_input = "Foo" with trace_as_chai...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.trace_as_chain_group.html
b6a279bb2490-0
langchain_community.callbacks.upstash_ratelimit_callback.UpstashRatelimitError¶ class langchain_community.callbacks.upstash_ratelimit_callback.UpstashRatelimitError(message: str, type: Literal['token', 'request'], limit: Optional[int] = None, reset: Optional[float] = None)[source]¶ Upstash Ratelimit Error Raised when t...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.upstash_ratelimit_callback.UpstashRatelimitError.html
b89ae181bf4b-0
langchain_community.callbacks.confident_callback.DeepEvalCallbackHandler¶ class langchain_community.callbacks.confident_callback.DeepEvalCallbackHandler(metrics: List[Any], implementation_name: Optional[str] = None)[source]¶ Callback Handler that logs into deepeval. Parameters implementation_name (Optional[str]) – name...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.confident_callback.DeepEvalCallbackHandler.html
b89ae181bf4b-1
Whether to ignore chat model callbacks. ignore_llm Whether to ignore LLM callbacks. ignore_retriever Whether to ignore retriever callbacks. ignore_retry Whether to ignore retry callbacks. raise_error run_inline Methods __init__(metrics[, implementation_name]) Initializes the deepevalCallbackHandler. on_agent_action(act...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.confident_callback.DeepEvalCallbackHandler.html
b89ae181bf4b-2
Run on a retry event. on_text(text, **kwargs) Do nothing on_tool_end(output[, observation_prefix, ...]) Do nothing when tool ends. on_tool_error(error, **kwargs) Do nothing when tool outputs an error. on_tool_start(serialized, input_str, **kwargs) Do nothing when tool starts. __init__(metrics: List[Any], implementation...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.confident_callback.DeepEvalCallbackHandler.html
b89ae181bf4b-3
error (BaseException) – kwargs (Any) – Return type None on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any) → None[source]¶ Do nothing when chain starts Parameters serialized (Dict[str, Any]) – inputs (Dict[str, Any]) – kwargs (Any) – Return type None on_chat_model_start(serialized: D...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.confident_callback.DeepEvalCallbackHandler.html
b89ae181bf4b-4
error (BaseException) – kwargs (Any) – Return type None on_llm_new_token(token: str, **kwargs: Any) → None[source]¶ Do nothing when a new token is generated. Parameters token (str) – kwargs (Any) – Return type None on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None[source]¶ Store the...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.confident_callback.DeepEvalCallbackHandler.html
b89ae181bf4b-5
Parameters serialized (Dict[str, Any]) – query (str) – run_id (UUID) – parent_run_id (Optional[UUID]) – tags (Optional[List[str]]) – metadata (Optional[Dict[str, Any]]) – kwargs (Any) – Return type Any on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → A...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.confident_callback.DeepEvalCallbackHandler.html
b89ae181bf4b-6
input_str (str) – kwargs (Any) – Return type None Examples using DeepEvalCallbackHandler¶ Confident Confident AI
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.confident_callback.DeepEvalCallbackHandler.html
76791c3d7def-0
langchain_core.callbacks.manager.handle_event¶ langchain_core.callbacks.manager.handle_event(handlers: List[BaseCallbackHandler], event_name: str, ignore_condition_name: Optional[str], *args: Any, **kwargs: Any) → None[source]¶ Generic event handler for CallbackManager. Note: This function is used by langserve to handl...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.handle_event.html
01e9e137f8a1-0
langchain_core.callbacks.manager.CallbackManagerForChainGroup¶ class langchain_core.callbacks.manager.CallbackManagerForChainGroup(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, parent_run_id: Optional[UUID] = None, *, parent_run_manager: CallbackManagerForChainRu...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForChainGroup.html
01e9e137f8a1-1
Set handlers as the only handlers on the callback manager. Parameters handlers (List[BaseCallbackHandler]) – inheritable_handlers (Optional[List[BaseCallbackHandler]]) – parent_run_id (Optional[UUID]) – parent_run_manager (CallbackManagerForChainRun) – kwargs (Any) – __init__(handlers: List[BaseCallbackHandler], i...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForChainGroup.html
01e9e137f8a1-2
tags (List[str]) – inherit (bool) – Return type None classmethod configure(inheritable_callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, local_callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, verbose: bool = False, inheritable_tags: Optional[List[str]...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForChainGroup.html
01e9e137f8a1-3
kwargs (Any) – Return type None on_chain_error(error: BaseException, **kwargs: Any) → None[source]¶ Run when chain errors. Parameters error (Exception or KeyboardInterrupt) – The error. kwargs (Any) – Return type None on_chain_start(serialized: Dict[str, Any], inputs: Union[Dict[str, Any], Any], run_id: Optional[UUID...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForChainGroup.html
01e9e137f8a1-4
Run when LLM starts running. Parameters serialized (Dict[str, Any]) – The serialized LLM. prompts (List[str]) – The list of prompts. run_id (UUID, optional) – The ID of the run. Defaults to None. kwargs (Any) – Returns A callback manager for eachprompt as an LLM run. Return type List[CallbackManagerForLLMRun] on_retri...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForChainGroup.html
01e9e137f8a1-5
Recommended for usage instead of input_str when the original input is needed. If provided, the inputs are expected to be formatted as a dict. The keys will correspond to the named-arguments in the tool. kwargs (Any) – Returns The callback manager for the tool run. Return type CallbackManagerForToolRun remove_handler(h...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForChainGroup.html
4509415456c1-0
langchain_community.callbacks.openai_info.standardize_model_name¶ langchain_community.callbacks.openai_info.standardize_model_name(model_name: str, is_completion: bool = False) → str[source]¶ Standardize the model name to a format that can be used in the OpenAI API. Parameters model_name (str) – Model name to standardi...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.openai_info.standardize_model_name.html
35a36de06a92-0
langchain_community.callbacks.tracers.comet.CometTracer¶ class langchain_community.callbacks.tracers.comet.CometTracer(**kwargs: Any)[source]¶ Comet Tracer. Initialize the Comet Tracer. Attributes ignore_agent Whether to ignore agent callbacks. ignore_chain Whether to ignore chain callbacks. ignore_chat_model Whether t...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.comet.CometTracer.html
35a36de06a92-1
Start a trace for an LLM run. on_retriever_end(documents, *, run_id, **kwargs) Run when Retriever ends running. on_retriever_error(error, *, run_id, **kwargs) Run when Retriever errors. on_retriever_start(serialized, query, *, run_id) Run when Retriever starts running. on_retry(retry_state, *, run_id, **kwargs) Run on ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.comet.CometTracer.html
35a36de06a92-2
Run on agent end. Parameters finish (AgentFinish) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, inputs: Optional[Dict[str, Any]] = None, **kwargs: Any) → Run¶ End a trace for a chain run. Parameters outputs (Dict[str, Any]) –...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.comet.CometTracer.html
35a36de06a92-3
name (Optional[str]) – kwargs (Any) – Return type Run on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], *, run_id: UUID, tags: Optional[List[str]] = None, parent_run_id: Optional[UUID] = None, metadata: Optional[Dict[str, Any]] = None, name: Optional[str] = None, **kwargs: Any) → Run¶...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.comet.CometTracer.html
35a36de06a92-4
Parameters token (str) – chunk (Optional[Union[GenerationChunk, ChatGenerationChunk]]) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Run on_llm_start(serialized: Dict[str, Any], prompts: List[str], *, run_id: UUID, tags: Optional[List[str]] = None, parent_run_id: Optional[UUID] = No...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.comet.CometTracer.html
35a36de06a92-5
run_id (UUID) – kwargs (Any) – Return type Run 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, name: Optional[str] = None, **kwargs: Any) → Run¶ Run when Retriever starts runn...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.comet.CometTracer.html
35a36de06a92-6
run_id (UUID) – kwargs (Any) – Return type Run on_tool_error(error: BaseException, *, run_id: UUID, **kwargs: Any) → Run¶ Handle an error for a tool run. Parameters error (BaseException) – run_id (UUID) – kwargs (Any) – Return type Run on_tool_start(serialized: Dict[str, Any], input_str: str, *, run_id: UUID, tags...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.comet.CometTracer.html
ef233f1ef89c-0
langchain_community.callbacks.comet_ml_callback.CometCallbackHandler¶ class langchain_community.callbacks.comet_ml_callback.CometCallbackHandler(task_type: Optional[str] = 'inference', workspace: Optional[str] = None, project_name: Optional[str] = None, tags: Optional[Sequence] = None, name: Optional[str] = None, visua...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.comet_ml_callback.CometCallbackHandler.html
ef233f1ef89c-1
ignore_llm Whether to ignore LLM callbacks. ignore_retriever Whether to ignore retriever callbacks. ignore_retry Whether to ignore retry callbacks. raise_error run_inline Methods __init__([task_type, workspace, ...]) Initialize callback handler. flush_tracker([langchain_asset, task_type, ...]) Flush the tracker and set...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.comet_ml_callback.CometCallbackHandler.html
ef233f1ef89c-2
Run on a retry event. on_text(text, **kwargs) Run when agent is ending. on_tool_end(output, **kwargs) Run when tool ends running. on_tool_error(error, **kwargs) Run when tool errors. on_tool_start(serialized, input_str, **kwargs) Run when tool starts running. reset_callback_meta() Reset the callback metadata. __init__(...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.comet_ml_callback.CometCallbackHandler.html
ef233f1ef89c-3
Everything after this will be a new table. Parameters name (Optional[str]) – Name of the performed session so far so it is identifiable langchain_asset (Optional[Any]) – The langchain asset to save. finish (bool) – Whether to finish the run. Returns – None task_type (Optional[str]) – workspace (Optional[str]) – proje...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.comet_ml_callback.CometCallbackHandler.html
ef233f1ef89c-4
Run when chain starts running. Parameters serialized (Dict[str, Any]) – inputs (Dict[str, Any]) – kwargs (Any) – Return type None on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optio...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.comet_ml_callback.CometCallbackHandler.html
ef233f1ef89c-5
token (str) – kwargs (Any) – Return type None on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None[source]¶ Run when LLM starts. Parameters serialized (Dict[str, Any]) – prompts (List[str]) – kwargs (Any) – Return type None on_retriever_end(documents: Sequence[Document], *, run_id: UU...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.comet_ml_callback.CometCallbackHandler.html
ef233f1ef89c-6
metadata (Optional[Dict[str, Any]]) – kwargs (Any) – Return type Any on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run on a retry event. Parameters retry_state (RetryCallState) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Re...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.comet_ml_callback.CometCallbackHandler.html
a0249dd849b1-0
langchain_community.callbacks.fiddler_callback.FiddlerCallbackHandler¶ class langchain_community.callbacks.fiddler_callback.FiddlerCallbackHandler(url: str, org: str, project: str, model: str, api_key: str)[source]¶ Initialize Fiddler callback handler. Parameters url (str) – Fiddler URL (e.g. https://demo.fiddler.ai). ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.fiddler_callback.FiddlerCallbackHandler.html
a0249dd849b1-1
on_agent_finish(finish, *, run_id[, ...]) Run on agent end. on_chain_end(outputs, *, run_id[, parent_run_id]) Run when chain ends running. on_chain_error(error, *, run_id[, parent_run_id]) Run when chain errors. on_chain_start(serialized, inputs, *, run_id) Run when chain starts running. on_chat_model_start(serialized,...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.fiddler_callback.FiddlerCallbackHandler.html
a0249dd849b1-2
Run when tool ends running. on_tool_error(error, *, run_id[, parent_run_id]) Run when tool errors. on_tool_start(serialized, input_str, *, run_id) Run when tool starts running. __init__(url: str, org: str, project: str, model: str, api_key: str) → None[source]¶ Initialize Fiddler callback handler. Parameters url (str) ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.fiddler_callback.FiddlerCallbackHandler.html
a0249dd849b1-3
Run when chain ends running. Parameters outputs (Dict[str, Any]) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any on_chain_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when chain errors. Parameters error (BaseException)...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.fiddler_callback.FiddlerCallbackHandler.html
a0249dd849b1-4
Parameters serialized (Dict[str, Any]) – messages (List[List[BaseMessage]]) – run_id (UUID) – parent_run_id (Optional[UUID]) – tags (Optional[List[str]]) – metadata (Optional[Dict[str, Any]]) – kwargs (Any) – Return type Any on_llm_end(response: LLMResult, **kwargs: Any) → None[source]¶ Run when LLM ends running...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.fiddler_callback.FiddlerCallbackHandler.html
a0249dd849b1-5
Run when LLM starts running. ATTENTION: This method is called for non-chat models (regular LLMs). Ifyou’re implementing a handler for a chat model, you should use on_chat_model_start instead. Parameters serialized (Dict[str, Any]) – prompts (List[str]) – kwargs (Any) – Return type Any on_retriever_end(documents: Seq...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.fiddler_callback.FiddlerCallbackHandler.html
a0249dd849b1-6
kwargs (Any) – Return type Any on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run on a retry event. Parameters retry_state (RetryCallState) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any on_text(text: str, *, run...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.fiddler_callback.FiddlerCallbackHandler.html
a0249dd849b1-7
kwargs (Any) – Return type 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¶ Run when tool starts running. Param...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.fiddler_callback.FiddlerCallbackHandler.html
9318a08b2695-0
langchain_community.callbacks.clearml_callback.ClearMLCallbackHandler¶ class langchain_community.callbacks.clearml_callback.ClearMLCallbackHandler(task_type: Optional[str] = 'inference', project_name: Optional[str] = 'langchain_callback_demo', tags: Optional[Sequence] = None, task_name: Optional[str] = None, visualize:...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.clearml_callback.ClearMLCallbackHandler.html
9318a08b2695-1
Initialize callback handler. analyze_text(text) Analyze text using textstat and spacy. flush_tracker([name, langchain_asset, finish]) Flush the tracker and setup the session. get_custom_callback_meta() on_agent_action(action, **kwargs) Run on agent action. on_agent_finish(finish, **kwargs) Run when agent ends running. ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.clearml_callback.ClearMLCallbackHandler.html
9318a08b2695-2
on_tool_error(error, **kwargs) Run when tool errors. on_tool_start(serialized, input_str, **kwargs) Run when tool starts running. reset_callback_meta() Reset the callback metadata. __init__(task_type: Optional[str] = 'inference', project_name: Optional[str] = 'langchain_callback_demo', tags: Optional[Sequence] = None, ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.clearml_callback.ClearMLCallbackHandler.html
9318a08b2695-3
Run on agent action. Parameters action (AgentAction) – kwargs (Any) – Return type Any on_agent_finish(finish: AgentFinish, **kwargs: Any) → None[source]¶ Run when agent ends running. Parameters finish (AgentFinish) – kwargs (Any) – Return type None on_chain_end(outputs: Dict[str, Any], **kwargs: Any) → None[source]...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.clearml_callback.ClearMLCallbackHandler.html
9318a08b2695-4
run_id (UUID) – parent_run_id (Optional[UUID]) – tags (Optional[List[str]]) – metadata (Optional[Dict[str, Any]]) – kwargs (Any) – Return type Any on_llm_end(response: LLMResult, **kwargs: Any) → None[source]¶ Run when LLM ends running. Parameters response (LLMResult) – kwargs (Any) – Return type None on_llm_err...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.clearml_callback.ClearMLCallbackHandler.html
9318a08b2695-5
Run when Retriever errors. Parameters error (BaseException) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type 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[st...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.clearml_callback.ClearMLCallbackHandler.html
9318a08b2695-6
Run when tool errors. Parameters error (BaseException) – kwargs (Any) – Return type None on_tool_start(serialized: Dict[str, Any], input_str: str, **kwargs: Any) → None[source]¶ Run when tool starts running. Parameters serialized (Dict[str, Any]) – input_str (str) – kwargs (Any) – Return type None reset_callback_m...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.clearml_callback.ClearMLCallbackHandler.html
cc86b28f1435-0
langchain_community.callbacks.tracers.wandb.RunProcessor¶ class langchain_community.callbacks.tracers.wandb.RunProcessor(wandb_module: Any, trace_module: Any)[source]¶ Handles the conversion of a LangChain Runs into a WBTraceTree. Methods __init__(wandb_module, trace_module) build_tree(runs) Builds a nested dictionary ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.wandb.RunProcessor.html
cc86b28f1435-1
Return type Dict[str, Any] flatten_run(run: Dict[str, Any]) → List[Dict[str, Any]][source]¶ Utility to flatten a nest run object into a list of runs. :param run: The base run to flatten. :return: The flattened list of runs. Parameters run (Dict[str, Any]) – Return type List[Dict[str, Any]] modify_serialized_iterative(...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.wandb.RunProcessor.html
cc86b28f1435-2
process_span(run: Run) → Optional['Span'][source]¶ Converts a LangChain Run into a W&B Trace Span. :param run: The LangChain Run to convert. :return: The converted W&B Trace Span. Parameters run (Run) – Return type Optional[‘Span’] truncate_run_iterative(runs: List[Dict[str, Any]], keep_keys: Tuple[str, ...] = ()) → L...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.wandb.RunProcessor.html
38d96b271080-0
langchain_core.callbacks.base.LLMManagerMixin¶ class langchain_core.callbacks.base.LLMManagerMixin[source]¶ Mixin for LLM callbacks. Methods __init__() on_llm_end(response, *, run_id[, parent_run_id]) Run when LLM ends running. on_llm_error(error, *, run_id[, parent_run_id]) Run when LLM errors. :param error: The error...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.LLMManagerMixin.html
38d96b271080-1
kwargs (Any) – Return type 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[source]¶ Run on new LLM token. Only available when streaming is enabled. Parameters token (str) – The new token. c...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.LLMManagerMixin.html
dddf81a80808-0
langchain_community.callbacks.whylabs_callback.import_langkit¶ langchain_community.callbacks.whylabs_callback.import_langkit(sentiment: bool = False, toxicity: bool = False, themes: bool = False) → Any[source]¶ Import the langkit python package and raise an error if it is not installed. Parameters sentiment (bool) – Wh...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.whylabs_callback.import_langkit.html
dc5b77509ed4-0
langchain_community.callbacks.context_callback.import_context¶ langchain_community.callbacks.context_callback.import_context() → Any[source]¶ Import the getcontext package. Return type Any
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.context_callback.import_context.html
cc59305487d1-0
langchain_core.callbacks.base.CallbackManagerMixin¶ class langchain_core.callbacks.base.CallbackManagerMixin[source]¶ Mixin for callback manager. Methods __init__() on_chain_start(serialized, inputs, *, run_id) Run when chain starts running. on_chat_model_start(serialized, messages, *, ...) Run when a chat model starts...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.CallbackManagerMixin.html
cc59305487d1-1
Run when a chat model starts running. ATTENTION: This method is called for chat models. If you’re implementinga handler for a non-chat model, you should use on_llm_start instead. Parameters serialized (Dict[str, Any]) – messages (List[List[BaseMessage]]) – run_id (UUID) – parent_run_id (Optional[UUID]) – tags (Opti...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.CallbackManagerMixin.html
cc59305487d1-2
Parameters serialized (Dict[str, Any]) – query (str) – run_id (UUID) – parent_run_id (Optional[UUID]) – tags (Optional[List[str]]) – metadata (Optional[Dict[str, Any]]) – kwargs (Any) – Return type Any on_tool_start(serialized: Dict[str, Any], input_str: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.CallbackManagerMixin.html
7d012ffe9675-0
langchain_community.callbacks.infino_callback.import_tiktoken¶ langchain_community.callbacks.infino_callback.import_tiktoken() → Any[source]¶ Import tiktoken for counting tokens for OpenAI models. Return type Any
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.infino_callback.import_tiktoken.html
3445832987a2-0
langchain_community.callbacks.context_callback.ContextCallbackHandler¶ class langchain_community.callbacks.context_callback.ContextCallbackHandler(token: str = '', verbose: bool = False, **kwargs: Any)[source]¶ Callback Handler that records transcripts to the Context service. (https://context.ai). Keyword Arguments tok...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.context_callback.ContextCallbackHandler.html
3445832987a2-1
... input_variables=["product"], ... ), ... ) >>> chat_prompt_template = ChatPromptTemplate.from_messages( ... [human_message_prompt] ... ) >>> callback = ContextCallbackHandler(token) >>> # Note: the same callback object must be shared between the ... LLM and the chain. >>> chat = ChatOpenAI(temperature...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.context_callback.ContextCallbackHandler.html
3445832987a2-2
on_llm_error(error, *, run_id[, parent_run_id]) Run when LLM errors. :param error: The error that occurred. :type error: BaseException :param kwargs: Additional keyword arguments. - response (LLMResult): The response which was generated before the error occurred. :type kwargs: Any. on_llm_new_token(t...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.context_callback.ContextCallbackHandler.html
3445832987a2-3
verbose (bool) – kwargs (Any) – Return type None on_agent_action(action: AgentAction, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run on agent action. Parameters action (AgentAction) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any on_agent_finish(...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.context_callback.ContextCallbackHandler.html
3445832987a2-4
kwargs (Any) – Return type None on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], *, run_id: UUID, **kwargs: Any) → Any[source]¶ Run when the chat model is started. Parameters serialized (Dict[str, Any]) – messages (List[List[BaseMessage]]) – run_id (UUID) – kwargs (Any) – Return t...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.context_callback.ContextCallbackHandler.html
3445832987a2-5
run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any on_llm_start(serialized: Dict[str, Any], prompts: List[str], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any¶ Run when LLM starts ru...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.context_callback.ContextCallbackHandler.html
3445832987a2-6
kwargs (Any) – Return type 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¶ Run when Retriever starts running. Parameters serialized (Dict[str, Any]) –...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.context_callback.ContextCallbackHandler.html
3445832987a2-7
kwargs (Any) – Return type Any on_tool_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when tool errors. Parameters error (BaseException) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any on_tool_start(serialized: Dict[str...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.context_callback.ContextCallbackHandler.html
54f7afefaf05-0
langchain_core.callbacks.manager.AsyncCallbackManagerForToolRun¶ class langchain_core.callbacks.manager.AsyncCallbackManagerForToolRun(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, inheritabl...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManagerForToolRun.html
54f7afefaf05-1
on_tool_error(error, **kwargs) Run when tool errors. __init__(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, inheritable_tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = ...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManagerForToolRun.html
54f7afefaf05-2
Returns The sync RunManager. Return type CallbackManagerForToolRun async on_retry(retry_state: RetryCallState, **kwargs: Any) → None¶ Run on a retry event. Parameters retry_state (RetryCallState) – kwargs (Any) – Return type None async on_text(text: str, **kwargs: Any) → Any¶ Run when text is received. Parameters tex...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManagerForToolRun.html
e26eef488cca-0
langchain_community.callbacks.mlflow_callback.import_mlflow¶ langchain_community.callbacks.mlflow_callback.import_mlflow() → Any[source]¶ Import the mlflow python package and raise an error if it is not installed. Return type Any
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.mlflow_callback.import_mlflow.html
464c6736d844-0
langchain_core.callbacks.manager.shielded¶ langchain_core.callbacks.manager.shielded(func: Func) → Func[source]¶ Makes so an awaitable method is always shielded from cancellation Parameters func (Func) – Return type Func
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.shielded.html
b216dd0ddc3a-0
langchain_community.callbacks.infino_callback.import_infino¶ langchain_community.callbacks.infino_callback.import_infino() → Any[source]¶ Import the infino client. Return type Any
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.infino_callback.import_infino.html
4aa5858f488e-0
langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler¶ class langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler[source]¶ Callback handler that returns an async iterator. Attributes always_verbose ignore_agent Whether to ignore agent callbacks. ignore_chain Whether to ignore chain callbacks. ign...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler.html
4aa5858f488e-1
Run on retriever error. on_retriever_start(serialized, query, *, run_id) Run on retriever start. on_retry(retry_state, *, run_id[, parent_run_id]) Run on a retry event. on_text(text, *, run_id[, parent_run_id, tags]) Run on arbitrary text. on_tool_end(output, *, run_id[, ...]) Run when tool ends running. on_tool_error(...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler.html
4aa5858f488e-2
kwargs (Any) – Return type None async on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None¶ Run when chain ends running. Parameters outputs (Dict[str, Any]) – run_id (UUID) – parent_run_id (Optional[UUID]) – tags (Option...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler.html
4aa5858f488e-3
kwargs (Any) – Return type None async on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any¶ Run when a chat model starts running. ATTENT...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler.html
4aa5858f488e-4
token (str) – kwargs (Any) – Return type None async on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None[source]¶ Run when LLM starts running. ATTENTION: This method is called for non-chat models (regular LLMs). Ifyou’re implementing a handler for a chat model, you should use on_chat_mod...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler.html
4aa5858f488e-5
kwargs (Any) – Return type None async 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) → None¶ Run on retriever start. Parameters serialized (Dict[str, Any]) – q...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler.html
4aa5858f488e-6
Run when tool ends running. Parameters output (Any) – run_id (UUID) – parent_run_id (Optional[UUID]) – tags (Optional[List[str]]) – kwargs (Any) – Return type None async on_tool_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → Non...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler.html
5b00481e6c0b-0
langchain_community.callbacks.infino_callback.get_num_tokens¶ langchain_community.callbacks.infino_callback.get_num_tokens(string: str, openai_model_name: str) → int[source]¶ Calculate num tokens for OpenAI with tiktoken package. Official documentation: https://github.com/openai/openai-cookbook/blob/main/examples/How_t...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.infino_callback.get_num_tokens.html
b9f20b446d9c-0
langchain_community.callbacks.streamlit.mutable_expander.MutableExpander¶ class langchain_community.callbacks.streamlit.mutable_expander.MutableExpander(parent_container: DeltaGenerator, label: str, expanded: bool)[source]¶ Streamlit expander that can be renamed and dynamically expanded/collapsed. Create a new MutableE...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.mutable_expander.MutableExpander.html
b9f20b446d9c-1
st.expander instance when its label changes, and it uses parent_container to ensure it recreates this underlying expander in the same location onscreen. label (str) – The expander’s initial label. expanded (bool) – The expander’s initial expanded value. append_copy(other: MutableExpander) → None[source]¶ Append a copy ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.mutable_expander.MutableExpander.html