Skip to content

User Config Machine Learning Dto

immichpy.client.generated.models.user_config_machine_learning_dto.UserConfigMachineLearningDto pydantic-model

Bases: BaseModel

UserConfigMachineLearningDto

Show JSON schema: 
{
  "$defs": {
    "UserConfigClipDto": {
      "description": "UserConfigClipDto",
      "properties": {
        "enabled": {
          "description": "Whether the task is enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "UserConfigClipDto",
      "type": "object"
    },
    "UserConfigDuplicateDetectionDto": {
      "description": "UserConfigDuplicateDetectionDto",
      "properties": {
        "enabled": {
          "description": "Whether the task is enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "UserConfigDuplicateDetectionDto",
      "type": "object"
    },
    "UserConfigFacialRecognitionDto": {
      "description": "UserConfigFacialRecognitionDto",
      "properties": {
        "enabled": {
          "description": "Whether the task is enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "minFaces": {
          "description": "Minimum number of faces required for recognition",
          "maximum": 9007199254740991,
          "minimum": 1,
          "title": "Minfaces",
          "type": "integer"
        }
      },
      "required": [
        "enabled",
        "minFaces"
      ],
      "title": "UserConfigFacialRecognitionDto",
      "type": "object"
    },
    "UserConfigOcrDto": {
      "description": "UserConfigOcrDto",
      "properties": {
        "enabled": {
          "description": "Whether the task is enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "UserConfigOcrDto",
      "type": "object"
    }
  },
  "description": "UserConfigMachineLearningDto",
  "properties": {
    "clip": {
      "$ref": "#/$defs/UserConfigClipDto"
    },
    "duplicateDetection": {
      "$ref": "#/$defs/UserConfigDuplicateDetectionDto"
    },
    "enabled": {
      "description": "Enabled",
      "title": "Enabled",
      "type": "boolean"
    },
    "facialRecognition": {
      "$ref": "#/$defs/UserConfigFacialRecognitionDto"
    },
    "ocr": {
      "$ref": "#/$defs/UserConfigOcrDto"
    }
  },
  "required": [
    "clip",
    "duplicateDetection",
    "enabled",
    "facialRecognition",
    "ocr"
  ],
  "title": "UserConfigMachineLearningDto",
  "type": "object"
}

Config:

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

Fields:

enabled pydantic-field 

enabled: StrictBool

Enabled

from_dict classmethod 

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

Create an instance of UserConfigMachineLearningDto from a dict

Source code in immichpy/client/generated/models/user_config_machine_learning_dto.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of UserConfigMachineLearningDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "clip": UserConfigClipDto.from_dict(obj["clip"])
            if obj.get("clip") is not None
            else None,
            "duplicateDetection": UserConfigDuplicateDetectionDto.from_dict(
                obj["duplicateDetection"]
            )
            if obj.get("duplicateDetection") is not None
            else None,
            "enabled": obj.get("enabled"),
            "facialRecognition": UserConfigFacialRecognitionDto.from_dict(
                obj["facialRecognition"]
            )
            if obj.get("facialRecognition") is not None
            else None,
            "ocr": UserConfigOcrDto.from_dict(obj["ocr"])
            if obj.get("ocr") is not None
            else None,
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of UserConfigMachineLearningDto from a JSON string

Source code in immichpy/client/generated/models/user_config_machine_learning_dto.py 
71
72
73
74
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of UserConfigMachineLearningDto 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/user_config_machine_learning_dto.py 
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
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 clip
    if self.clip:
        _dict["clip"] = self.clip.to_dict()
    # override the default output from pydantic by calling `to_dict()` of duplicate_detection
    if self.duplicate_detection:
        _dict["duplicateDetection"] = self.duplicate_detection.to_dict()
    # override the default output from pydantic by calling `to_dict()` of facial_recognition
    if self.facial_recognition:
        _dict["facialRecognition"] = self.facial_recognition.to_dict()
    # override the default output from pydantic by calling `to_dict()` of ocr
    if self.ocr:
        _dict["ocr"] = self.ocr.to_dict()
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

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