Skip to content

Asset Face Create Dto

immichpy.client.generated.models.asset_face_create_dto.AssetFaceCreateDto pydantic-model

Bases: BaseModel

AssetFaceCreateDto

Show JSON schema: 
{
  "description": "AssetFaceCreateDto",
  "properties": {
    "assetId": {
      "description": "Asset ID",
      "format": "uuid",
      "title": "Assetid",
      "type": "string"
    },
    "height": {
      "description": "Face bounding box height",
      "title": "Height",
      "type": "integer"
    },
    "imageHeight": {
      "description": "Image height in pixels",
      "title": "Imageheight",
      "type": "integer"
    },
    "imageWidth": {
      "description": "Image width in pixels",
      "title": "Imagewidth",
      "type": "integer"
    },
    "personId": {
      "description": "Person ID",
      "format": "uuid",
      "title": "Personid",
      "type": "string"
    },
    "width": {
      "description": "Face bounding box width",
      "title": "Width",
      "type": "integer"
    },
    "x": {
      "description": "Face bounding box X coordinate",
      "title": "X",
      "type": "integer"
    },
    "y": {
      "description": "Face bounding box Y coordinate",
      "title": "Y",
      "type": "integer"
    }
  },
  "required": [
    "assetId",
    "height",
    "imageHeight",
    "imageWidth",
    "personId",
    "width",
    "x",
    "y"
  ],
  "title": "AssetFaceCreateDto",
  "type": "object"
}

Config:

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

Fields:

asset_id pydantic-field 

asset_id: UUID

Asset ID

height pydantic-field 

height: StrictInt

Face bounding box height

image_height pydantic-field 

image_height: StrictInt

Image height in pixels

image_width pydantic-field 

image_width: StrictInt

Image width in pixels

person_id pydantic-field 

person_id: UUID

Person ID

width pydantic-field 

width: StrictInt

Face bounding box width

x pydantic-field 

x: StrictInt

Face bounding box X coordinate

y pydantic-field 

y: StrictInt

Face bounding box Y coordinate

from_dict classmethod 

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

Create an instance of AssetFaceCreateDto from a dict

Source code in immichpy/client/generated/models/asset_face_create_dto.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of AssetFaceCreateDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "assetId": obj.get("assetId"),
            "height": obj.get("height"),
            "imageHeight": obj.get("imageHeight"),
            "imageWidth": obj.get("imageWidth"),
            "personId": obj.get("personId"),
            "width": obj.get("width"),
            "x": obj.get("x"),
            "y": obj.get("y"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of AssetFaceCreateDto from a JSON string

Source code in immichpy/client/generated/models/asset_face_create_dto.py 
69
70
71
72
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of AssetFaceCreateDto 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/asset_face_create_dto.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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/asset_face_create_dto.py 
64
65
66
67
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/asset_face_create_dto.py 
60
61
62
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))