Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

core[runnables]: docstring for class RunnableSerializable, method configurable_fields #19722

Merged
merged 4 commits into from
Mar 28, 2024
Merged

core[runnables]: docstring for class RunnableSerializable, method configurable_fields #19722

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
221b5a3
docstring update for class runnable_serializable, method configurable…
sepiatone Mar 28, 2024
c30851e
update to print statement for clarity
sepiatone Mar 28, 2024
3f73e60
format docstring
ccurme Mar 28, 2024
379f94d
fix line length
ccurme Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions libs/core/langchain_core/runnables/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2034,6 +2034,33 @@ def to_json(self) -> Union[SerializedConstructor, SerializedNotImplemented]:
def configurable_fields(
self, **kwargs: AnyConfigurableField
) -> RunnableSerializable[Input, Output]:
"""Configure particular runnable fields at runtime.

.. code-block:: python

from langchain_core.runnables import ConfigurableField
from langchain_openai import ChatOpenAI

model = ChatOpenAI(max_tokens=20).configurable_fields(
max_tokens=ConfigurableField(
id="output_token_number",
name="Max tokens in the output",
description="The maximum number of tokens in the output",
)
)

# max_tokens = 20
print(
"max_tokens_20: ",
model.invoke("tell me something about chess").content
)

# max_tokens = 200
print("max_tokens_200: ", model.with_config(
configurable={"output_token_number": 200}
).invoke("tell me something about chess").content
)
"""
from langchain_core.runnables.configurable import RunnableConfigurableFields

for key in kwargs:
Expand Down
Loading