id stringlengths 14 16 | text stringlengths 20 3.26k | source stringlengths 65 181 |
|---|---|---|
af6afe90327e-17 | Field that can be configured by the user with a default value.
runnables.utils.ConfigurableFieldSpec(id, ...)
Field that can be configured by the user.
runnables.utils.FunctionNonLocals()
Get the nonlocal variables accessed of a function.
runnables.utils.GetLambdaSource()
Get the source code of a lambda function.
runna... | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-18 | runnables.config.merge_configs(*configs)
Merge multiple configs into one.
runnables.config.patch_config(config, *[, ...])
Patch a config with new values.
runnables.config.run_in_executor(...)
Run a function in an executor.
runnables.configurable.make_options_spec(...)
Make a ConfigurableFieldSpec for a ConfigurableFiel... | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-19 | runnables.utils.add(addables)
Add a sequence of addable objects together.
runnables.utils.create_model(__model_name, ...)
Create a pydantic model with the given field definitions.
runnables.utils.gated_coro(semaphore, coro)
Run a coroutine with a semaphore.
runnables.utils.gather_with_concurrency(n, ...)
Gather corouti... | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-20 | stores.InvalidKeyException
Raised when a key is invalid; e.g., uses incorrect characters.
langchain_core.structured_query¶
Internal representation of a structured query language.
Classes¶
structured_query.Comparator(value)
Enumerator of the comparison operators.
structured_query.Comparison
Comparison to a value.
struct... | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-21 | tools.ToolException
Optional exception that tool throws when execution error occurs.
Functions¶
tools.create_retriever_tool(retriever, name, ...)
Create a tool to do retrieval of documents.
tools.create_schema_from_function(...)
Create a pydantic schema from a function's signature.
tools.render_text_description(tools)
... | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-22 | Patch to the run log.
tracers.log_stream.RunState
State of the run.
tracers.root_listeners.AsyncRootListenersTracer(*, ...)
Async Tracer that calls listeners on run start, end, and error.
tracers.root_listeners.RootListenersTracer(*, ...)
Tracer that calls listeners on run start, end, and error.
tracers.run_collector.R... | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-23 | Throw an error because this has been replaced by tracing_v2_enabled.
tracers.context.tracing_v2_enabled([...])
Instruct LangChain to log all runs in context to LangSmith.
tracers.evaluation.wait_for_all_evaluators()
Wait for all tracers to finish.
tracers.langchain.get_client()
Get the client.
tracers.langchain.log_err... | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-24 | utils.iter.Tee(iterable[, n, lock])
Create n separate asynchronous iterators over iterable
utils.iter.safetee
alias of Tee
utils.mustache.ChevronError
Custom exception for Chevron errors.
Functions¶
utils.aiter.py_anext(iterator[, default])
Pure-Python implementation of anext() for testing purposes.
utils.aiter.tee_pee... | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-25 | Convert an example into a list of messages that can be fed into an LLM.
utils.html.extract_sub_links(raw_html, url, *)
Extract all links from a raw html string and convert into absolute paths.
utils.html.find_all_links(raw_html, *[, pattern])
Extract all links from a raw html string.
utils.image.encode_image(image_path... | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-26 | utils.mustache.l_sa_check(template, literal, ...)
Do a preliminary check to see if a tag could be a standalone.
utils.mustache.parse_tag(template, l_del, r_del)
Parse a tag from a template.
utils.mustache.r_sa_check(template, ...)
Do a final check to see if a tag could be a standalone.
utils.mustache.render([template, ... | https://api.python.langchain.com/en/latest/core_api_reference.html |
af6afe90327e-27 | One of the most common ways to store and search over unstructured data is to
embed it and store the resulting embedding vectors, and then query the store
and retrieve the data that are ‘most similar’ to the embedded query.
Class hierarchy:
VectorStore --> <name> # Examples: Annoy, FAISS, Milvus
BaseRetriever --> Vecto... | https://api.python.langchain.com/en/latest/core_api_reference.html |
a9c2d2f7c8d4-0 | langchain_anthropic 0.1.15¶
langchain_anthropic.chat_models¶
Classes¶
chat_models.AnthropicTool
chat_models.ChatAnthropic
Anthropic chat model integration.
chat_models.ChatAnthropicMessages
[Deprecated]
Functions¶
chat_models.convert_to_anthropic_tool(tool)
langchain_anthropic.experimental¶
Classes¶
experimental.ChatAn... | https://api.python.langchain.com/en/latest/anthropic_api_reference.html |
452437e2ccd7-0 | langchain_astradb 0.3.3¶
langchain_astradb.cache¶
Classes¶
cache.AstraDBCache(*[, collection_name, ...])
Cache that uses Astra DB as a backend.
cache.AstraDBSemanticCache(*[, ...])
Cache that uses Astra DB as a vector-store backend for semantic (i.e.
langchain_astradb.chat_message_histories¶
Astra DB - based chat messa... | https://api.python.langchain.com/en/latest/astradb_api_reference.html |
09aeddc69ef9-0 | langchain_azure_dynamic_sessions 0.1.0¶
langchain_azure_dynamic_sessions.tools¶
Classes¶
tools.sessions.RemoteFileMetadata(filename, ...)
Metadata for a file in the session.
tools.sessions.SessionsPythonREPLTool
A tool for running Python code in an Azure Container Apps dynamic sessions code interpreter. | https://api.python.langchain.com/en/latest/azure_dynamic_sessions_api_reference.html |
3b042c54a9aa-0 | langchain_core.callbacks.manager.CallbackManagerForChainRun¶
class langchain_core.callbacks.manager.CallbackManagerForChainRun(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, inheritable_tags: ... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForChainRun.html |
3b042c54a9aa-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.CallbackManagerForChainRun.html |
3b042c54a9aa-2 | Run when agent action is received.
Parameters
action (AgentAction) – The agent action.
kwargs (Any) –
Returns
The result of the callback.
Return type
Any
on_agent_finish(finish: AgentFinish, **kwargs: Any) → Any[source]¶
Run when agent finish is received.
Parameters
finish (AgentFinish) – The agent finish.
kwargs (Any... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForChainRun.html |
1e5e77e8a563-0 | langchain_core.callbacks.base.RetrieverManagerMixin¶
class langchain_core.callbacks.base.RetrieverManagerMixin[source]¶
Mixin for Retriever callbacks.
Methods
__init__()
on_retriever_end(documents, *, run_id[, ...])
Run when Retriever ends running.
on_retriever_error(error, *, run_id[, ...])
Run when Retriever errors.
... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.RetrieverManagerMixin.html |
90fee4b1c14f-0 | langchain_community.callbacks.human.AsyncHumanApprovalCallbackHandler¶
class langchain_community.callbacks.human.AsyncHumanApprovalCallbackHandler(approve: ~typing.Callable[[~typing.Any], ~typing.Awaitable[bool]] = <function _adefault_approve>, should_check: ~typing.Callable[[~typing.Dict[str, ~typing.Any]], bool] = <f... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.human.AsyncHumanApprovalCallbackHandler.html |
90fee4b1c14f-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 on retriever end.
on_retriever_error(error, *, run_id[, ...])
Run on retriever error.
on_retriever_start(serialized, query, *, run_id)
Run on retriever start.
on_retry(retry_... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.human.AsyncHumanApprovalCallbackHandler.html |
90fee4b1c14f-2 | Run on agent action.
Parameters
action (AgentAction) –
run_id (UUID) –
parent_run_id (Optional[UUID]) –
tags (Optional[List[str]]) –
kwargs (Any) –
Return type
None
async on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → N... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.human.AsyncHumanApprovalCallbackHandler.html |
90fee4b1c14f-3 | kwargs (Any) –
Return type
None
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.
Parameters
serialized (Dict[... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.human.AsyncHumanApprovalCallbackHandler.html |
90fee4b1c14f-4 | Run when LLM ends running.
Parameters
response (LLMResult) –
run_id (UUID) –
parent_run_id (Optional[UUID]) –
tags (Optional[List[str]]) –
kwargs (Any) –
Return type
None
async on_llm_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any)... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.human.AsyncHumanApprovalCallbackHandler.html |
90fee4b1c14f-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]) –
run_id (UUID) –
parent_run_id (Optional[UUID]) –
tags (Option... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.human.AsyncHumanApprovalCallbackHandler.html |
90fee4b1c14f-6 | Run on retriever start.
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
None
async on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[U... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.human.AsyncHumanApprovalCallbackHandler.html |
90fee4b1c14f-7 | 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) → None¶
Run when tool errors.
Parameters
error (BaseException) –
run_id (UUID) –
parent_run_id (Optional[UUID]) –
tags (Optional[List[str]... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.human.AsyncHumanApprovalCallbackHandler.html |
1d22f70928a4-0 | langchain_community.callbacks.streamlit.streamlit_callback_handler.LLMThoughtState¶
class langchain_community.callbacks.streamlit.streamlit_callback_handler.LLMThoughtState(value)[source]¶
Enumerator of the LLMThought state.
THINKING = 'THINKING'¶
RUNNING_TOOL = 'RUNNING_TOOL'¶
COMPLETE = 'COMPLETE'¶ | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.streamlit_callback_handler.LLMThoughtState.html |
7c8ef0dd13fb-0 | langchain_community.callbacks.whylabs_callback.WhyLabsCallbackHandler¶
class langchain_community.callbacks.whylabs_callback.WhyLabsCallbackHandler(logger: Logger, handler: Any)[source]¶
Callback Handler for logging to WhyLabs. This callback handler utilizes
langkit to extract features from the prompts & responses when ... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.whylabs_callback.WhyLabsCallbackHandler.html |
7c8ef0dd13fb-1 | Optional because the preferred way to specify the dataset id is
with environment variable WHYLABS_DEFAULT_DATASET_ID.
sentiment (bool) – Whether to enable sentiment analysis. Defaults to False.
toxicity (bool) – Whether to enable toxicity analysis. Defaults to False.
themes (bool) – Whether to enable theme analysis. De... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.whylabs_callback.WhyLabsCallbackHandler.html |
7c8ef0dd13fb-2 | Run when a chat model starts running.
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 that occurred. :type error: BaseException :param kwargs: Additional keyword arguments. - response (LLMResult): Th... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.whylabs_callback.WhyLabsCallbackHandler.html |
7c8ef0dd13fb-3 | Parameters
logger (Logger) –
handler (Any) –
close() → None[source]¶
Close any loggers to allow writing out of any profiles before exiting.
Return type
None
flush() → None[source]¶
Explicitly write current profile if using a rolling logger.
Return type
None
classmethod from_params(*, api_key: Optional[str] = None, or... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.whylabs_callback.WhyLabsCallbackHandler.html |
7c8ef0dd13fb-4 | WhyLabs writer.
Return type
WhyLabsCallbackHandler
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.whylabs_callback.WhyLabsCallbackHandler.html |
7c8ef0dd13fb-5 | 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.whylabs_callback.WhyLabsCallbackHandler.html |
7c8ef0dd13fb-6 | Run when LLM ends running.
Parameters
response (LLMResult) –
run_id (UUID) –
parent_run_id (Optional[UUID]) –
kwargs (Any) –
Return type
Any
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.
:ty... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.whylabs_callback.WhyLabsCallbackHandler.html |
7c8ef0dd13fb-7 | 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]) –
run_id (UUID) –
parent_run_id (Optional[UUID]) –
tags (Option... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.whylabs_callback.WhyLabsCallbackHandler.html |
7c8ef0dd13fb-8 | 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.whylabs_callback.WhyLabsCallbackHandler.html |
7c8ef0dd13fb-9 | 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.whylabs_callback.WhyLabsCallbackHandler.html |
06252e99e1f0-0 | langchain_core.callbacks.manager.CallbackManagerForRetrieverRun¶
class langchain_core.callbacks.manager.CallbackManagerForRetrieverRun(*, 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.CallbackManagerForRetrieverRun.html |
06252e99e1f0-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.CallbackManagerForRetrieverRun.html |
06252e99e1f0-2 | kwargs (Any) –
Return type
None
on_retriever_error(error: BaseException, **kwargs: Any) → None[source]¶
Run when retriever errors.
Parameters
error (BaseException) –
kwargs (Any) –
Return type
None
on_retry(retry_state: RetryCallState, **kwargs: Any) → None¶
Run on a retry event.
Parameters
retry_state (RetryCallSta... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManagerForRetrieverRun.html |
40df20695947-0 | langchain_core.callbacks.manager.AsyncCallbackManager¶
class langchain_core.callbacks.manager.AsyncCallbackManager(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, parent_run_id: Optional[UUID] = None, *, tags: Optional[List[str]] = None, inheritable_tags: Optional[... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManager.html |
40df20695947-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]) –
tags (Optional[List[str]]) –
inheritable_tags (Optional[List[str]]) –
metadata (Optional[Dict[str, Any]]) –
inh... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManager.html |
40df20695947-2 | Parameters
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: Optiona... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManager.html |
40df20695947-3 | Parameters
serialized (Dict[str, Any]) – The serialized chain.
inputs (Union[Dict[str, Any], Any]) – The inputs to the chain.
run_id (UUID, optional) – The ID of the run. Defaults to None.
kwargs (Any) –
Returns
The async callback managerfor the chain run.
Return type
AsyncCallbackManagerForChainRun
async on_chat_mode... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManager.html |
40df20695947-4 | to each prompt.
Return type
List[AsyncCallbackManagerForLLMRun]
async on_retriever_start(serialized: Dict[str, Any], query: str, run_id: Optional[UUID] = None, parent_run_id: Optional[UUID] = None, **kwargs: Any) → AsyncCallbackManagerForRetrieverRun[source]¶
Run when retriever starts running.
Parameters
serialized (Di... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManager.html |
40df20695947-5 | Parameters
tags (List[str]) –
Return type
None
set_handler(handler: BaseCallbackHandler, inherit: bool = True) → None¶
Set handler as the only handler on the callback manager.
Parameters
handler (BaseCallbackHandler) –
inherit (bool) –
Return type
None
set_handlers(handlers: List[BaseCallbackHandler], inherit: bool ... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManager.html |
f11443a56745-0 | langchain_community.callbacks.flyte_callback.FlyteCallbackHandler¶
class langchain_community.callbacks.flyte_callback.FlyteCallbackHandler[source]¶
Callback handler that is used within a Flyte task.
Initialize callback handler.
Attributes
always_verbose
Whether to call verbose callbacks even if verbose is False.
ignore... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.flyte_callback.FlyteCallbackHandler.html |
f11443a56745-1 | 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)
Run when agent is ending.
on_tool_end(output, **kwargs)
Run when tool... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.flyte_callback.FlyteCallbackHandler.html |
f11443a56745-2 | 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.flyte_callback.FlyteCallbackHandler.html |
f11443a56745-3 | 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.flyte_callback.FlyteCallbackHandler.html |
f11443a56745-4 | 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.flyte_callback.FlyteCallbackHandler.html |
f727072f3409-0 | langchain_core.callbacks.manager.atrace_as_chain_group¶
langchain_core.callbacks.manager.atrace_as_chain_group(group_name: str, callback_manager: Optional[AsyncCallbackManager] = None, *, inputs: Optional[Dict[str, Any]] = None, project_name: Optional[str] = None, example_id: Optional[Union[str, UUID]] = None, run_id: ... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.atrace_as_chain_group.html |
f727072f3409-1 | # Use the async callback manager for the chain group
res = await llm.ainvoke(llm_input, {"callbacks": manager})
await manager.on_chain_end({"output": res}) | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.atrace_as_chain_group.html |
0a485b457467-0 | langchain_core.callbacks.manager.BaseRunManager¶
class langchain_core.callbacks.manager.BaseRunManager(*, 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]] = No... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.BaseRunManager.html |
0a485b457467-1 | Run on arbitrary text.
__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]] = None, inheritable_metadata: Op... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.BaseRunManager.html |
0a485b457467-2 | Run on arbitrary text.
Parameters
text (str) –
run_id (UUID) –
parent_run_id (Optional[UUID]) –
kwargs (Any) –
Return type
Any | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.BaseRunManager.html |
d12fb8337a00-0 | langchain_community.callbacks.tracers.comet.import_comet_llm_api¶
langchain_community.callbacks.tracers.comet.import_comet_llm_api() → SimpleNamespace[source]¶
Import comet_llm api and raise an error if it is not installed.
Return type
SimpleNamespace | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.comet.import_comet_llm_api.html |
8e3152136ab6-0 | langchain_core.callbacks.base.BaseCallbackManager¶
class langchain_core.callbacks.base.BaseCallbackManager(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, 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.base.BaseCallbackManager.html |
8e3152136ab6-1 | Parameters
handlers (List[BaseCallbackHandler]) –
inheritable_handlers (Optional[List[BaseCallbackHandler]]) –
parent_run_id (Optional[UUID]) –
tags (Optional[List[str]]) –
inheritable_tags (Optional[List[str]]) –
metadata (Optional[Dict[str, Any]]) –
inheritable_metadata (Optional[Dict[str, Any]]) –
__init__(ha... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.BaseCallbackManager.html |
8e3152136ab6-2 | Parameters
tags (List[str]) –
inherit (bool) –
Return type
None
copy() → T[source]¶
Copy the callback manager.
Parameters
self (T) –
Return type
T
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: Opti... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.BaseCallbackManager.html |
8e3152136ab6-3 | 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 running.
ATTENTION: This method is called for non-cha... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.base.BaseCallbackManager.html |
8e3152136ab6-4 | 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_core.callbacks.base.BaseCallbackManager.html |
d46a6e2123c9-0 | langchain_community.callbacks.mlflow_callback.get_text_complexity_metrics¶
langchain_community.callbacks.mlflow_callback.get_text_complexity_metrics() → List[str][source]¶
Get the text complexity metrics from textstat.
Return type
List[str] | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.mlflow_callback.get_text_complexity_metrics.html |
639c3703d430-0 | langchain_community.callbacks.utils.load_json¶
langchain_community.callbacks.utils.load_json(json_path: Union[str, Path]) → str[source]¶
Load json file to a string.
Parameters
json_path (str) – The path to the json file.
Returns
The string representation of the json file.
Return type
(str) | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.utils.load_json.html |
89ca614517a9-0 | langchain_community.callbacks.uptrain_callback.import_uptrain¶
langchain_community.callbacks.uptrain_callback.import_uptrain() → Any[source]¶
Import the uptrain package.
Return type
Any | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.uptrain_callback.import_uptrain.html |
f76a82b8e767-0 | langchain_core.callbacks.manager.AsyncCallbackManagerForChainRun¶
class langchain_core.callbacks.manager.AsyncCallbackManagerForChainRun(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, inherita... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManagerForChainRun.html |
f76a82b8e767-1 | on_chain_error(error, **kwargs)
Run when chain errors.
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: Opti... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManagerForChainRun.html |
f76a82b8e767-2 | Get the equivalent sync RunManager.
Returns
The sync RunManager.
Return type
CallbackManagerForChainRun
async on_agent_action(action: AgentAction, **kwargs: Any) → Any[source]¶
Run when agent action is received.
Parameters
action (AgentAction) – The agent action.
kwargs (Any) –
Returns
The result of the callback.
Retu... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.AsyncCallbackManagerForChainRun.html |
5af1b3c40c9a-0 | langchain_community.callbacks.utils.flatten_dict¶
langchain_community.callbacks.utils.flatten_dict(nested_dict: Dict[str, Any], parent_key: str = '', sep: str = '_') → Dict[str, Any][source]¶
Flatten a nested dictionary into a flat dictionary.
Parameters
nested_dict (dict) – The nested dictionary to flatten.
parent_key... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.utils.flatten_dict.html |
f2cd4c93c04d-0 | langchain_core.callbacks.manager.CallbackManager¶
class langchain_core.callbacks.manager.CallbackManager(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, 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.CallbackManager.html |
f2cd4c93c04d-1 | Parameters
handlers (List[BaseCallbackHandler]) –
inheritable_handlers (Optional[List[BaseCallbackHandler]]) –
parent_run_id (Optional[UUID]) –
tags (Optional[List[str]]) –
inheritable_tags (Optional[List[str]]) –
metadata (Optional[Dict[str, Any]]) –
inheritable_metadata (Optional[Dict[str, Any]]) –
__init__(ha... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManager.html |
f2cd4c93c04d-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.CallbackManager.html |
f2cd4c93c04d-3 | Parameters
serialized (Dict[str, Any]) – The serialized chain.
inputs (Union[Dict[str, Any], Any]) – The inputs to the chain.
run_id (UUID, optional) – The ID of the run. Defaults to None.
kwargs (Any) –
Returns
The callback manager for the chain run.
Return type
CallbackManagerForChainRun
on_chat_model_start(serializ... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManager.html |
f2cd4c93c04d-4 | Return type
List[CallbackManagerForLLMRun]
on_retriever_start(serialized: Dict[str, Any], query: str, run_id: Optional[UUID] = None, parent_run_id: Optional[UUID] = None, **kwargs: Any) → CallbackManagerForRetrieverRun[source]¶
Run when retriever starts running.
Parameters
serialized (Dict[str, Any]) –
query (str) –
... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManager.html |
f2cd4c93c04d-5 | Remove a handler from the callback manager.
Parameters
handler (BaseCallbackHandler) –
Return type
None
remove_metadata(keys: List[str]) → None¶
Parameters
keys (List[str]) –
Return type
None
remove_tags(tags: List[str]) → None¶
Parameters
tags (List[str]) –
Return type
None
set_handler(handler: BaseCallbackHandler,... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.CallbackManager.html |
e14662daf8ca-0 | langchain_community.callbacks.mlflow_callback.mlflow_callback_metrics¶
langchain_community.callbacks.mlflow_callback.mlflow_callback_metrics() → List[str][source]¶
Get the metrics to log to MLFlow.
Return type
List[str] | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.mlflow_callback.mlflow_callback_metrics.html |
a77d0fdc8368-0 | langchain_community.callbacks.labelstudio_callback.LabelStudioMode¶
class langchain_community.callbacks.labelstudio_callback.LabelStudioMode(value)[source]¶
Label Studio mode enumerator.
PROMPT = 'prompt'¶
CHAT = 'chat'¶ | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.labelstudio_callback.LabelStudioMode.html |
b34f3954c38b-0 | langchain_community.callbacks.tracers.wandb.WandbRunArgs¶
class langchain_community.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: O... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.tracers.wandb.WandbRunArgs.html |
ac2732f93d6f-0 | langchain_community.callbacks.arthur_callback.ArthurCallbackHandler¶
class langchain_community.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 A... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.arthur_callback.ArthurCallbackHandler.html |
ac2732f93d6f-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... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.arthur_callback.ArthurCallbackHandler.html |
ac2732f93d6f-2 | Parameters
model_id (str) – The ID of the arthur model to log to.
arthur_url (str, optional) – The URL of the Arthur instance to log to.
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 c... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.arthur_callback.ArthurCallbackHandler.html |
ac2732f93d6f-3 | 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[str, Any]] = None, **kwargs: Any) → Any¶
Run when a chat model starts running.
ATTENTION: T... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.arthur_callback.ArthurCallbackHandler.html |
ac2732f93d6f-4 | On LLM start, save the input prompts
Parameters
serialized (Dict[str, Any]) –
prompts (List[str]) –
kwargs (Any) –
Return type
None
on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶
Run when Retriever ends running.
Parameters
documents (Seque... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.arthur_callback.ArthurCallbackHandler.html |
ac2732f93d6f-5 | 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, **kwargs: Any) → None[source]¶
Do nothing
Parameters
text (str) –
kwargs (Any) –
Return type
None
on_tool_end(output: Any, observation_prefix: Optional... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.arthur_callback.ArthurCallbackHandler.html |
616b35e7ecaf-0 | langchain_core.callbacks.streaming_stdout.StreamingStdOutCallbackHandler¶
class langchain_core.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 t... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.streaming_stdout.StreamingStdOutCallbackHandler.html |
616b35e7ecaf-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... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.streaming_stdout.StreamingStdOutCallbackHandler.html |
616b35e7ecaf-2 | kwargs (Any) –
Return type
None
on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], **kwargs: Any) → None[source]¶
Run when LLM starts running.
Parameters
serialized (Dict[str, Any]) –
messages (List[List[BaseMessage]]) –
kwargs (Any) –
Return type
None
on_llm_end(response: LLMResult,... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.streaming_stdout.StreamingStdOutCallbackHandler.html |
616b35e7ecaf-3 | 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]) –
kwargs (Any) –
Return type
Any
on_retriever_start(seria... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.streaming_stdout.StreamingStdOutCallbackHandler.html |
616b35e7ecaf-4 | Run when tool ends running.
Parameters
output (Any) –
kwargs (Any) –
Return type
None
on_tool_error(error: BaseException, **kwargs: Any) → None[source]¶
Run when tool errors.
Parameters
error (BaseException) –
kwargs (Any) –
Return type
None
on_tool_start(serialized: Dict[str, Any], input_str: str, **kwargs: Any) →... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.streaming_stdout.StreamingStdOutCallbackHandler.html |
6518ca259ebf-0 | langchain_community.callbacks.flyte_callback.import_flytekit¶
langchain_community.callbacks.flyte_callback.import_flytekit() → Tuple[flytekit, renderer][source]¶
Import flytekit and flytekitplugins-deck-standard.
Return type
Tuple[flytekit, renderer] | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.flyte_callback.import_flytekit.html |
4839211431fb-0 | langchain_core.callbacks.manager.RunManager¶
class langchain_core.callbacks.manager.RunManager(*, 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, meta... | https://api.python.langchain.com/en/latest/callbacks/langchain_core.callbacks.manager.RunManager.html |
4839211431fb-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.RunManager.html |
8f25ec5de7e9-0 | langchain_community.callbacks.streamlit.mutable_expander.ChildRecord¶
class langchain_community.callbacks.streamlit.mutable_expander.ChildRecord(type: ChildType, kwargs: Dict[str, Any], dg: DeltaGenerator)[source]¶
Child record as a NamedTuple.
Create new instance of ChildRecord(type, kwargs, dg)
Attributes
dg
Alias fo... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.streamlit.mutable_expander.ChildRecord.html |
6e2d02004315-0 | langchain_community.callbacks.manager.get_bedrock_anthropic_callback¶
langchain_community.callbacks.manager.get_bedrock_anthropic_callback() → Generator[BedrockAnthropicTokenUsageCallbackHandler, None, None][source]¶
Get the Bedrock anthropic callback handler in a context manager.
which conveniently exposes token and c... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.manager.get_bedrock_anthropic_callback.html |
cf8c4a00e836-0 | langchain_community.callbacks.sagemaker_callback.SageMakerCallbackHandler¶
class langchain_community.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 wher... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.sagemaker_callback.SageMakerCallbackHandler.html |
cf8c4a00e836-1 | on_llm_start(serialized, prompts, **kwargs)
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,... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.sagemaker_callback.SageMakerCallbackHandler.html |
cf8c4a00e836-2 | 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]¶
Run when chain ends running.
P... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.sagemaker_callback.SageMakerCallbackHandler.html |
cf8c4a00e836-3 | 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_error(error: BaseExc... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.sagemaker_callback.SageMakerCallbackHandler.html |
cf8c4a00e836-4 | 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.sagemaker_callback.SageMakerCallbackHandler.html |
cf8c4a00e836-5 | 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
Examples using S... | https://api.python.langchain.com/en/latest/callbacks/langchain_community.callbacks.sagemaker_callback.SageMakerCallbackHandler.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.