deprecation for config_schema in docs

This commit is contained in:
Sydney Runkle
2025-07-24 16:23:42 -04:00
parent cb918601d1
commit 439038fc3a
5 changed files with 16 additions and 1 deletions
@@ -261,6 +261,10 @@ class entrypoint(Generic[ContextT]):
passed to the workflow.
cache_policy: A cache policy to use for caching the results of the workflow.
retry_policy: A retry policy (or list of policies) to use for the workflow in case of a failure.
config_schema: Specifies the schema for the `configurable` key in the `RunnableConfig` object.
!!! warning "Deprecated"
This parameter is deprecated and support will be removed in v2.0.0.
Please use `context_schema` instead.
Example: Using entrypoint and tasks
```python
+4
View File
@@ -128,6 +128,10 @@ class StateGraph(Generic[StateT, ContextT, InputT, OutputT]):
Use this to expose immutable context data to your nodes, like user_id, db_conn, etc.
input_schema: The schema class that defines the input to the graph.
output_schema: The schema class that defines the output from the graph.
config_schema: Specifies the schema for the `configurable` key in the `RunnableConfig` object.
!!! warning "Deprecated"
This parameter is deprecated and support will be removed in v2.0.0.
Please use `context_schema` instead.
Example:
```python
+1
View File
@@ -602,6 +602,7 @@ class Pregel(
Defaults to None."""
context_schema: type[ContextT] | None = None
"""Specifies the schema for the context object that will be passed to the workflow."""
config: RunnableConfig | None = None
+3 -1
View File
@@ -26,7 +26,9 @@ class _RuntimeOverrides(TypedDict, Generic[ContextT], total=False):
class Runtime(Generic[ContextT]):
"""Convenience class that bundles run-scoped context and graph configuration.
!!! version-added "Added in version 1.0.0."
!!! version-added "Added in version v0.6.0"
TODO: write a compelling example with the new API.
"""
context: ContextT = field(default=None) # type: ignore[assignment]
@@ -363,6 +363,10 @@ def create_react_agent(
name: An optional name for the CompiledStateGraph.
This name will be automatically used when adding ReAct agent graph to another graph as a subgraph node -
particularly useful for building multi-agent systems.
config_schema: Specifies the schema for the `configurable` key in the `RunnableConfig` object.
!!! warning "Deprecated"
This parameter is deprecated and support will be removed in v2.0.0.
Please use `context_schema` instead.
Returns:
A compiled LangChain runnable that can be used for chat interactions.