# TypeAdapter

## TypeAdapter

**Bases:** `Generic[T]`

:::callout{intent="note" title="Usage Documentation"}
[`TypeAdapter`](/guides/concepts-type-adapter)
:::

Type adapters provide a flexible way to perform validation and serialization based on a Python type.

A `TypeAdapter` instance exposes some of the functionality from `BaseModel` instance methods for types that do not have such methods (such as dataclasses, primitive types, and more).

**Note:** `TypeAdapter` instances are not types, and cannot be used as type annotations for fields.

### Constructor Parameters

**`type`** : [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)

The type associated with the `TypeAdapter`.

**`config`** : [`ConfigDict`](/guides/pydantic-config#configdict) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Configuration for the `TypeAdapter`, should be a dictionary conforming to [`ConfigDict`](/guides/pydantic-config#configdict).

:::callout{intent="note"}
You cannot provide a configuration when instantiating a `TypeAdapter` if the type you’re using has its own config that cannot be overridden (ex: `BaseModel`, `TypedDict`, and `dataclass`). A [`type-adapter-config-unused`](/guides/error-messages-usage-errors#type-adapter-config-unused) error will be raised in this case.
:::

**`_parent_depth`** : [`int`](https://docs.python.org/3/builtins/functions.html#int) _Default:_ `2`

Depth at which to search for the [parent frame](https://docs.python.org/3/reference/datamodel.html#frame-objects). This frame is used when resolving forward annotations during schema building, by looking for the globals and locals of this frame. Defaults to 2, which will result in the frame where the `TypeAdapter` was instantiated.

:::callout{intent="note"}
This parameter is named with an underscore to suggest its private nature and discourage use. It may be deprecated in a minor version, so we only recommend using it if you’re comfortable with potential change in behavior/support. It’s default value is 2 because internally, the `TypeAdapter` class makes another call to fetch the frame.
:::

**`module`** : [`str`](https://docs.python.org/3/builtins/stdtypes.html#str) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

The module that passes to plugin if provided.

### Attributes

#### core\_schema

The core schema for the type.

**Type:** `CoreSchema`

#### validator

The schema validator for the type.

**Type:** `SchemaValidator` | `PluggableSchemaValidator`

#### serializer

The schema serializer for the type.

**Type:** `SchemaSerializer`

#### pydantic\_complete

Whether the core schema for the type is successfully built.

**Type:** [`bool`](https://docs.python.org/3/builtins/functions.html#bool)

:::accordion{title="Compatibility with mypy"}
Depending on the type used, `mypy` might raise an error when instantiating a `TypeAdapter`. As a workaround, you can explicitly annotate your variable:

```python
from typing import Union

from pydantic import TypeAdapter

ta: TypeAdapter[Union[str, int]] = TypeAdapter(Union[str, int])  # type: ignore[arg-type]
```
:::

:::accordion{title="Namespace management nuances and implementation details"}
Here, we collect some notes on namespace management, and subtle differences from `BaseModel`:

`BaseModel` uses its own `__module__` to find out where it was defined and then looks for symbols to resolve forward references in those globals. On the other hand, `TypeAdapter` can be initialized with arbitrary objects, which may not be types and thus do not have a `__module__` available. So instead we look at the globals in our parent stack frame.

It is expected that the `ns_resolver` passed to this function will have the correct namespace for the type we’re adapting. See the source code for `TypeAdapter.__init__` and `TypeAdapter.rebuild` for various ways to construct this namespace.

This works for the case where this function is called in a module that has the target of forward references in its scope, but does not always work for more complex cases.

For example, take the following:

```python title="a.py"
IntList = list[int]
OuterDict = dict[str, 'IntList']
```

```python title="b.py"
from a import OuterDict

from pydantic import TypeAdapter

IntList = int  # replaces the symbol the forward reference is looking for
v = TypeAdapter(OuterDict)
v({'x': 1})  # should fail but doesn't
```

If `OuterDict` were a `BaseModel`, this would work because it would resolve the forward reference within the `a.py` namespace. But `TypeAdapter(OuterDict)` can’t determine what module `OuterDict` came from.

In other words, the assumption that _all_ forward references exist in the module we are being called from is not technically always true. Although most of the time it is and it works fine for recursive models and such, `BaseModel`’s behavior isn’t perfect either and _can_ break in similar ways, so there is no right or wrong between the two.

But at the very least this behavior is _subtly_ different from `BaseModel`’s.
:::

### Methods

#### rebuild

```python
def rebuild(
    *,
    force: bool = False,
    raise_errors: bool = True,
    _parent_namespace_depth: int = 2,
    _types_namespace: _namespace_utils.MappingNamespace | None = None,
) -> bool | None
```

Try to rebuild the pydantic-core schema for the adapter’s type.

This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.

##### Returns

[`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) — Returns `None` if the schema is already “complete” and rebuilding was not required. [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) — If rebuilding _was_ required, returns `True` if rebuilding was successful, otherwise `False`.

##### Parameters

**`force`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to force the rebuilding of the type adapter’s schema, defaults to `False`.

**`raise_errors`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `True`

Whether to raise errors, defaults to `True`.

**`_parent_namespace_depth`** : [`int`](https://docs.python.org/3/builtins/functions.html#int) _Default:_ `2`

Depth at which to search for the [parent frame](https://docs.python.org/3/reference/datamodel.html#frame-objects). This frame is used when resolving forward annotations during schema rebuilding, by looking for the locals of this frame. Defaults to 2, which will result in the frame where the method was called.

**`_types_namespace`** : `_namespace_utils.MappingNamespace` | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

An explicit types namespace to use, instead of using the local namespace from the parent frame. Defaults to `None`.

#### validate\_python

```python
def validate_python(
    object: Any,
    /,
    *,
    strict: bool | None = None,
    extra: ExtraValues | None = None,
    from_attributes: bool | None = None,
    context: Any | None = None,
    experimental_allow_partial: bool | Literal['off', 'on', 'trailing-strings'] = False,
    by_alias: bool | None = None,
    by_name: bool | None = None,
) -> T
```

Validate a Python object against the model.

A failure here names the fields that were rejected, but not the object they came from. If you record validations with [Logfire](/guides/integrations-logfire), that object is kept alongside the error — `TypeAdapter` validations are captured the same way as model validations (see [Troubleshooting validation errors](/guides/error-messages-troubleshooting)).

:::callout{intent="note"}
When using `TypeAdapter` with a Pydantic `dataclass`, the use of the `from_attributes` argument is not supported.
:::

##### Returns

`T` — The validated object.

##### Parameters

**`object`** : [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)

The Python object to validate against the model.

**`strict`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to strictly check types.

**`extra`** : `ExtraValues` | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to ignore, allow, or forbid extra data during model validation. See the [`extra` configuration value](/guides/pydantic-config#extra) for details.

**`from_attributes`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to extract data from object attributes.

**`context`** : [`Any`](https://docs.python.org/3/library/typing.html#typing.Any) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Additional context to pass to the validator.

**`experimental_allow_partial`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`Literal`](https://docs.python.org/3/library/typing.html#typing.Literal)\[‘off’, ‘on’, ‘trailing-strings’] _Default:_ `False`

**Experimental** whether to enable [partial validation](/guides/concepts-experimental#partial-validation), e.g. to process streams.

- False / ‘off’: Default behavior, no partial validation.
- True / ‘on’: Enable partial validation.
- ‘trailing-strings’: Enable partial validation and allow trailing strings in the input.

**`by_alias`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to use the field’s alias when validating against the provided input data.

**`by_name`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to use the field’s name when validating against the provided input data.

#### validate\_json

```python
def validate_json(
    data: str | bytes | bytearray,
    /,
    *,
    strict: bool | None = None,
    extra: ExtraValues | None = None,
    context: Any | None = None,
    experimental_allow_partial: bool | Literal['off', 'on', 'trailing-strings'] = False,
    by_alias: bool | None = None,
    by_name: bool | None = None,
) -> T
```

:::callout{intent="note" title="Usage Documentation"}
[JSON Parsing](/guides/concepts-json#json-parsing)
:::

Validate a JSON string or bytes against the model.

JSON validated this way often comes from an external source, where a [`ValidationError`](/guides/pydantic-core-pydantic-core#validationerror) can be the first sign that the source changed shape. [Logfire](/guides/integrations-logfire) records the document that failed together with the errors — see [Troubleshooting validation errors](/guides/error-messages-troubleshooting).

##### Returns

`T` — The validated object.

##### Parameters

**`data`** : [`str`](https://docs.python.org/3/builtins/stdtypes.html#str) | [`bytes`](https://docs.python.org/3/builtins/stdtypes.html#bytes) | [`bytearray`](https://docs.python.org/3/builtins/stdtypes.html#bytearray)

The JSON data to validate against the model.

**`strict`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to strictly check types.

**`extra`** : `ExtraValues` | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to ignore, allow, or forbid extra data during model validation. See the [`extra` configuration value](/guides/pydantic-config#extra) for details.

**`context`** : [`Any`](https://docs.python.org/3/library/typing.html#typing.Any) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Additional context to use during validation.

**`experimental_allow_partial`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`Literal`](https://docs.python.org/3/library/typing.html#typing.Literal)\[‘off’, ‘on’, ‘trailing-strings’] _Default:_ `False`

**Experimental** whether to enable [partial validation](/guides/concepts-experimental#partial-validation), e.g. to process streams.

- False / ‘off’: Default behavior, no partial validation.
- True / ‘on’: Enable partial validation.
- ‘trailing-strings’: Enable partial validation and allow trailing strings in the input.

**`by_alias`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to use the field’s alias when validating against the provided input data.

**`by_name`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to use the field’s name when validating against the provided input data.

#### validate\_strings

```python
def validate_strings(
    obj: Any,
    /,
    *,
    strict: bool | None = None,
    extra: ExtraValues | None = None,
    context: Any | None = None,
    experimental_allow_partial: bool | Literal['off', 'on', 'trailing-strings'] = False,
    by_alias: bool | None = None,
    by_name: bool | None = None,
) -> T
```

Validate object contains string data against the model.

##### Returns

`T` — The validated object.

##### Parameters

**`obj`** : [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)

The object contains string data to validate.

**`strict`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to strictly check types.

**`extra`** : `ExtraValues` | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to ignore, allow, or forbid extra data during model validation. See the [`extra` configuration value](/guides/pydantic-config#extra) for details.

**`context`** : [`Any`](https://docs.python.org/3/library/typing.html#typing.Any) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Additional context to use during validation.

**`experimental_allow_partial`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`Literal`](https://docs.python.org/3/library/typing.html#typing.Literal)\[‘off’, ‘on’, ‘trailing-strings’] _Default:_ `False`

**Experimental** whether to enable [partial validation](/guides/concepts-experimental#partial-validation), e.g. to process streams.

- False / ‘off’: Default behavior, no partial validation.
- True / ‘on’: Enable partial validation.
- ‘trailing-strings’: Enable partial validation and allow trailing strings in the input.

**`by_alias`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to use the field’s alias when validating against the provided input data.

**`by_name`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to use the field’s name when validating against the provided input data.

#### get\_default\_value

```python
def get_default_value(
    *,
    strict: bool | None = None,
    context: Any | None = None,
) -> Some[T] | None
```

Get the default value for the wrapped type.

##### Returns

`Some`\[`T`] | [`None`](https://docs.python.org/3/builtins/constants.html#None) — The default value wrapped in a `Some` if there is one or None if not.

##### Parameters

**`strict`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to strictly check types.

**`context`** : [`Any`](https://docs.python.org/3/library/typing.html#typing.Any) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Additional context to pass to the validator.

#### dump\_python

```python
def dump_python(
    instance: T,
    /,
    *,
    mode: Literal['json', 'python'] = 'python',
    include: IncEx | None = None,
    exclude: IncEx | None = None,
    by_alias: bool | None = None,
    exclude_unset: bool = False,
    exclude_defaults: bool = False,
    exclude_none: bool = False,
    exclude_computed_fields: bool = False,
    round_trip: bool = False,
    warnings: bool | Literal['none', 'warn', 'error'] = True,
    fallback: Callable[[Any], Any] | None = None,
    serialize_as_any: bool = False,
    polymorphic_serialization: bool | None = None,
    context: Any | None = None,
) -> Any
```

Dump an instance of the adapted type to a Python object.

##### Returns

[`Any`](https://docs.python.org/3/library/typing.html#typing.Any) — The serialized object.

##### Parameters

**`instance`** : `T`

The Python object to serialize.

**`mode`** : [`Literal`](https://docs.python.org/3/library/typing.html#typing.Literal)\[‘json’, ‘python’] _Default:_ `'python'`

The output format.

**`include`** : `IncEx` | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Fields to include in the output.

**`exclude`** : `IncEx` | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Fields to exclude from the output.

**`by_alias`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to use alias names for field names.

**`exclude_unset`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to exclude unset fields.

**`exclude_defaults`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to exclude fields with default values.

**`exclude_none`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to exclude fields with None values.

**`exclude_computed_fields`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to exclude computed fields. While this can be useful for round-tripping, it is usually recommended to use the dedicated `round_trip` parameter instead.

**`round_trip`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to output the serialized data in a way that is compatible with deserialization.

**`warnings`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`Literal`](https://docs.python.org/3/library/typing.html#typing.Literal)\[‘none’, ‘warn’, ‘error’] _Default:_ `True`

How to handle serialization errors. False/“none” ignores them, True/“warn” logs errors, “error” raises a [`PydanticSerializationError`](/guides/pydantic-core-pydantic-core#pydanticserializationerror).

**`fallback`** : [`Callable`](https://docs.python.org/3/library/typing.html#typing.Callable)\[\[[`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)] | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

A function to call when an unknown value is encountered. If not provided, a [`PydanticSerializationError`](/guides/pydantic-core-pydantic-core#pydanticserializationerror) error is raised.

**`serialize_as_any`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to serialize fields with duck-typing serialization behavior.

**`polymorphic_serialization`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to use model and dataclass polymorphic serialization for this call.

**`context`** : [`Any`](https://docs.python.org/3/library/typing.html#typing.Any) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Additional context to pass to the serializer.

#### dump\_json

```python
def dump_json(
    instance: T,
    /,
    *,
    indent: int | None = None,
    ensure_ascii: bool = False,
    include: IncEx | None = None,
    exclude: IncEx | None = None,
    by_alias: bool | None = None,
    exclude_unset: bool = False,
    exclude_defaults: bool = False,
    exclude_none: bool = False,
    exclude_computed_fields: bool = False,
    round_trip: bool = False,
    warnings: bool | Literal['none', 'warn', 'error'] = True,
    fallback: Callable[[Any], Any] | None = None,
    serialize_as_any: bool = False,
    polymorphic_serialization: bool | None = None,
    context: Any | None = None,
) -> bytes
```

:::callout{intent="note" title="Usage Documentation"}
[JSON Serialization](/guides/concepts-json#json-serialization)
:::

Serialize an instance of the adapted type to JSON.

##### Returns

[`bytes`](https://docs.python.org/3/builtins/stdtypes.html#bytes) — The JSON representation of the given instance as bytes.

##### Parameters

**`instance`** : `T`

The instance to be serialized.

**`indent`** : [`int`](https://docs.python.org/3/builtins/functions.html#int) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Number of spaces for JSON indentation.

**`ensure_ascii`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

If `True`, the output is guaranteed to have all incoming non-ASCII characters escaped. If `False` (the default), these characters will be output as-is.

**`include`** : `IncEx` | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Fields to include.

**`exclude`** : `IncEx` | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Fields to exclude.

**`by_alias`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to use alias names for field names.

**`exclude_unset`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to exclude unset fields.

**`exclude_defaults`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to exclude fields with default values.

**`exclude_none`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to exclude fields with a value of `None`.

**`exclude_computed_fields`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to exclude computed fields. While this can be useful for round-tripping, it is usually recommended to use the dedicated `round_trip` parameter instead.

**`round_trip`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to serialize and deserialize the instance to ensure round-tripping.

**`warnings`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`Literal`](https://docs.python.org/3/library/typing.html#typing.Literal)\[‘none’, ‘warn’, ‘error’] _Default:_ `True`

How to handle serialization errors. False/“none” ignores them, True/“warn” logs errors, “error” raises a [`PydanticSerializationError`](/guides/pydantic-core-pydantic-core#pydanticserializationerror).

**`fallback`** : [`Callable`](https://docs.python.org/3/library/typing.html#typing.Callable)\[\[[`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)] | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

A function to call when an unknown value is encountered. If not provided, a [`PydanticSerializationError`](/guides/pydantic-core-pydantic-core#pydanticserializationerror) error is raised.

**`serialize_as_any`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `False`

Whether to serialize fields with duck-typing serialization behavior.

**`polymorphic_serialization`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Whether to use model and dataclass polymorphic serialization for this call.

**`context`** : [`Any`](https://docs.python.org/3/library/typing.html#typing.Any) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

Additional context to pass to the serializer.

#### json\_schema

```python
def json_schema(
    *,
    by_alias: bool = True,
    ref_template: str = DEFAULT_REF_TEMPLATE,
    union_format: Literal['any_of', 'primitive_type_array'] = 'any_of',
    schema_generator: type[GenerateJsonSchema] = GenerateJsonSchema,
    mode: JsonSchemaMode = 'validation',
) -> dict[str, Any]
```

Generate a JSON schema for the adapted type.

##### Returns

[`dict`](https://docs.python.org/3/reference/expressions.html#dict)\[[`str`](https://docs.python.org/3/builtins/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)] — The JSON schema for the model as a dictionary.

##### Parameters

**`by_alias`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `True`

Whether to use alias names for field names.

**`ref_template`** : [`str`](https://docs.python.org/3/builtins/stdtypes.html#str) _Default:_ `DEFAULT_REF_TEMPLATE`

The format string used for generating $ref strings.

**`union_format`** : [`Literal`](https://docs.python.org/3/library/typing.html#typing.Literal)\[‘any\_of’, ‘primitive\_type\_array’] _Default:_ `'any_of'`

The format to use when combining schemas from unions together. Can be one of:

- `'any_of'`: Use the [`anyOf`](https://json-schema.org/understanding-json-schema/reference/combining#anyOf) keyword to combine schemas (the default).
- `'primitive_type_array'`: Use the [`type`](https://json-schema.org/understanding-json-schema/reference/type) keyword as an array of strings, containing each type of the combination. If any of the schemas is not a primitive type (`string`, `boolean`, `null`, `integer` or `number`) or contains constraints/metadata, falls back to `any_of`.

**`schema_generator`** : [`type`](https://docs.python.org/3/glossary.html#term-type)\[`GenerateJsonSchema`] _Default:_ `GenerateJsonSchema`

To override the logic used to generate the JSON schema, as a subclass of `GenerateJsonSchema` with your desired modifications

**`mode`** : `JsonSchemaMode` _Default:_ `'validation'`

The mode in which to generate the schema.

#### json\_schemas

`@staticmethod`

```python
def json_schemas(
    inputs: Iterable[tuple[JsonSchemaKeyT, JsonSchemaMode, TypeAdapter[Any]]],
    /,
    *,
    by_alias: bool = True,
    title: str | None = None,
    description: str | None = None,
    ref_template: str = DEFAULT_REF_TEMPLATE,
    union_format: Literal['any_of', 'primitive_type_array'] = 'any_of',
    schema_generator: type[GenerateJsonSchema] = GenerateJsonSchema,
) -> tuple[dict[tuple[JsonSchemaKeyT, JsonSchemaMode], JsonSchemaValue], JsonSchemaValue]
```

Generate a JSON schema including definitions from multiple type adapters.

##### Returns

[`tuple`](https://docs.python.org/3/builtins/stdtypes.html#tuple)\[[`dict`](https://docs.python.org/3/reference/expressions.html#dict)\[[`tuple`](https://docs.python.org/3/builtins/stdtypes.html#tuple)\[`JsonSchemaKeyT`, `JsonSchemaMode`], `JsonSchemaValue`], `JsonSchemaValue`] — A tuple where:

- The first element is a dictionary whose keys are tuples of JSON schema key type and JSON mode, and whose values are the JSON schema corresponding to that pair of inputs. (These schemas may have JsonRef references to definitions that are defined in the second returned element.)
- The second element is a JSON schema containing all definitions referenced in the first returned element, along with the optional title and description keys.

##### Parameters

**`inputs`** : [`Iterable`](https://docs.python.org/3/library/typing.html#typing.Iterable)\[[`tuple`](https://docs.python.org/3/builtins/stdtypes.html#tuple)\[`JsonSchemaKeyT`, `JsonSchemaMode`, [`TypeAdapter`](/guides/pydantic-type-adapter#typeadapter)\[[`Any`](https://docs.python.org/3/library/typing.html#typing.Any)]]]

Inputs to schema generation. The first two items will form the keys of the (first) output mapping; the type adapters will provide the core schemas that get converted into definitions in the output JSON schema.

**`by_alias`** : [`bool`](https://docs.python.org/3/builtins/functions.html#bool) _Default:_ `True`

Whether to use alias names.

**`title`** : [`str`](https://docs.python.org/3/builtins/stdtypes.html#str) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

The title for the schema.

**`description`** : [`str`](https://docs.python.org/3/builtins/stdtypes.html#str) | [`None`](https://docs.python.org/3/builtins/constants.html#None) _Default:_ `None`

The description for the schema.

**`ref_template`** : [`str`](https://docs.python.org/3/builtins/stdtypes.html#str) _Default:_ `DEFAULT_REF_TEMPLATE`

The format string used for generating $ref strings.

**`union_format`** : [`Literal`](https://docs.python.org/3/library/typing.html#typing.Literal)\[‘any\_of’, ‘primitive\_type\_array’] _Default:_ `'any_of'`

The format to use when combining schemas from unions together. Can be one of:

- `'any_of'`: Use the [`anyOf`](https://json-schema.org/understanding-json-schema/reference/combining#anyOf) keyword to combine schemas (the default).
- `'primitive_type_array'`: Use the [`type`](https://json-schema.org/understanding-json-schema/reference/type) keyword as an array of strings, containing each type of the combination. If any of the schemas is not a primitive type (`string`, `boolean`, `null`, `integer` or `number`) or contains constraints/metadata, falls back to `any_of`.

**`schema_generator`** : [`type`](https://docs.python.org/3/glossary.html#term-type)\[`GenerateJsonSchema`] _Default:_ `GenerateJsonSchema`

The generator class used for creating the schema.

Was this page helpful?

## Related pages

- [API Documentation](./api-documentation-index.md)
- [Concepts](./concepts-index.md)
- [Dev Tools](./dev-tools-index.md)
- [Error Messages](./error-messages-index.md)
- [Examples](./examples-index.md)
- [Integrations](./integrations-index.md)
- [Internals](./internals-index.md)
- [Production Tools](./production-tools-index.md)
- [Pydantic](./pydantic-index.md)
- [Pydantic Core](./pydantic-core-index.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.