id
stringlengths
14
16
text
stringlengths
20
3.26k
source
stringlengths
65
181
4d25b106ae19-0
langchain_community.callbacks.wandb_callback.WandbCallbackHandler¶ class langchain_community.callbacks.wandb_callback.WandbCallbackHandler(job_type: Optional[str] = None, project: Optional[str] = 'langchain_callback_demo', entity: Optional[str] = None, tags: Optional[Sequence] = None, group: Optional[str] = None, name:...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.wandb_callback.WandbCallbackHandler.html
4d25b106ae19-1
ignore_retriever Whether to ignore retriever callbacks. ignore_retry Whether to ignore retry callbacks. raise_error run_inline Methods __init__([job_type, project, entity, tags, ...]) Initialize callback handler. flush_tracker([langchain_asset, reset, ...]) Flush the tracker and reset the session. get_custom_callback_m...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.wandb_callback.WandbCallbackHandler.html
4d25b106ae19-2
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__(job_type: Optional[str...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.wandb_callback.WandbCallbackHandler.html
4d25b106ae19-3
Flush the tracker and reset the session. Parameters langchain_asset (Optional[Any]) – The langchain asset to save. reset (bool) – Whether to reset the session. finish (bool) – Whether to finish the run. job_type (Optional[str]) – The job type. project (Optional[str]) – The project. entity (Optional[str]) – The entity. ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.wandb_callback.WandbCallbackHandler.html
4d25b106ae19-4
error (BaseException) – kwargs (Any) – Return type None on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any) → None[source]¶ Run when chain starts running. Parameters serialized (Dict[str, Any]) – inputs (Dict[str, Any]) – kwargs (Any) – Return type None on_chat_model_start(serialized:...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.wandb_callback.WandbCallbackHandler.html
4d25b106ae19-5
on_llm_new_token(token: str, **kwargs: Any) → None[source]¶ Run when LLM generates a new token. Parameters 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 (L...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.wandb_callback.WandbCallbackHandler.html
4d25b106ae19-6
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) → Any¶ Run on a retry event. Parameters retry...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.wandb_callback.WandbCallbackHandler.html
0a09249fb9a0-0
langchain_community.callbacks.wandb_callback.construct_html_from_prompt_and_generation¶ langchain_community.callbacks.wandb_callback.construct_html_from_prompt_and_generation(prompt: str, generation: str) → Any[source]¶ Construct an html element from a prompt and a generation. Parameters prompt (str) – The prompt. gene...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.wandb_callback.construct_html_from_prompt_and_generation.html
b1a3e9dba01e-0
langchain_nvidia_ai_endpoints.callbacks.standardize_model_name¶ langchain_nvidia_ai_endpoints.callbacks.standardize_model_name(model_name: str, price_map: dict = {}, 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...
https://api.python.langchain.com/en/latest/callbacks/langchain_nvidia_ai_endpoints.callbacks.standardize_model_name.html
f4fc20c84f40-0
langchain_community.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler¶ class langchain_community.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler(parent_container: DeltaGenerator, *, max_thought_containers: int = 4, expand_new_thoughts: bool = True, collapse_completed_though...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler.html
f4fc20c84f40-1
Create a StreamlitCallbackHandler instance. on_agent_action(action[, color]) Run on agent action. on_agent_finish(finish[, color]) Run on agent end. on_chain_end(outputs, **kwargs) Run when chain ends running. on_chain_error(error, **kwargs) Run when chain errors. on_chain_start(serialized, inputs, **kwargs) Run when c...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler.html
f4fc20c84f40-2
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. __init__(parent_container: DeltaGenerator, *, max_thought_containers: int = 4, expand_new_thoughts: bool = True, collapse_completed_thoughts: bool = True, thought...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler.html
f4fc20c84f40-3
Run on agent end. Parameters finish (AgentFinish) – color (Optional[str]) – kwargs (Any) – Return type None on_chain_end(outputs: Dict[str, Any], **kwargs: Any) → None[source]¶ Run when chain ends running. Parameters outputs (Dict[str, Any]) – kwargs (Any) – Return type None on_chain_error(error: BaseException, **...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler.html
f4fc20c84f40-4
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_error(error: BaseException, **kwargs: Any) → None[source]¶ Run when LLM errors. :param error: The error that occurred. :typ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler.html
f4fc20c84f40-5
Run when Retriever ends running. Parameters documents (Sequence[Document]) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when Retriever errors. Parameters err...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler.html
f4fc20c84f40-6
Run on arbitrary text. Parameters text (str) – color (Optional[str]) – end (str) – kwargs (Any) – Return type None on_tool_end(output: Any, color: Optional[str] = None, observation_prefix: Optional[str] = None, llm_prefix: Optional[str] = None, **kwargs: Any) → None[source]¶ Run when tool ends running. Parameters o...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler.html
b4a9310f30d6-0
langchain_community.callbacks.promptlayer_callback.PromptLayerCallbackHandler¶ class langchain_community.callbacks.promptlayer_callback.PromptLayerCallbackHandler(pl_id_callback: Optional[Callable[[...], Any]] = None, pl_tags: Optional[List[str]] = None)[source]¶ Callback handler for promptlayer. Initialize the PromptL...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.promptlayer_callback.PromptLayerCallbackHandler.html
b4a9310f30d6-1
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.promptlayer_callback.PromptLayerCallbackHandler.html
b4a9310f30d6-2
Initialize the PromptLayerCallbackHandler. Parameters pl_id_callback (Optional[Callable[[...], Any]]) – pl_tags (Optional[List[str]]) – 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...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.promptlayer_callback.PromptLayerCallbackHandler.html
b4a9310f30d6-3
kwargs (Any) – Return type Any on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], *, 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 chain starts running. Parameters serialized (Dict[str, Any...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.promptlayer_callback.PromptLayerCallbackHandler.html
b4a9310f30d6-4
run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type None on_llm_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when LLM errors. :param error: The error that occurred. :type error: BaseException :param kwargs: Additional keyword arg...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.promptlayer_callback.PromptLayerCallbackHandler.html
b4a9310f30d6-5
you should use on_chat_model_start instead. Parameters serialized (Dict[str, Any]) – prompts (List[str]) – run_id (UUID) – parent_run_id (Optional[UUID]) – tags (Optional[List[str]]) – kwargs (Any) – Return type Any on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = N...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.promptlayer_callback.PromptLayerCallbackHandler.html
b4a9310f30d6-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.promptlayer_callback.PromptLayerCallbackHandler.html
b4a9310f30d6-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.promptlayer_callback.PromptLayerCallbackHandler.html
0aee67a3b3fe-0
langchain_community.callbacks.aim_callback.BaseMetadataCallbackHandler¶ class langchain_community.callbacks.aim_callback.BaseMetadataCallbackHandler[source]¶ Callback handler for the metadata and associated function states for callbacks. step¶ The current step. Type int starts¶ The number of times the start method has ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.aim_callback.BaseMetadataCallbackHandler.html
0aee67a3b3fe-1
Type int Attributes always_verbose Whether to call verbose callbacks even if verbose is False. ignore_agent Whether to ignore agent callbacks. ignore_chain Whether to ignore chain callbacks. ignore_llm Whether to ignore LLM callbacks. ignore_retriever Whether to ignore retriever callbacks. Methods __init__() get_custom...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.aim_callback.BaseMetadataCallbackHandler.html
890391446327-0
langchain_core.callbacks.manager.CallbackManagerForToolRun¶ class langchain_core.callbacks.manager.CallbackManagerForToolRun(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, inheritable_tags: Op...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForToolRun.html
890391446327-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.CallbackManagerForToolRun.html
890391446327-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 on_tool_end(output: Any, **kwargs: Any) → None[source]¶ Run when tool ends running. Parameters output (Any) ...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForToolRun.html
b6c6a96fe0e7-0
langchain_core.callbacks.manager.AsyncCallbackManagerForRetrieverRun¶ class langchain_core.callbacks.manager.AsyncCallbackManagerForRetrieverRun(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, ...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManagerForRetrieverRun.html
b6c6a96fe0e7-1
Run on a retry event. 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: Optiona...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManagerForRetrieverRun.html
b6c6a96fe0e7-2
Returns The sync RunManager. Return type CallbackManagerForRetrieverRun async on_retriever_end(documents: Sequence[Document], **kwargs: Any) → None[source]¶ Run when retriever ends running. Parameters documents (Sequence[Document]) – kwargs (Any) – Return type None async on_retriever_error(error: BaseException, **kwa...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManagerForRetrieverRun.html
ac949d51c666-0
langchain_core.callbacks.base.RunManagerMixin¶ class langchain_core.callbacks.base.RunManagerMixin[source]¶ Mixin for run manager. Methods __init__() on_retry(retry_state, *, run_id[, parent_run_id]) Run on a retry event. on_text(text, *, run_id[, parent_run_id]) Run on arbitrary text. __init__()¶ on_retry(retry_state:...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.RunManagerMixin.html
d2d6f25a1b94-0
langchain_community.callbacks.comet_ml_callback.import_comet_ml¶ langchain_community.callbacks.comet_ml_callback.import_comet_ml() → Any[source]¶ Import comet_ml and raise an error if it is not installed. Return type Any
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.comet_ml_callback.import_comet_ml.html
2927fd6e2fb7-0
langchain_community.callbacks.streamlit.streamlit_callback_handler.LLMThoughtLabeler¶ class langchain_community.callbacks.streamlit.streamlit_callback_handler.LLMThoughtLabeler[source]¶ Generates markdown labels for LLMThought containers. Pass a custom subclass of this to StreamlitCallbackHandler to override its defaul...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.streamlit_callback_handler.LLMThoughtLabeler.html
529e27ba3e55-0
langchain.callbacks.streaming_stdout_final_only.FinalStreamingStdOutCallbackHandler¶ class langchain.callbacks.streaming_stdout_final_only.FinalStreamingStdOutCallbackHandler(*, answer_prefix_tokens: Optional[List[str]] = None, strip_tokens: bool = True, stream_prefix: bool = False)[source]¶ Callback handler for stream...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_stdout_final_only.FinalStreamingStdOutCallbackHandler.html
529e27ba3e55-1
Run when chain starts running. on_chat_model_start(serialized, messages, ...) Run when LLM starts running. on_llm_end(response, **kwargs) Run when LLM ends running. on_llm_error(error, **kwargs) Run when LLM errors. on_llm_new_token(token, **kwargs) Run on new LLM token. on_llm_start(serialized, prompts, **kwargs) Run ...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_stdout_final_only.FinalStreamingStdOutCallbackHandler.html
529e27ba3e55-2
answer_prefix_tokens to last tokens? (to determine if answer has been reached) stream_prefix (bool) – Should answer prefix itself also be streamed? Return type None append_to_last_tokens(token: str) → None[source]¶ Parameters token (str) – Return type None check_if_answer_reached() → bool[source]¶ Return type bool on_...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_stdout_final_only.FinalStreamingStdOutCallbackHandler.html
529e27ba3e55-3
messages (List[List[BaseMessage]]) – kwargs (Any) – Return type None on_llm_end(response: LLMResult, **kwargs: Any) → None¶ Run when LLM ends running. Parameters response (LLMResult) – kwargs (Any) – Return type None on_llm_error(error: BaseException, **kwargs: Any) → None¶ Run when LLM errors. Parameters error (Ba...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_stdout_final_only.FinalStreamingStdOutCallbackHandler.html
529e27ba3e55-4
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[str, Any]] = None, **kwargs: ...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_stdout_final_only.FinalStreamingStdOutCallbackHandler.html
529e27ba3e55-5
Parameters error (BaseException) – kwargs (Any) – Return type None on_tool_start(serialized: Dict[str, Any], input_str: str, **kwargs: Any) → None¶ Run when tool starts running. Parameters serialized (Dict[str, Any]) – input_str (str) – kwargs (Any) – Return type None
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_stdout_final_only.FinalStreamingStdOutCallbackHandler.html
43c39e019d02-0
langchain_community.callbacks.flyte_callback.analyze_text¶ langchain_community.callbacks.flyte_callback.analyze_text(text: str, nlp: Optional[Any] = None, textstat: Optional[Any] = None) → dict[source]¶ Analyze text using textstat and spacy. Parameters text (str) – The text to analyze. nlp (spacy.lang) – The spacy lang...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.flyte_callback.analyze_text.html
ede3615684ea-0
langchain.callbacks.tracers.logging.LoggingCallbackHandler¶ class langchain.callbacks.tracers.logging.LoggingCallbackHandler(logger: Logger, log_level: int = 20, extra: Optional[dict] = None, **kwargs: Any)[source]¶ Tracer that logs via the input Logger. Initialize the tracer. Parameters _schema_format – Primarily chan...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.tracers.logging.LoggingCallbackHandler.html
ede3615684ea-1
Run on agent end. on_chain_end(outputs, *, run_id[, inputs]) End a trace for a chain run. on_chain_error(error, *[, inputs]) Handle an error for a chain run. on_chain_start(serialized, inputs, *, run_id) Start a trace for a chain run. on_chat_model_start(serialized, messages, *, ...) Start a trace for an LLM run. on_ll...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.tracers.logging.LoggingCallbackHandler.html
ede3615684ea-2
Handle an error for a tool run. on_tool_start(serialized, input_str, *, run_id) Start a trace for a tool run. __init__(logger: Logger, log_level: int = 20, extra: Optional[dict] = None, **kwargs: Any) → None[source]¶ Initialize the tracer. Parameters _schema_format – Primarily changes how the inputs and outputs are han...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.tracers.logging.LoggingCallbackHandler.html
ede3615684ea-3
kwargs (Any) – Return type Any on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ 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], ...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.tracers.logging.LoggingCallbackHandler.html
ede3615684ea-4
run_id (UUID) – tags (Optional[List[str]]) – parent_run_id (Optional[UUID]) – metadata (Optional[Dict[str, Any]]) – run_type (Optional[str]) – 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[L...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.tracers.logging.LoggingCallbackHandler.html
ede3615684ea-5
run_id (UUID) – kwargs (Any) – Return type Run on_llm_new_token(token: str, *, chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Run¶ Run on new LLM token. Only available when streaming is enabled. Parameters token (str) – chunk ...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.tracers.logging.LoggingCallbackHandler.html
ede3615684ea-6
Run when Retriever errors. Parameters error (BaseException) – 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[st...
https://api.python.langchain.com/en/latest/callbacks/langchain.callbacks.tracers.logging.LoggingCallbackHandler.html
ede3615684ea-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.callbacks.tracers.logging.LoggingCallbackHandler.html
0190e2f87843-0
langchain_community.callbacks.llmonitor_callback.UserContextManager¶ class langchain_community.callbacks.llmonitor_callback.UserContextManager(user_id: str, user_props: Optional[Any] = None)[source]¶ Context manager for LLMonitor user context. Methods __init__(user_id[, user_props]) Parameters user_id (str) – user_pro...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.llmonitor_callback.UserContextManager.html
5fde57dc5919-0
langchain_community.callbacks.manager.wandb_tracing_enabled¶ langchain_community.callbacks.manager.wandb_tracing_enabled(session_name: str = 'default') → Generator[None, None, None][source]¶ Get the WandbTracer in a context manager. Parameters session_name (str, optional) – The name of the session. Defaults to “default...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.manager.wandb_tracing_enabled.html
3b83e9383ac5-0
langchain_community.callbacks.fiddler_callback.import_fiddler¶ langchain_community.callbacks.fiddler_callback.import_fiddler() → Any[source]¶ Import the fiddler 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.fiddler_callback.import_fiddler.html
80b782d58e71-0
langchain_core.callbacks.manager.AsyncParentRunManager¶ class langchain_core.callbacks.manager.AsyncParentRunManager(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, inheritable_tags: Optional[L...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncParentRunManager.html
80b782d58e71-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.AsyncParentRunManager.html
80b782d58e71-2
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 text (str) – The received text. kwargs (Any) – Returns The result of ...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncParentRunManager.html
a7177309660e-0
langchain_community.callbacks.utils.import_spacy¶ langchain_community.callbacks.utils.import_spacy() → Any[source]¶ Import the spacy 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_spacy.html
9c25e6323c05-0
langchain_community.callbacks.uptrain_callback.UpTrainDataSchema¶ class langchain_community.callbacks.uptrain_callback.UpTrainDataSchema(project_name: str)[source]¶ The UpTrain data schema for tracking evaluation results. Parameters project_name (str) – The project name to be shown in UpTrain dashboard. project_name¶ T...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.uptrain_callback.UpTrainDataSchema.html
ce435a0b9000-0
langchain_community.callbacks.labelstudio_callback.LabelStudioCallbackHandler¶ class langchain_community.callbacks.labelstudio_callback.LabelStudioCallbackHandler(api_key: Optional[str] = None, url: Optional[str] = None, project_id: Optional[int] = None, project_name: str = 'LangChain-%Y-%m-%d', project_config: Optiona...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.labelstudio_callback.LabelStudioCallbackHandler.html
ce435a0b9000-1
ignore_retry Whether to ignore retry callbacks. raise_error run_inline Methods __init__([api_key, url, project_id, ...]) add_prompts_generations(run_id, generations) on_agent_action(action, **kwargs) Do nothing when agent takes a specific action. on_agent_finish(finish, **kwargs) Do nothing on_chain_end(outputs, **kwar...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.labelstudio_callback.LabelStudioCallbackHandler.html
ce435a0b9000-2
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__(api_key: Optional[str] = None, url: Optional[str] = None, project_id: Optional[int] = None,...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.labelstudio_callback.LabelStudioCallbackHandler.html
ce435a0b9000-3
kwargs (Any) – Return type None on_chain_error(error: BaseException, **kwargs: Any) → None[source]¶ Do nothing when LLM chain outputs an error. Parameters error (BaseException) – kwargs (Any) – Return type None on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any) → None[source]¶ Run when...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.labelstudio_callback.LabelStudioCallbackHandler.html
ce435a0b9000-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]¶ Save the ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.labelstudio_callback.LabelStudioCallbackHandler.html
ce435a0b9000-5
Run when Retriever starts running. 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: Option...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.labelstudio_callback.LabelStudioCallbackHandler.html
ce435a0b9000-6
Parameters serialized (Dict[str, Any]) – input_str (str) – kwargs (Any) – Return type None Examples using LabelStudioCallbackHandler¶ Label Studio
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.labelstudio_callback.LabelStudioCallbackHandler.html
5f4fde4f06db-0
langchain_community.callbacks.human.HumanRejectedException¶ class langchain_community.callbacks.human.HumanRejectedException[source]¶ Exception to raise when a person manually review and rejects a value.
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.human.HumanRejectedException.html
d6c68468c6cd-0
langchain_core.callbacks.base.BaseCallbackHandler¶ class langchain_core.callbacks.base.BaseCallbackHandler[source]¶ Base 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 ignore ...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.BaseCallbackHandler.html
d6c68468c6cd-1
Run when LLM starts running. on_retriever_end(documents, *, run_id[, ...]) Run when Retriever ends running. on_retriever_error(error, *, run_id[, ...]) Run when Retriever errors. on_retriever_start(serialized, query, *, run_id) Run when Retriever starts running. on_retry(retry_state, *, run_id[, parent_run_id]) Run on ...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.BaseCallbackHandler.html
d6c68468c6cd-2
kwargs (Any) – Return type Any on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ 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: ...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.BaseCallbackHandler.html
d6c68468c6cd-3
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.BaseCallbackHandler.html
d6c68468c6cd-4
Run on new LLM token. Only available when streaming is enabled. Parameters token (str) – The new token. chunk (GenerationChunk | ChatGenerationChunk) – The new generated chunk, information. (containing content and other) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any on_llm_start(...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.BaseCallbackHandler.html
d6c68468c6cd-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_core.callbacks.base.BaseCallbackHandler.html
d6c68468c6cd-6
Run when tool ends running. Parameters output (Any) – run_id (UUID) – parent_run_id (Optional[UUID]) – 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 (UUI...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.BaseCallbackHandler.html
19fd9dfe4d97-0
langchain_community.callbacks.utils.hash_string¶ langchain_community.callbacks.utils.hash_string(s: str) → str[source]¶ Hash a string using sha1. Parameters s (str) – The string to hash. Returns The hashed string. Return type (str)
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.utils.hash_string.html
df6a2709ecfa-0
langchain_core.callbacks.manager.CallbackManagerForLLMRun¶ class langchain_core.callbacks.manager.CallbackManagerForLLMRun(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, inheritable_tags: Opti...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForLLMRun.html
df6a2709ecfa-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.CallbackManagerForLLMRun.html
df6a2709ecfa-2
kwargs (Any) – Additional keyword arguments. - response (LLMResult): The response which was generated before the error occurred. Return type None on_llm_new_token(token: str, *, chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None, **kwargs: Any) → None[source]¶ Run when LLM generates a new token. Parame...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForLLMRun.html
548f4b482824-0
langchain_community.callbacks.argilla_callback.ArgillaCallbackHandler¶ class langchain_community.callbacks.argilla_callback.ArgillaCallbackHandler(dataset_name: str, workspace_name: Optional[str] = None, api_url: Optional[str] = None, api_key: Optional[str] = None)[source]¶ Callback Handler that logs into Argilla. Para...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.argilla_callback.ArgillaCallbackHandler.html
548f4b482824-1
... api_key="argilla.apikey", ... ) >>> llm = OpenAI( ... temperature=0, ... callbacks=[argilla_callback], ... verbose=True, ... openai_api_key="API_KEY_HERE", ... ) >>> llm.generate([ ... "What is the best NLP-annotation tool out there? (no bias at all)", ... ]) "Argilla, no doubt about it." In...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.argilla_callback.ArgillaCallbackHandler.html
548f4b482824-2
ignore_chain Whether to ignore chain callbacks. ignore_chat_model 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__(dataset_name[, workspace_n...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.argilla_callback.ArgillaCallbackHandler.html
548f4b482824-3
on_retriever_error(error, *, run_id[, ...]) Run when Retriever errors. on_retriever_start(serialized, query, *, run_id) Run when Retriever starts running. on_retry(retry_state, *, run_id[, parent_run_id]) Run on a retry event. on_text(text, **kwargs) Do nothing on_tool_end(output[, observation_prefix, ...]) Do nothing ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.argilla_callback.ArgillaCallbackHandler.html
548f4b482824-4
means that either ARGILLA_API_KEY environment variable or the default will be used. Raises ImportError – if the argilla package is not installed. ConnectionError – if the connection to Argilla fails. FileNotFoundError – if the FeedbackDataset retrieval from Argilla fails. Return type None on_agent_action(action: AgentA...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.argilla_callback.ArgillaCallbackHandler.html
548f4b482824-5
when the chain starts. 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: Optional[Dict...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.argilla_callback.ArgillaCallbackHandler.html
548f4b482824-6
token (str) – kwargs (Any) – Return type None on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None[source]¶ Save the prompts in memory when an LLM starts. Parameters serialized (Dict[str, Any]) – prompts (List[str]) – kwargs (Any) – Return type None on_retriever_end(documents: Sequenc...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.argilla_callback.ArgillaCallbackHandler.html
548f4b482824-7
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.argilla_callback.ArgillaCallbackHandler.html
a3dbace82499-0
langchain_community.callbacks.wandb_callback.load_json_to_dict¶ langchain_community.callbacks.wandb_callback.load_json_to_dict(json_path: Union[str, Path]) → dict[source]¶ Load json file to a dictionary. Parameters json_path (str) – The path to the json file. Returns The dictionary representation of the json file. Retu...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.wandb_callback.load_json_to_dict.html
0c3e59c76edc-0
langchain_community.callbacks.aim_callback.import_aim¶ langchain_community.callbacks.aim_callback.import_aim() → Any[source]¶ Import the aim 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.aim_callback.import_aim.html
92128f2973c2-0
langchain_community.callbacks.trubrics_callback.TrubricsCallbackHandler¶ class langchain_community.callbacks.trubrics_callback.TrubricsCallbackHandler(project: str = 'default', email: Optional[str] = None, password: Optional[str] = None, **kwargs: Any)[source]¶ Callback handler for Trubrics. Parameters project (str) – ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.trubrics_callback.TrubricsCallbackHandler.html
92128f2973c2-1
on_llm_end(response, run_id, **kwargs) Run when LLM ends running. 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 ...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.trubrics_callback.TrubricsCallbackHandler.html
92128f2973c2-2
Parameters project (str) – email (Optional[str]) – password (Optional[str]) – 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 (Opti...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.trubrics_callback.TrubricsCallbackHandler.html
92128f2973c2-3
kwargs (Any) – Return type Any on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], *, 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 chain starts running. Parameters serialized (Dict[str, Any...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.trubrics_callback.TrubricsCallbackHandler.html
92128f2973c2-4
:type error: BaseException :param kwargs: Additional keyword arguments. response (LLMResult): The response which was generated beforethe error occurred. Parameters error (BaseException) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any on_llm_new_token(token: str, *, chunk: Optional[...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.trubrics_callback.TrubricsCallbackHandler.html
92128f2973c2-5
run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when Retriever errors. Parameters error (BaseException) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwarg...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.trubrics_callback.TrubricsCallbackHandler.html
92128f2973c2-6
Run on arbitrary text. Parameters text (str) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any on_tool_end(output: Any, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when tool ends running. Parameters output (Any) – run_id (UUID) – parent_run_id (...
https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.trubrics_callback.TrubricsCallbackHandler.html
1ac45ade5769-0
langchain_core.callbacks.manager.AsyncCallbackManagerForLLMRun¶ class langchain_core.callbacks.manager.AsyncCallbackManagerForLLMRun(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, inheritable_...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManagerForLLMRun.html
1ac45ade5769-1
on_retry(retry_state, **kwargs) Run on a retry event. 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...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManagerForLLMRun.html
1ac45ade5769-2
kwargs (Any) – Return type None async on_llm_error(error: BaseException, **kwargs: Any) → None[source]¶ Run when LLM errors. Parameters error (Exception or KeyboardInterrupt) – The error. kwargs (Any) – Additional keyword arguments. - response (LLMResult): The response which was generated before the error occurred. Re...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManagerForLLMRun.html
15b3fd488fe3-0
langchain_community.callbacks.wandb_callback.import_wandb¶ langchain_community.callbacks.wandb_callback.import_wandb() → Any[source]¶ Import the wandb 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.wandb_callback.import_wandb.html
08f3abed27e6-0
langchain_core.callbacks.base.ChainManagerMixin¶ class langchain_core.callbacks.base.ChainManagerMixin[source]¶ Mixin for chain callbacks. Methods __init__() on_agent_action(action, *, run_id[, ...]) Run on agent action. on_agent_finish(finish, *, run_id[, ...]) Run on agent end. on_chain_end(outputs, *, run_id[, paren...
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.ChainManagerMixin.html
08f3abed27e6-1
kwargs (Any) – Return type Any on_chain_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any[source]¶ Run when chain errors. Parameters error (BaseException) – run_id (UUID) – parent_run_id (Optional[UUID]) – kwargs (Any) – Return type Any
https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.ChainManagerMixin.html