to_dict() — anthropic-sdk-python Function Reference

Architecture documentation for the to_dict() function in _models.py from the anthropic-sdk-python codebase.

Function python AnthropicClient AsyncAPI calls 1

Entity Profile

AnthropicClient→ AsyncAPI→ to_dict() — anthropic-sdk-python Function Reference

Dependency Diagram

graph TD
  95c7e945_50f2_bb18_2948_bb6584934562["to_dict()"]
  17ce5647_6f06_0676_a4a5_e378a3f57cb1["BaseModel"]
  95c7e945_50f2_bb18_2948_bb6584934562 -->|defined in| 17ce5647_6f06_0676_a4a5_e378a3f57cb1
  99f35417_9c72_7af2_3e1d_6bc79dcd60df["model_dump()"]
  95c7e945_50f2_bb18_2948_bb6584934562 -->|calls| 99f35417_9c72_7af2_3e1d_6bc79dcd60df
  style 95c7e945_50f2_bb18_2948_bb6584934562 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/anthropic/_models.py lines 129–165

    def to_dict(
        self,
        *,
        mode: Literal["json", "python"] = "python",
        use_api_names: bool = True,
        exclude_unset: bool = True,
        exclude_defaults: bool = False,
        exclude_none: bool = False,
        warnings: bool = True,
    ) -> dict[str, object]:
        """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).

        Args:
            mode:
                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_names: Whether to use the key that the API responded with or the property name. Defaults to `True`.
            exclude_unset: Whether to exclude fields that have not been explicitly set.
            exclude_defaults: Whether to exclude fields that are set to their default value from the output.
            exclude_none: Whether to exclude fields that have a value of `None` from the output.
            warnings: Whether to log warnings when invalid fields are encountered. This is only supported in Pydantic v2.
        """
        return self.model_dump(
            mode=mode,
            by_alias=use_api_names,
            exclude_unset=exclude_unset,
            exclude_defaults=exclude_defaults,
            exclude_none=exclude_none,
            warnings=warnings,
        )