LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Client
  • AsyncClient
  • Run Helpers
  • Run Trees
  • Evaluation
  • Schemas
  • Utilities
  • Wrappers
  • Anonymizer
  • Testing
  • Expect API
  • Middleware
  • Pytest Plugin
  • Deployment SDK
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewClientAsyncClientRun HelpersRun TreesEvaluationSchemasUtilitiesWrappersAnonymizerTestingExpect APIMiddlewarePytest PluginDeployment SDK
Language
Theme
Pythonlangsmith_openapi_client_modelsBaseModelto_dict
Methodā—Since v0.8

to_dict

Copy
to_dict(
  self,
  *,
  mode: Literal['json', 'python'] = 'python',
  use_api_names: bool
View source on GitHub
=
True
,
exclude_unset
:
bool
=
True
,
exclude_defaults
:
bool
=
False
,
exclude_none
:
bool
=
False
,
warnings
:
bool
=
True
)
->
dict
[
str
,
object
]

Parameters

NameTypeDescription
modeLiteral['json', 'python']
Default:'python'

If mode is 'json', the dictionary will only contain JSON serializable types. e.g. datetime will be turned into a string, "2024-3-22T18:11:19.117000Z". If mode is 'python', the dictionary may contain any Python objects. e.g. datetime(2024, 3, 22)

use_api_namesbool
Default:True

Whether to use the key that the API responded with or the property name. Defaults to True.

exclude_unsetbool
Default:True
exclude_defaultsbool
Default:False
exclude_nonebool
Default:False
warningsbool
Default:True

Recursively generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

By default, fields that were not set by the API will not be included, and keys will match the API response, not the property names from the model.

For example, if the API responds with "fooBar": true but we've defined a foo_bar: bool property, the output will use the "fooBar" key (unless use_api_names=False is passed).

Whether to exclude fields that have not been explicitly set.

Whether to exclude fields that are set to their default value from the output.

Whether to exclude fields that have a value of None from the output.

Whether to log warnings when invalid fields are encountered. This is only supported in Pydantic v2.