Skip to content

People Update

immichpy.client.generated.models.people_update.PeopleUpdate pydantic-model

Bases: BaseModel

PeopleUpdate

Show JSON schema: 
{
  "description": "PeopleUpdate",
  "properties": {
    "enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Whether people are enabled",
      "title": "Enabled"
    },
    "minimumFaces": {
      "anyOf": [
        {
          "maximum": 9007199254740991,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "People face threshold",
      "title": "Minimumfaces"
    },
    "sidebarWeb": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Whether people appear in web sidebar",
      "title": "Sidebarweb"
    }
  },
  "title": "PeopleUpdate",
  "type": "object"
}

Config:

  • validate_by_name: True
  • validate_by_alias: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

enabled pydantic-field 

enabled: Optional[StrictBool] = None

Whether people are enabled

minimum_faces pydantic-field 

minimum_faces: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]] = None

People face threshold

sidebar_web pydantic-field 

sidebar_web: Optional[StrictBool] = None

Whether people appear in web sidebar

from_dict classmethod 

from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]

Create an instance of PeopleUpdate from a dict

Source code in immichpy/client/generated/models/people_update.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of PeopleUpdate from a dict"""
    if obj is None:
        return None

    if not isinstance(obj, dict):
        return cls.model_validate(obj)

    _obj = cls.model_validate(
        {
            "enabled": obj.get("enabled"),
            "minimumFaces": obj.get("minimumFaces"),
            "sidebarWeb": obj.get("sidebarWeb"),
        }
    )
    return _obj

from_json classmethod 

from_json(json_str: str) -> Optional[Self]

Create an instance of PeopleUpdate from a JSON string

Source code in immichpy/client/generated/models/people_update.py 
60
61
62
63
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of PeopleUpdate from a JSON string"""
    return cls.from_dict(json.loads(json_str))

to_dict 

to_dict() -> Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic's self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
Source code in immichpy/client/generated/models/people_update.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def to_dict(self) -> Dict[str, Any]:
    """Return the dictionary representation of the model using alias.

    This has the following differences from calling pydantic's
    `self.model_dump(by_alias=True)`:

    * `None` is only added to the output dict for nullable fields that
      were set at model initialization. Other fields with value `None`
      are ignored.
    """
    excluded_fields: Set[str] = set([])

    _dict = self.model_dump(
        by_alias=True,
        exclude=excluded_fields,
        exclude_none=True,
    )
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/people_update.py 
56
57
58
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    return json.dumps(to_jsonable_python(self.to_dict()))

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in immichpy/client/generated/models/people_update.py 
52
53
54
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))