id
stringlengths
14
16
text
stringlengths
13
2.7k
source
stringlengths
57
178
8c4d3a6397f3-2
Log the latency, error, token usage, and response to Infino. on_llm_error(error: BaseException, **kwargs: Any) → None[source]¶ Set the error flag. on_llm_new_token(token: str, **kwargs: Any) → None[source]¶ Do nothing when a new token is generated. on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: ...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.infino_callback.InfinoCallbackHandler.html
8c4d3a6397f3-3
Do nothing when tool ends. on_tool_error(error: BaseException, **kwargs: Any) → None[source]¶ Do nothing when tool outputs an error. on_tool_start(serialized: Dict[str, Any], input_str: str, **kwargs: Any) → None[source]¶ Do nothing when tool starts. Examples using InfinoCallbackHandler¶ Infino
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.infino_callback.InfinoCallbackHandler.html
36bf112c7999-0
langchain.callbacks.utils.import_textstat¶ langchain.callbacks.utils.import_textstat() → Any[source]¶ Import the textstat python package and raise an error if it is not installed.
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.utils.import_textstat.html
41ba8b8c5f32-0
langchain.callbacks.mlflow_callback.MlflowLogger¶ class langchain.callbacks.mlflow_callback.MlflowLogger(**kwargs: Any)[source]¶ Callback Handler that logs metrics and artifacts to mlflow server. Parameters name (str) – Name of the run. experiment (str) – Name of the experiment. tags (dict) – Tags to be attached for th...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.mlflow_callback.MlflowLogger.html
41ba8b8c5f32-1
To log the input data as json file artifact. langchain_artifact(chain: Any) → None[source]¶ metric(key: str, value: float) → None[source]¶ To log metric to mlflow server. metrics(data: Union[Dict[str, float], Dict[str, int]], step: Optional[int] = 0) → None[source]¶ To log all metrics in the input dict. start_run(name:...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.mlflow_callback.MlflowLogger.html
e425c76755f6-0
langchain.callbacks.streamlit.mutable_expander.MutableExpander¶ class langchain.callbacks.streamlit.mutable_expander.MutableExpander(parent_container: DeltaGenerator, label: str, expanded: bool)[source]¶ A Streamlit expander that can be renamed and dynamically expanded/collapsed. Create a new MutableExpander. Parameter...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streamlit.mutable_expander.MutableExpander.html
e425c76755f6-1
parent_container to ensure it recreates this underlying expander in the same location onscreen. label – The expander’s initial label. expanded – The expander’s initial expanded value. append_copy(other: MutableExpander) → None[source]¶ Append a copy of another MutableExpander’s children to this MutableExpander. clear()...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streamlit.mutable_expander.MutableExpander.html
2f5fbd8ab244-0
langchain.callbacks.openai_info.get_openai_token_cost_for_model¶ langchain.callbacks.openai_info.get_openai_token_cost_for_model(model_name: str, num_tokens: int, is_completion: bool = False) → float[source]¶ Get the cost in USD for a given model and number of tokens. Parameters model_name – Name of the model num_token...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.openai_info.get_openai_token_cost_for_model.html
a3333c103a0a-0
langchain.callbacks.mlflow_callback.import_mlflow¶ langchain.callbacks.mlflow_callback.import_mlflow() → Any[source]¶ Import the mlflow python package and raise an error if it is not installed.
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.mlflow_callback.import_mlflow.html
1ee38df92f76-0
langchain.callbacks.streaming_stdout.StreamingStdOutCallbackHandler¶ class langchain.callbacks.streaming_stdout.StreamingStdOutCallbackHandler[source]¶ Callback handler for streaming. Only works with LLMs that support streaming. Attributes ignore_agent Whether to ignore agent callbacks. ignore_chain Whether to ignore c...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_stdout.StreamingStdOutCallbackHandler.html
1ee38df92f76-1
Run when Retriever starts running. on_retry(retry_state, *, run_id[, parent_run_id]) Run on a retry event. on_text(text, **kwargs) Run on arbitrary text. 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...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_stdout.StreamingStdOutCallbackHandler.html
1ee38df92f76-2
Run on new LLM token. Only available when streaming is enabled. on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None[source]¶ Run when LLM starts running. on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when R...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_stdout.StreamingStdOutCallbackHandler.html
1ee38df92f76-3
🚅 LiteLLM Ollama GPT4All Arthur Chat Over Documents with Vectara TextGen Llama.cpp Titan Takeoff Eden AI C Transformers Huggingface TextGen Inference Replicate Run LLMs locally Set env var OPENAI_API_KEY or load from a .env file Use local LLMs WebResearchRetriever
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_stdout.StreamingStdOutCallbackHandler.html
583fb4b1eef5-0
langchain.callbacks.utils.BaseMetadataCallbackHandler¶ class langchain.callbacks.utils.BaseMetadataCallbackHandler[source]¶ This class handles the metadata and associated function states for callbacks. step¶ The current step. Type int starts¶ The number of times the start method has been called. Type int ends¶ The numb...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.utils.BaseMetadataCallbackHandler.html
583fb4b1eef5-1
Type int on_llm_start_records¶ A list of records of the on_llm_start method. Type list on_llm_token_records¶ A list of records of the on_llm_token method. Type list on_llm_end_records¶ A list of records of the on_llm_end method. Type list on_chain_start_records¶ A list of records of the on_chain_start method. Type list...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.utils.BaseMetadataCallbackHandler.html
8fc50bcd2d0f-0
langchain.callbacks.labelstudio_callback.LabelStudioMode¶ class langchain.callbacks.labelstudio_callback.LabelStudioMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶ Label Studio mode enumerator. PROMPT = 'prompt'¶ CHAT = 'chat'¶
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.labelstudio_callback.LabelStudioMode.html
f285c736deb1-0
langchain.callbacks.utils.hash_string¶ langchain.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)
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.utils.hash_string.html
554aecce3fb8-0
langchain.callbacks.file.FileCallbackHandler¶ class langchain.callbacks.file.FileCallbackHandler(filename: str, mode: str = 'a', color: Optional[str] = None)[source]¶ Callback Handler that writes to a file. Initialize callback handler. Attributes ignore_agent Whether to ignore agent callbacks. ignore_chain Whether to i...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.file.FileCallbackHandler.html
554aecce3fb8-1
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 a retry event. on_text(text[, color, end]) Run when agent ends. on_tool_end...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.file.FileCallbackHandler.html
554aecce3fb8-2
Print out that we are entering a chain. 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. on_ll...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.file.FileCallbackHandler.html
554aecce3fb8-3
Run when Retriever ends running. on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when Retriever errors. on_retriever_start(serialized: Dict[str, Any], query: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = ...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.file.FileCallbackHandler.html
554cd4fd2c6b-0
langchain.callbacks.manager.wandb_tracing_enabled¶ langchain.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”. Returns None Exam...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.manager.wandb_tracing_enabled.html
583be1487390-0
langchain.callbacks.comet_ml_callback.import_comet_ml¶ langchain.callbacks.comet_ml_callback.import_comet_ml() → Any[source]¶ Import comet_ml and raise an error if it is not installed.
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.comet_ml_callback.import_comet_ml.html
fb39da53b825-0
langchain.callbacks.whylabs_callback.import_langkit¶ langchain.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 – Whether to import the langkit...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.whylabs_callback.import_langkit.html
24f3d9285d4f-0
langchain.callbacks.streamlit.mutable_expander.ChildType¶ class langchain.callbacks.streamlit.mutable_expander.ChildType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶ The enumerator of the child type. MARKDOWN = 'MARKDOWN'¶ EXCEPTION = 'EXCEPTION'¶
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streamlit.mutable_expander.ChildType.html
401755dce443-0
langchain.callbacks.promptlayer_callback.PromptLayerCallbackHandler¶ class langchain.callbacks.promptlayer_callback.PromptLayerCallbackHandler(pl_id_callback: Optional[Callable[[...], Any]] = None, pl_tags: Optional[List[str]] = None)[source]¶ Callback handler for promptlayer. Initialize the PromptLayerCallbackHandler....
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.promptlayer_callback.PromptLayerCallbackHandler.html
401755dce443-1
on_llm_start(serialized, prompts, *, run_id) 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(ret...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.promptlayer_callback.PromptLayerCallbackHandler.html
401755dce443-2
Run when chain ends running. on_chain_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when chain errors. 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...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.promptlayer_callback.PromptLayerCallbackHandler.html
401755dce443-3
information. (containing content and other) – on_llm_start(serialized: Dict[str, Any], prompts: List[str], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → Any[source]¶ Run when LLM starts running. on_retriever_end(documents: Sequence[Document], *, run_id: UUID,...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.promptlayer_callback.PromptLayerCallbackHandler.html
401755dce443-4
Run when tool errors. 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, **kwargs: Any) → Any¶ Run when tool starts running. Examples using PromptLayerCallbackHandler¶ PromptLayer
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.promptlayer_callback.PromptLayerCallbackHandler.html
280c3ff68fa7-0
langchain.callbacks.streaming_aiter_final_only.AsyncFinalIteratorCallbackHandler¶ class langchain.callbacks.streaming_aiter_final_only.AsyncFinalIteratorCallbackHandler(*, answer_prefix_tokens: Optional[List[str]] = None, strip_tokens: bool = True, stream_prefix: bool = False)[source]¶ Callback handler that returns an ...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter_final_only.AsyncFinalIteratorCallbackHandler.html
280c3ff68fa7-1
Run when chain starts running. on_chat_model_start(serialized, messages, *, ...) Run when a chat model 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, **...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter_final_only.AsyncFinalIteratorCallbackHandler.html
280c3ff68fa7-2
strip_tokens – Ignore white spaces and new lines when comparing answer_prefix_tokens to last tokens? (to determine if answer has been reached) stream_prefix – Should answer prefix itself also be streamed? async aiter() → AsyncIterator[str]¶ append_to_last_tokens(token: str) → None[source]¶ check_if_answer_reached() → b...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter_final_only.AsyncFinalIteratorCallbackHandler.html
280c3ff68fa7-3
Run when chain starts running. 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. async on...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter_final_only.AsyncFinalIteratorCallbackHandler.html
280c3ff68fa7-4
Run on retriever start. async on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run on a retry event. async on_text(text: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None¶ Run on arbitrary...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter_final_only.AsyncFinalIteratorCallbackHandler.html
dad35dd2846a-0
langchain.callbacks.mlflow_callback.construct_html_from_prompt_and_generation¶ langchain.callbacks.mlflow_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. generation (str) – The...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.mlflow_callback.construct_html_from_prompt_and_generation.html
aa72ef2f0bd4-0
langchain.callbacks.openai_info.OpenAICallbackHandler¶ class langchain.callbacks.openai_info.OpenAICallbackHandler[source]¶ Callback Handler that tracks OpenAI info. Attributes always_verbose Whether to call verbose callbacks even if verbose is False. completion_tokens ignore_agent Whether to ignore agent callbacks. ig...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.openai_info.OpenAICallbackHandler.html
aa72ef2f0bd4-1
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 a retry event. on_text(text, *, run_id[, parent_run_id]) Run on arbitrary t...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.openai_info.OpenAICallbackHandler.html
aa72ef2f0bd4-2
Run when chain errors. 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. on_chat_model_start(serialized: Dict[str, Any...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.openai_info.OpenAICallbackHandler.html
aa72ef2f0bd4-3
Run when Retriever errors. 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. on_retry(retry_state: RetryCallState, *, run_...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.openai_info.OpenAICallbackHandler.html
c7c9f38c784f-0
langchain.callbacks.llmonitor_callback.UserContextManager¶ class langchain.callbacks.llmonitor_callback.UserContextManager(user_id: str, user_props: Any = None)[source]¶ Context manager for LLMonitor user context. Methods __init__(user_id[, user_props]) __init__(user_id: str, user_props: Any = None) → None[source]¶
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.llmonitor_callback.UserContextManager.html
5978710f7bef-0
langchain.callbacks.utils.import_pandas¶ langchain.callbacks.utils.import_pandas() → Any[source]¶ Import the pandas python package and raise an error if it is not installed.
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.utils.import_pandas.html
8718b7d221ee-0
langchain.callbacks.arthur_callback.ArthurCallbackHandler¶ class langchain.callbacks.arthur_callback.ArthurCallbackHandler(arthur_model: ArthurModel)[source]¶ Callback Handler that logs to Arthur platform. Arthur helps enterprise teams optimize model operations and performance at scale. The Arthur API tracks model perf...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.arthur_callback.ArthurCallbackHandler.html
8718b7d221ee-1
On LLM end, send data to Arthur. on_llm_error(error, **kwargs) Do nothing when LLM outputs an error. on_llm_new_token(token, **kwargs) On new token, pass. on_llm_start(serialized, prompts, **kwargs) On LLM start, save the input prompts on_retriever_end(documents, *, run_id[, ...]) Run when Retriever ends running. on_re...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.arthur_callback.ArthurCallbackHandler.html
8718b7d221ee-2
Defaults to “https://app.arthur.ai”. arthur_login (str, optional) – The login to use to connect to Arthur. Defaults to None. arthur_password (str, optional) – The password to use to connect to Arthur. Defaults to None. Returns The initialized callback handler. Return type ArthurCallbackHandler on_agent_action(action: A...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.arthur_callback.ArthurCallbackHandler.html
8718b7d221ee-3
On new token, pass. on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None[source]¶ On LLM start, save the input prompts on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when Retriever ends running. on_retriever_...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.arthur_callback.ArthurCallbackHandler.html
0f6b92a5d344-0
langchain.callbacks.tracers.wandb.WandbRunArgs¶ class langchain.callbacks.tracers.wandb.WandbRunArgs[source]¶ Arguments for the WandbTracer. job_type: Optional[str]¶ dir: Optional[StrPath]¶ config: Union[Dict, str, None]¶ project: Optional[str]¶ entity: Optional[str]¶ reinit: Optional[bool]¶ tags: Optional[Sequence]¶ g...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.tracers.wandb.WandbRunArgs.html
2108d3882004-0
langchain.callbacks.clearml_callback.import_clearml¶ langchain.callbacks.clearml_callback.import_clearml() → Any[source]¶ Import the clearml python package and raise an error if it is not installed.
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.clearml_callback.import_clearml.html
1b911f6caab2-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...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler.html
1b911f6caab2-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(...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler.html
1b911f6caab2-2
Run when chain errors. async 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) → None¶ Run when chain starts running. async on_chat_model_start(serialized: ...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler.html
1b911f6caab2-3
Run on retriever error. 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. async on_retry(retry_state: RetryCallState, *, run_i...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streaming_aiter.AsyncIteratorCallbackHandler.html
2ecf5d1d9bbc-0
langchain.callbacks.human.HumanApprovalCallbackHandler¶ class langchain.callbacks.human.HumanApprovalCallbackHandler(approve: ~typing.Callable[[~typing.Any], bool] = <function _default_approve>, should_check: ~typing.Callable[[~typing.Dict[str, ~typing.Any]], bool] = <function _default_true>)[source]¶ Callback for manu...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.human.HumanApprovalCallbackHandler.html
2ecf5d1d9bbc-1
Run on new LLM token. on_llm_start(serialized, prompts, *, run_id) 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...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.human.HumanApprovalCallbackHandler.html
2ecf5d1d9bbc-2
Run on agent end. on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when chain ends running. on_chain_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when chain errors. on_chain_start(serial...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.human.HumanApprovalCallbackHandler.html
2ecf5d1d9bbc-3
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) – on_llm_start(serialized: Dict[str, Any], prompts: List[str], *, run_id: UUID, parent_run_id: Opt...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.human.HumanApprovalCallbackHandler.html
2ecf5d1d9bbc-4
Run on arbitrary text. on_tool_end(output: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when tool ends running. on_tool_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when tool errors. on_tool_start(serialized: Dict[s...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.human.HumanApprovalCallbackHandler.html
a5f0170a5e16-0
langchain.callbacks.wandb_callback.WandbCallbackHandler¶ class langchain.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: Optional[str] = Non...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.wandb_callback.WandbCallbackHandler.html
a5f0170a5e16-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...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.wandb_callback.WandbCallbackHandler.html
a5f0170a5e16-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...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.wandb_callback.WandbCallbackHandler.html
a5f0170a5e16-3
complexity_metrics – Whether to compute complexity metrics. Returns – None get_custom_callback_meta() → Dict[str, Any]¶ on_agent_action(action: AgentAction, **kwargs: Any) → Any[source]¶ Run on agent action. on_agent_finish(finish: AgentFinish, **kwargs: Any) → None[source]¶ Run when agent ends running. on_chain_end(ou...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.wandb_callback.WandbCallbackHandler.html
a5f0170a5e16-4
Run when LLM starts. on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when Retriever ends running. on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when Retriever erro...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.wandb_callback.WandbCallbackHandler.html
c2f5d0169aec-0
langchain.callbacks.streamlit.streamlit_callback_handler.LLMThoughtState¶ class langchain.callbacks.streamlit.streamlit_callback_handler.LLMThoughtState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶ Enumerator of the LLMThought state. THINKING = 'THINKING'¶ RUNNING_TOOL =...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streamlit.streamlit_callback_handler.LLMThoughtState.html
5ffa1cc457f2-0
langchain.callbacks.labelstudio_callback.LabelStudioCallbackHandler¶ class langchain.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: Optional[str] = None, mode:...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.labelstudio_callback.LabelStudioCallbackHandler.html
5ffa1cc457f2-1
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, **kwargs) Run when chain ends running. on_chain_error(error, **kwargs) Do nothing when LLM chain outputs an error. on_chain_sta...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.labelstudio_callback.LabelStudioCallbackHandler.html
5ffa1cc457f2-2
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, project_name: str = 'LangChain-%Y-%m-%d', project_config: Optional[str] = None, mode: Union[str, LabelStudioMode] = LabelStudioMode.PROMPT)[sou...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.labelstudio_callback.LabelStudioCallbackHandler.html
5ffa1cc457f2-3
on_llm_error(error: BaseException, **kwargs: Any) → None[source]¶ Do nothing when LLM outputs an error. on_llm_new_token(token: str, **kwargs: Any) → None[source]¶ Do nothing when a new token is generated. on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None[source]¶ Save the prompts in me...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.labelstudio_callback.LabelStudioCallbackHandler.html
5ffa1cc457f2-4
Do nothing when tool outputs an error. on_tool_start(serialized: Dict[str, Any], input_str: str, **kwargs: Any) → None[source]¶ Do nothing when tool starts. Examples using LabelStudioCallbackHandler¶ Label Studio
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.labelstudio_callback.LabelStudioCallbackHandler.html
02a7ba781e1a-0
langchain.callbacks.streamlit.streamlit_callback_handler.LLMThoughtLabeler¶ class langchain.callbacks.streamlit.streamlit_callback_handler.LLMThoughtLabeler[source]¶ Generates markdown labels for LLMThought containers. Pass a custom subclass of this to StreamlitCallbackHandler to override its default labeling logic. Me...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streamlit.streamlit_callback_handler.LLMThoughtLabeler.html
0f1f7d050400-0
langchain.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler¶ class langchain.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler(parent_container: DeltaGenerator, *, max_thought_containers: int = 4, expand_new_thoughts: bool = True, collapse_completed_thoughts: bool = True, tho...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler.html
0f1f7d050400-1
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 chain starts running. on_chat_model_start(ser...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler.html
0f1f7d050400-2
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_labeler: Optional[LLMThoughtLabeler] = None)[source]¶ Create a StreamlitCallbackHandler instance. Parameters parent_container –...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler.html
0f1f7d050400-3
Run when chain starts running. 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. on_llm_end(res...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler.html
0f1f7d050400-4
Run when Retriever errors. 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. on_retry(retry_state: RetryCallState, *, run_...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler.html
0caf0840a0a1-0
langchain.callbacks.human.HumanRejectedException¶ class langchain.callbacks.human.HumanRejectedException[source]¶ Exception to raise when a person manually review and rejects a value.
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.human.HumanRejectedException.html
c72edf86b76f-0
langchain.callbacks.wandb_callback.analyze_text¶ langchain.callbacks.wandb_callback.analyze_text(text: str, complexity_metrics: bool = True, visualize: bool = True, nlp: Any = None, output_dir: Optional[Union[str, Path]] = None) → dict[source]¶ Analyze text using textstat and spacy. Parameters text (str) – The text to ...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.wandb_callback.analyze_text.html
2572f80a2b75-0
langchain.callbacks.openai_info.standardize_model_name¶ langchain.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 – Model name to standardize. is_completion – Whethe...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.openai_info.standardize_model_name.html
1eda2269720f-0
langchain.callbacks.trubrics_callback.TrubricsCallbackHandler¶ class langchain.callbacks.trubrics_callback.TrubricsCallbackHandler(project: str = 'default', email: Optional[str] = None, password: Optional[str] = None, **kwargs: Any)[source]¶ Callback handler for Trubrics. Parameters project – a trubrics project, defaul...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.trubrics_callback.TrubricsCallbackHandler.html
1eda2269720f-1
Run when LLM ends running. on_llm_error(error, *, run_id[, parent_run_id]) Run when LLM errors. on_llm_new_token(token, *[, chunk, ...]) Run on new LLM token. on_llm_start(serialized, prompts, **kwargs) Run when LLM starts running. on_retriever_end(documents, *, run_id[, ...]) Run when Retriever ends running. on_retrie...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.trubrics_callback.TrubricsCallbackHandler.html
1eda2269720f-2
Run on agent end. on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when chain ends running. on_chain_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when chain errors. on_chain_start(serial...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.trubrics_callback.TrubricsCallbackHandler.html
1eda2269720f-3
information. (containing content and other) – on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None[source]¶ Run when LLM starts running. on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when Retriever ends run...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.trubrics_callback.TrubricsCallbackHandler.html
1eda2269720f-4
Run when tool errors. 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, **kwargs: Any) → Any¶ Run when tool starts running.
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.trubrics_callback.TrubricsCallbackHandler.html
a2e890974c67-0
langchain.callbacks.sagemaker_callback.SageMakerCallbackHandler¶ class langchain.callbacks.sagemaker_callback.SageMakerCallbackHandler(run: Any)[source]¶ Callback Handler that logs prompt artifacts and metrics to SageMaker Experiments. Parameters run (sagemaker.experiments.run.Run) – Run object where the experiment is ...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.sagemaker_callback.SageMakerCallbackHandler.html
a2e890974c67-1
Run when LLM starts. 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 a retry ...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.sagemaker_callback.SageMakerCallbackHandler.html
a2e890974c67-2
Run when chain starts running. 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. on_llm_end(res...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.sagemaker_callback.SageMakerCallbackHandler.html
a2e890974c67-3
Run when Retriever starts running. on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run on a retry event. on_text(text: str, **kwargs: Any) → None[source]¶ Run when agent is ending. on_tool_end(output: str, **kwargs: Any) → None[source]¶ Run when tool en...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.sagemaker_callback.SageMakerCallbackHandler.html
11b5905bc568-0
langchain.callbacks.mlflow_callback.MlflowCallbackHandler¶ class langchain.callbacks.mlflow_callback.MlflowCallbackHandler(name: Optional[str] = 'langchainrun-%', experiment: Optional[str] = 'langchain', tags: Optional[Dict] = None, tracking_uri: Optional[str] = None)[source]¶ Callback Handler that logs metrics and art...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.mlflow_callback.MlflowCallbackHandler.html
11b5905bc568-1
on_chain_error(error, **kwargs) Run when chain errors. on_chain_start(serialized, inputs, **kwargs) Run when chain starts running. on_chat_model_start(serialized, messages, *, ...) Run when a chat model starts running. on_llm_end(response, **kwargs) Run when LLM ends running. on_llm_error(error, **kwargs) Run when LLM ...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.mlflow_callback.MlflowCallbackHandler.html
11b5905bc568-2
Initialize callback handler. flush_tracker(langchain_asset: Any = None, finish: bool = False) → None[source]¶ get_custom_callback_meta() → Dict[str, Any]¶ on_agent_action(action: AgentAction, **kwargs: Any) → Any[source]¶ Run on agent action. on_agent_finish(finish: AgentFinish, **kwargs: Any) → None[source]¶ Run when ...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.mlflow_callback.MlflowCallbackHandler.html
11b5905bc568-3
Run when LLM starts. on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when Retriever ends running. on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶ Run when Retriever erro...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.mlflow_callback.MlflowCallbackHandler.html
d5298b0208aa-0
langchain.callbacks.infino_callback.get_num_tokens¶ langchain.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_to_count_tokens_with_...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.infino_callback.get_num_tokens.html
245ae17dd681-0
langchain.callbacks.argilla_callback.ArgillaCallbackHandler¶ class langchain.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. Parameters dataset_name ...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.argilla_callback.ArgillaCallbackHandler.html
245ae17dd681-1
... ) >>> 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." Initializes the ArgillaCallbackHandl...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.argilla_callback.ArgillaCallbackHandler.html
245ae17dd681-2
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_name, ...]) Initializes the ArgillaCallbackHandler. on_agent_action(action, **kwargs) Do nothing when agent...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.argilla_callback.ArgillaCallbackHandler.html
245ae17dd681-3
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 when tool ends. on_tool_error(error, **kwargs) Do nothing when tool out...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.argilla_callback.ArgillaCallbackHandler.html
245ae17dd681-4
ConnectionError – if the connection to Argilla fails. FileNotFoundError – if the FeedbackDataset retrieval from Argilla fails. on_agent_action(action: AgentAction, **kwargs: Any) → Any[source]¶ Do nothing when agent takes a specific action. on_agent_finish(finish: AgentFinish, **kwargs: Any) → None[source]¶ Do nothing ...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.argilla_callback.ArgillaCallbackHandler.html
245ae17dd681-5
on_llm_error(error: BaseException, **kwargs: Any) → None[source]¶ Do nothing when LLM outputs an error. on_llm_new_token(token: str, **kwargs: Any) → None[source]¶ Do nothing when a new token is generated. on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None[source]¶ Save the prompts in me...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.argilla_callback.ArgillaCallbackHandler.html
245ae17dd681-6
Do nothing when tool outputs an error. on_tool_start(serialized: Dict[str, Any], input_str: str, **kwargs: Any) → None[source]¶ Do nothing when tool starts. Examples using ArgillaCallbackHandler¶ Argilla
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.argilla_callback.ArgillaCallbackHandler.html
b967c10e0133-0
langchain.callbacks.flyte_callback.import_flytekit¶ langchain.callbacks.flyte_callback.import_flytekit() → Tuple[flytekit, renderer][source]¶ Import flytekit and flytekitplugins-deck-standard.
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.flyte_callback.import_flytekit.html
fc82d92d3fe2-0
langchain.callbacks.llmonitor_callback.LLMonitorCallbackHandler¶ class langchain.callbacks.llmonitor_callback.LLMonitorCallbackHandler(app_id: Optional[str] = None, api_url: Optional[str] = None, verbose: bool = False)[source]¶ Callback Handler for LLMonitor`. #### Parameters: app_id: The app id of the app you want to ...
lang/api.python.langchain.com/en/latest/callbacks/langchain.callbacks.llmonitor_callback.LLMonitorCallbackHandler.html