Sync Asset Face V2
immichpy.client.generated.models.sync_asset_face_v2.SyncAssetFaceV2
pydantic-model
Bases: BaseModel
SyncAssetFaceV2
Show JSON schema:
{
"description": "SyncAssetFaceV2",
"properties": {
"assetId": {
"description": "Asset ID",
"format": "uuid",
"title": "Assetid",
"type": "string"
},
"boundingBoxX1": {
"description": "Bounding box X1",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"title": "Boundingboxx1",
"type": "integer"
},
"boundingBoxX2": {
"description": "Bounding box X2",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"title": "Boundingboxx2",
"type": "integer"
},
"boundingBoxY1": {
"description": "Bounding box Y1",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"title": "Boundingboxy1",
"type": "integer"
},
"boundingBoxY2": {
"description": "Bounding box Y2",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"title": "Boundingboxy2",
"type": "integer"
},
"deletedAt": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Face deleted at",
"examples": [
"2024-01-01T00:00:00Z"
],
"title": "Deletedat"
},
"id": {
"description": "Asset face ID",
"format": "uuid",
"title": "Id",
"type": "string"
},
"imageHeight": {
"description": "Image height",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"title": "Imageheight",
"type": "integer"
},
"imageWidth": {
"description": "Image width",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"title": "Imagewidth",
"type": "integer"
},
"isVisible": {
"description": "Is the face visible in the asset",
"title": "Isvisible",
"type": "boolean"
},
"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",
"deletedAt",
"id",
"imageHeight",
"imageWidth",
"isVisible",
"personId",
"sourceType"
],
"title": "SyncAssetFaceV2",
"type": "object"
}
Config:
validate_by_name:Truevalidate_by_alias:Truevalidate_assignment:Trueprotected_namespaces:()
Fields:
-
asset_id(UUID) -
bounding_box_x1(Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]) -
bounding_box_x2(Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]) -
bounding_box_y1(Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]) -
bounding_box_y2(Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]) -
deleted_at(Optional[datetime]) -
id(UUID) -
image_height(Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]) -
image_width(Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]) -
is_visible(StrictBool) -
person_id(Optional[StrictStr]) -
source_type(StrictStr)
Validators:
-
asset_id_validate_regular_expression→asset_id -
deleted_at_validate_regular_expression→deleted_at -
id_validate_regular_expression→id
asset_id
pydantic-field
asset_id: UUID
Asset ID
bounding_box_x1
pydantic-field
bounding_box_x1: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]
Bounding box X1
bounding_box_x2
pydantic-field
bounding_box_x2: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]
Bounding box X2
bounding_box_y1
pydantic-field
bounding_box_y1: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]
Bounding box Y1
bounding_box_y2
pydantic-field
bounding_box_y2: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]
Bounding box Y2
deleted_at
pydantic-field
deleted_at: Optional[datetime]
Face deleted at
id
pydantic-field
id: UUID
Asset face ID
image_height
pydantic-field
image_height: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]
Image height
image_width
pydantic-field
image_width: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]
Image width
is_visible
pydantic-field
is_visible: StrictBool
Is the face visible in the asset
person_id
pydantic-field
person_id: Optional[StrictStr]
Person ID
source_type
pydantic-field
source_type: StrictStr
Source type
asset_id_validate_regular_expression
pydantic-validator
asset_id_validate_regular_expression(value)
Validates the regular expression
Source code in immichpy/client/generated/models/sync_asset_face_v2.py
86 87 88 89 90 91 92 93 94 95 96 | |
deleted_at_validate_regular_expression
pydantic-validator
deleted_at_validate_regular_expression(value)
Validates the regular expression
Source code in immichpy/client/generated/models/sync_asset_face_v2.py
98 99 100 101 102 103 104 105 106 107 108 109 110 111 | |
from_dict
classmethod
from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of SyncAssetFaceV2 from a dict
Source code in immichpy/client/generated/models/sync_asset_face_v2.py
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 | |
from_json
classmethod
from_json(json_str: str) -> Optional[Self]
Create an instance of SyncAssetFaceV2 from a JSON string
Source code in immichpy/client/generated/models/sync_asset_face_v2.py
140 141 142 143 | |
id_validate_regular_expression
pydantic-validator
id_validate_regular_expression(value)
Validates the regular expression
Source code in immichpy/client/generated/models/sync_asset_face_v2.py
113 114 115 116 117 118 119 120 121 122 123 | |
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):
Noneis only added to the output dict for nullable fields that were set at model initialization. Other fields with valueNoneare ignored.
Source code in immichpy/client/generated/models/sync_asset_face_v2.py
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 | |
to_json
to_json() -> str
Returns the JSON representation of the model using alias
Source code in immichpy/client/generated/models/sync_asset_face_v2.py
136 137 138 | |
to_str
to_str() -> str
Returns the string representation of the model using alias
Source code in immichpy/client/generated/models/sync_asset_face_v2.py
132 133 134 | |