Skip to content

Person With Faces Response Dto

immichpy.client.generated.models.person_with_faces_response_dto.PersonWithFacesResponseDto pydantic-model

Bases: BaseModel

PersonWithFacesResponseDto

Show JSON schema: 
{
  "$defs": {
    "AssetFaceWithoutPersonResponseDto": {
      "description": "AssetFaceWithoutPersonResponseDto",
      "properties": {
        "boundingBoxX1": {
          "description": "Bounding box X1 coordinate",
          "title": "Boundingboxx1",
          "type": "integer"
        },
        "boundingBoxX2": {
          "description": "Bounding box X2 coordinate",
          "title": "Boundingboxx2",
          "type": "integer"
        },
        "boundingBoxY1": {
          "description": "Bounding box Y1 coordinate",
          "title": "Boundingboxy1",
          "type": "integer"
        },
        "boundingBoxY2": {
          "description": "Bounding box Y2 coordinate",
          "title": "Boundingboxy2",
          "type": "integer"
        },
        "id": {
          "description": "Face ID",
          "format": "uuid",
          "title": "Id",
          "type": "string"
        },
        "imageHeight": {
          "description": "Image height in pixels",
          "title": "Imageheight",
          "type": "integer"
        },
        "imageWidth": {
          "description": "Image width in pixels",
          "title": "Imagewidth",
          "type": "integer"
        },
        "sourceType": {
          "anyOf": [
            {
              "$ref": "#/$defs/SourceType"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Face detection source type"
        }
      },
      "required": [
        "boundingBoxX1",
        "boundingBoxX2",
        "boundingBoxY1",
        "boundingBoxY2",
        "id",
        "imageHeight",
        "imageWidth"
      ],
      "title": "AssetFaceWithoutPersonResponseDto",
      "type": "object"
    },
    "SourceType": {
      "description": "Face detection source type",
      "enum": [
        "machine-learning",
        "exif",
        "manual"
      ],
      "title": "SourceType",
      "type": "string"
    }
  },
  "description": "PersonWithFacesResponseDto",
  "properties": {
    "birthDate": {
      "anyOf": [
        {
          "format": "date",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Person date of birth",
      "title": "Birthdate"
    },
    "color": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Person color (hex)",
      "title": "Color"
    },
    "faces": {
      "description": "Face detections",
      "items": {
        "$ref": "#/$defs/AssetFaceWithoutPersonResponseDto"
      },
      "title": "Faces",
      "type": "array"
    },
    "id": {
      "description": "Person ID",
      "title": "Id",
      "type": "string"
    },
    "isFavorite": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Is favorite",
      "title": "Isfavorite"
    },
    "isHidden": {
      "description": "Is hidden",
      "title": "Ishidden",
      "type": "boolean"
    },
    "name": {
      "description": "Person name",
      "title": "Name",
      "type": "string"
    },
    "thumbnailPath": {
      "description": "Thumbnail path",
      "title": "Thumbnailpath",
      "type": "string"
    },
    "updatedAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Last update date",
      "title": "Updatedat"
    }
  },
  "required": [
    "birthDate",
    "faces",
    "id",
    "isHidden",
    "name",
    "thumbnailPath"
  ],
  "title": "PersonWithFacesResponseDto",
  "type": "object"
}

Config:

  • populate_by_name: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

birth_date pydantic-field 

birth_date: Optional[date]

Person date of birth

color pydantic-field 

color: Optional[StrictStr] = None

Person color (hex)

faces pydantic-field 

faces: List[AssetFaceWithoutPersonResponseDto]

Face detections

id pydantic-field 

id: StrictStr

Person ID

is_favorite pydantic-field 

is_favorite: Optional[StrictBool] = None

Is favorite

is_hidden pydantic-field 

is_hidden: StrictBool

Is hidden

name pydantic-field 

name: StrictStr

Person name

thumbnail_path pydantic-field 

thumbnail_path: StrictStr

Thumbnail path

updated_at pydantic-field 

updated_at: Optional[datetime] = None

Last update date

from_dict classmethod 

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

Create an instance of PersonWithFacesResponseDto from a dict

Source code in immichpy/client/generated/models/person_with_faces_response_dto.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of PersonWithFacesResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "birthDate": obj.get("birthDate"),
            "color": obj.get("color"),
            "faces": [
                AssetFaceWithoutPersonResponseDto.from_dict(_item)
                for _item in obj["faces"]
            ]
            if obj.get("faces") is not None
            else None,
            "id": obj.get("id"),
            "isFavorite": obj.get("isFavorite"),
            "isHidden": obj.get("isHidden"),
            "name": obj.get("name"),
            "thumbnailPath": obj.get("thumbnailPath"),
            "updatedAt": obj.get("updatedAt"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of PersonWithFacesResponseDto from a JSON string

Source code in immichpy/client/generated/models/person_with_faces_response_dto.py 
80
81
82
83
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of PersonWithFacesResponseDto 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/person_with_faces_response_dto.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
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,
    )
    # override the default output from pydantic by calling `to_dict()` of each item in faces (list)
    _items = []
    if self.faces:
        for _item_faces in self.faces:
            if _item_faces:
                _items.append(_item_faces.to_dict())
        _dict["faces"] = _items
    # set to None if birth_date (nullable) is None
    # and model_fields_set contains the field
    if self.birth_date is None and "birth_date" in self.model_fields_set:
        _dict["birthDate"] = None

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/person_with_faces_response_dto.py 
75
76
77
78
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
    return json.dumps(self.to_dict())

to_str 

to_str() -> str

Returns the string representation of the model using alias

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