Skip to content

Sync Asset Face V1

immichpy.client.generated.models.sync_asset_face_v1.SyncAssetFaceV1 pydantic-model

Bases: BaseModel

SyncAssetFaceV1

Show JSON schema: 
{
  "description": "SyncAssetFaceV1",
  "properties": {
    "assetId": {
      "description": "Asset ID",
      "title": "Assetid",
      "type": "string"
    },
    "boundingBoxX1": {
      "title": "Boundingboxx1",
      "type": "integer"
    },
    "boundingBoxX2": {
      "title": "Boundingboxx2",
      "type": "integer"
    },
    "boundingBoxY1": {
      "title": "Boundingboxy1",
      "type": "integer"
    },
    "boundingBoxY2": {
      "title": "Boundingboxy2",
      "type": "integer"
    },
    "id": {
      "description": "Asset face ID",
      "title": "Id",
      "type": "string"
    },
    "imageHeight": {
      "title": "Imageheight",
      "type": "integer"
    },
    "imageWidth": {
      "title": "Imagewidth",
      "type": "integer"
    },
    "personId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Person ID",
      "title": "Personid"
    },
    "sourceType": {
      "description": "Source type",
      "title": "Sourcetype",
      "type": "string"
    }
  },
  "required": [
    "assetId",
    "boundingBoxX1",
    "boundingBoxX2",
    "boundingBoxY1",
    "boundingBoxY2",
    "id",
    "imageHeight",
    "imageWidth",
    "personId",
    "sourceType"
  ],
  "title": "SyncAssetFaceV1",
  "type": "object"
}

Config:

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

Fields:

  • asset_id (StrictStr)
  • bounding_box_x1 (StrictInt)
  • bounding_box_x2 (StrictInt)
  • bounding_box_y1 (StrictInt)
  • bounding_box_y2 (StrictInt)
  • id (StrictStr)
  • image_height (StrictInt)
  • image_width (StrictInt)
  • person_id (Optional[StrictStr])
  • source_type (StrictStr)

asset_id pydantic-field 

asset_id: StrictStr

Asset ID

id pydantic-field 

id: StrictStr

Asset face ID

person_id pydantic-field 

person_id: Optional[StrictStr]

Person ID

source_type pydantic-field 

source_type: StrictStr

Source type

from_dict classmethod 

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

Create an instance of SyncAssetFaceV1 from a dict

Source code in immichpy/client/generated/models/sync_asset_face_v1.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of SyncAssetFaceV1 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"),
            "boundingBoxX1": obj.get("boundingBoxX1"),
            "boundingBoxX2": obj.get("boundingBoxX2"),
            "boundingBoxY1": obj.get("boundingBoxY1"),
            "boundingBoxY2": obj.get("boundingBoxY2"),
            "id": obj.get("id"),
            "imageHeight": obj.get("imageHeight"),
            "imageWidth": obj.get("imageWidth"),
            "personId": obj.get("personId"),
            "sourceType": obj.get("sourceType"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of SyncAssetFaceV1 from a JSON string

Source code in immichpy/client/generated/models/sync_asset_face_v1.py 
68
69
70
71
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SyncAssetFaceV1 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/sync_asset_face_v1.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
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,
    )
    # set to None if person_id (nullable) is None
    # and model_fields_set contains the field
    if self.person_id is None and "person_id" in self.model_fields_set:
        _dict["personId"] = None

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/sync_asset_face_v1.py 
63
64
65
66
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/sync_asset_face_v1.py 
59
60
61
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))