Skip to content

System Config Dto

immichpy.client.generated.models.system_config_dto.SystemConfigDto pydantic-model

Bases: BaseModel

SystemConfigDto

Show JSON schema: 
{
  "$defs": {
    "AudioCodec": {
      "description": "Target audio codec",
      "enum": [
        "mp3",
        "aac",
        "libopus",
        "opus",
        "pcm_s16le"
      ],
      "title": "AudioCodec",
      "type": "string"
    },
    "CLIPConfig": {
      "description": "CLIPConfig",
      "properties": {
        "enabled": {
          "description": "Whether the task is enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "modelName": {
          "description": "Name of the model to use",
          "title": "Modelname",
          "type": "string"
        }
      },
      "required": [
        "enabled",
        "modelName"
      ],
      "title": "CLIPConfig",
      "type": "object"
    },
    "CQMode": {
      "description": "CQ mode",
      "enum": [
        "auto",
        "cqp",
        "icq"
      ],
      "title": "CQMode",
      "type": "string"
    },
    "Colorspace": {
      "description": "Colorspace",
      "enum": [
        "srgb",
        "p3"
      ],
      "title": "Colorspace",
      "type": "string"
    },
    "DatabaseBackupConfig": {
      "description": "DatabaseBackupConfig",
      "properties": {
        "cronExpression": {
          "description": "Cron expression",
          "title": "Cronexpression",
          "type": "string"
        },
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "keepLastAmount": {
          "anyOf": [
            {
              "minimum": 1,
              "type": "number"
            },
            {
              "minimum": 1,
              "type": "integer"
            }
          ],
          "description": "Keep last amount",
          "title": "Keeplastamount"
        }
      },
      "required": [
        "cronExpression",
        "enabled",
        "keepLastAmount"
      ],
      "title": "DatabaseBackupConfig",
      "type": "object"
    },
    "DuplicateDetectionConfig": {
      "description": "DuplicateDetectionConfig",
      "properties": {
        "enabled": {
          "description": "Whether the task is enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "maxDistance": {
          "anyOf": [
            {
              "maximum": 0.1,
              "minimum": 0.001,
              "type": "number"
            },
            {
              "maximum": 0,
              "minimum": 1,
              "type": "integer"
            }
          ],
          "description": "Maximum distance threshold for duplicate detection",
          "title": "Maxdistance"
        }
      },
      "required": [
        "enabled",
        "maxDistance"
      ],
      "title": "DuplicateDetectionConfig",
      "type": "object"
    },
    "FacialRecognitionConfig": {
      "description": "FacialRecognitionConfig",
      "properties": {
        "enabled": {
          "description": "Whether the task is enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "maxDistance": {
          "anyOf": [
            {
              "maximum": 2,
              "minimum": 0.1,
              "type": "number"
            },
            {
              "maximum": 2,
              "minimum": 1,
              "type": "integer"
            }
          ],
          "description": "Maximum distance threshold for face recognition",
          "title": "Maxdistance"
        },
        "minFaces": {
          "description": "Minimum number of faces required for recognition",
          "minimum": 1,
          "title": "Minfaces",
          "type": "integer"
        },
        "minScore": {
          "anyOf": [
            {
              "maximum": 1,
              "minimum": 0.1,
              "type": "number"
            },
            {
              "maximum": 1,
              "minimum": 1,
              "type": "integer"
            }
          ],
          "description": "Minimum confidence score for face detection",
          "title": "Minscore"
        },
        "modelName": {
          "description": "Name of the model to use",
          "title": "Modelname",
          "type": "string"
        }
      },
      "required": [
        "enabled",
        "maxDistance",
        "minFaces",
        "minScore",
        "modelName"
      ],
      "title": "FacialRecognitionConfig",
      "type": "object"
    },
    "ImageFormat": {
      "description": "Image format",
      "enum": [
        "jpeg",
        "webp"
      ],
      "title": "ImageFormat",
      "type": "string"
    },
    "JobSettingsDto": {
      "description": "JobSettingsDto",
      "properties": {
        "concurrency": {
          "description": "Concurrency",
          "minimum": 1,
          "title": "Concurrency",
          "type": "integer"
        }
      },
      "required": [
        "concurrency"
      ],
      "title": "JobSettingsDto",
      "type": "object"
    },
    "LogLevel": {
      "description": "LogLevel",
      "enum": [
        "verbose",
        "debug",
        "log",
        "warn",
        "error",
        "fatal"
      ],
      "title": "LogLevel",
      "type": "string"
    },
    "MachineLearningAvailabilityChecksDto": {
      "description": "MachineLearningAvailabilityChecksDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "interval": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "integer"
            }
          ],
          "title": "Interval"
        },
        "timeout": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "integer"
            }
          ],
          "title": "Timeout"
        }
      },
      "required": [
        "enabled",
        "interval",
        "timeout"
      ],
      "title": "MachineLearningAvailabilityChecksDto",
      "type": "object"
    },
    "OAuthTokenEndpointAuthMethod": {
      "description": "Token endpoint auth method",
      "enum": [
        "client_secret_post",
        "client_secret_basic"
      ],
      "title": "OAuthTokenEndpointAuthMethod",
      "type": "string"
    },
    "OcrConfig": {
      "description": "OcrConfig",
      "properties": {
        "enabled": {
          "description": "Whether the task is enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "maxResolution": {
          "description": "Maximum resolution for OCR processing",
          "minimum": 1,
          "title": "Maxresolution",
          "type": "integer"
        },
        "minDetectionScore": {
          "anyOf": [
            {
              "maximum": 1,
              "minimum": 0.1,
              "type": "number"
            },
            {
              "maximum": 1,
              "minimum": 1,
              "type": "integer"
            }
          ],
          "description": "Minimum confidence score for text detection",
          "title": "Mindetectionscore"
        },
        "minRecognitionScore": {
          "anyOf": [
            {
              "maximum": 1,
              "minimum": 0.1,
              "type": "number"
            },
            {
              "maximum": 1,
              "minimum": 1,
              "type": "integer"
            }
          ],
          "description": "Minimum confidence score for text recognition",
          "title": "Minrecognitionscore"
        },
        "modelName": {
          "description": "Name of the model to use",
          "title": "Modelname",
          "type": "string"
        }
      },
      "required": [
        "enabled",
        "maxResolution",
        "minDetectionScore",
        "minRecognitionScore",
        "modelName"
      ],
      "title": "OcrConfig",
      "type": "object"
    },
    "SystemConfigBackupsDto": {
      "description": "SystemConfigBackupsDto",
      "properties": {
        "database": {
          "$ref": "#/$defs/DatabaseBackupConfig"
        }
      },
      "required": [
        "database"
      ],
      "title": "SystemConfigBackupsDto",
      "type": "object"
    },
    "SystemConfigFFmpegDto": {
      "description": "SystemConfigFFmpegDto",
      "properties": {
        "accel": {
          "$ref": "#/$defs/TranscodeHWAccel"
        },
        "accelDecode": {
          "description": "Accelerated decode",
          "title": "Acceldecode",
          "type": "boolean"
        },
        "acceptedAudioCodecs": {
          "description": "Accepted audio codecs",
          "items": {
            "$ref": "#/$defs/AudioCodec"
          },
          "title": "Acceptedaudiocodecs",
          "type": "array"
        },
        "acceptedContainers": {
          "description": "Accepted containers",
          "items": {
            "$ref": "#/$defs/VideoContainer"
          },
          "title": "Acceptedcontainers",
          "type": "array"
        },
        "acceptedVideoCodecs": {
          "description": "Accepted video codecs",
          "items": {
            "$ref": "#/$defs/VideoCodec"
          },
          "title": "Acceptedvideocodecs",
          "type": "array"
        },
        "bframes": {
          "description": "B-frames",
          "maximum": 16,
          "minimum": -1,
          "title": "Bframes",
          "type": "integer"
        },
        "cqMode": {
          "$ref": "#/$defs/CQMode"
        },
        "crf": {
          "description": "CRF",
          "maximum": 51,
          "minimum": 0,
          "title": "Crf",
          "type": "integer"
        },
        "gopSize": {
          "description": "GOP size",
          "minimum": 0,
          "title": "Gopsize",
          "type": "integer"
        },
        "maxBitrate": {
          "description": "Max bitrate",
          "title": "Maxbitrate",
          "type": "string"
        },
        "preferredHwDevice": {
          "description": "Preferred hardware device",
          "title": "Preferredhwdevice",
          "type": "string"
        },
        "preset": {
          "description": "Preset",
          "title": "Preset",
          "type": "string"
        },
        "refs": {
          "description": "References",
          "maximum": 6,
          "minimum": 0,
          "title": "Refs",
          "type": "integer"
        },
        "targetAudioCodec": {
          "$ref": "#/$defs/AudioCodec"
        },
        "targetResolution": {
          "description": "Target resolution",
          "title": "Targetresolution",
          "type": "string"
        },
        "targetVideoCodec": {
          "$ref": "#/$defs/VideoCodec"
        },
        "temporalAQ": {
          "description": "Temporal AQ",
          "title": "Temporalaq",
          "type": "boolean"
        },
        "threads": {
          "description": "Threads",
          "minimum": 0,
          "title": "Threads",
          "type": "integer"
        },
        "tonemap": {
          "$ref": "#/$defs/ToneMapping"
        },
        "transcode": {
          "$ref": "#/$defs/TranscodePolicy"
        },
        "twoPass": {
          "description": "Two pass",
          "title": "Twopass",
          "type": "boolean"
        }
      },
      "required": [
        "accel",
        "accelDecode",
        "acceptedAudioCodecs",
        "acceptedContainers",
        "acceptedVideoCodecs",
        "bframes",
        "cqMode",
        "crf",
        "gopSize",
        "maxBitrate",
        "preferredHwDevice",
        "preset",
        "refs",
        "targetAudioCodec",
        "targetResolution",
        "targetVideoCodec",
        "temporalAQ",
        "threads",
        "tonemap",
        "transcode",
        "twoPass"
      ],
      "title": "SystemConfigFFmpegDto",
      "type": "object"
    },
    "SystemConfigFacesDto": {
      "description": "SystemConfigFacesDto",
      "properties": {
        "import": {
          "description": "Import",
          "title": "Import",
          "type": "boolean"
        }
      },
      "required": [
        "import"
      ],
      "title": "SystemConfigFacesDto",
      "type": "object"
    },
    "SystemConfigGeneratedFullsizeImageDto": {
      "description": "SystemConfigGeneratedFullsizeImageDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "format": {
          "$ref": "#/$defs/ImageFormat"
        },
        "progressive": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": false,
          "description": "Progressive",
          "title": "Progressive"
        },
        "quality": {
          "description": "Quality",
          "maximum": 100,
          "minimum": 1,
          "title": "Quality",
          "type": "integer"
        }
      },
      "required": [
        "enabled",
        "format",
        "quality"
      ],
      "title": "SystemConfigGeneratedFullsizeImageDto",
      "type": "object"
    },
    "SystemConfigGeneratedImageDto": {
      "description": "SystemConfigGeneratedImageDto",
      "properties": {
        "format": {
          "$ref": "#/$defs/ImageFormat"
        },
        "progressive": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": false,
          "title": "Progressive"
        },
        "quality": {
          "description": "Quality",
          "maximum": 100,
          "minimum": 1,
          "title": "Quality",
          "type": "integer"
        },
        "size": {
          "description": "Size",
          "minimum": 1,
          "title": "Size",
          "type": "integer"
        }
      },
      "required": [
        "format",
        "quality",
        "size"
      ],
      "title": "SystemConfigGeneratedImageDto",
      "type": "object"
    },
    "SystemConfigImageDto": {
      "description": "SystemConfigImageDto",
      "properties": {
        "colorspace": {
          "$ref": "#/$defs/Colorspace"
        },
        "extractEmbedded": {
          "description": "Extract embedded",
          "title": "Extractembedded",
          "type": "boolean"
        },
        "fullsize": {
          "$ref": "#/$defs/SystemConfigGeneratedFullsizeImageDto"
        },
        "preview": {
          "$ref": "#/$defs/SystemConfigGeneratedImageDto"
        },
        "thumbnail": {
          "$ref": "#/$defs/SystemConfigGeneratedImageDto"
        }
      },
      "required": [
        "colorspace",
        "extractEmbedded",
        "fullsize",
        "preview",
        "thumbnail"
      ],
      "title": "SystemConfigImageDto",
      "type": "object"
    },
    "SystemConfigJobDto": {
      "description": "SystemConfigJobDto",
      "properties": {
        "backgroundTask": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "editor": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "faceDetection": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "library": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "metadataExtraction": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "migration": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "notifications": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "ocr": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "search": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "sidecar": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "smartSearch": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "thumbnailGeneration": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "videoConversion": {
          "$ref": "#/$defs/JobSettingsDto"
        },
        "workflow": {
          "$ref": "#/$defs/JobSettingsDto"
        }
      },
      "required": [
        "backgroundTask",
        "editor",
        "faceDetection",
        "library",
        "metadataExtraction",
        "migration",
        "notifications",
        "ocr",
        "search",
        "sidecar",
        "smartSearch",
        "thumbnailGeneration",
        "videoConversion",
        "workflow"
      ],
      "title": "SystemConfigJobDto",
      "type": "object"
    },
    "SystemConfigLibraryDto": {
      "description": "SystemConfigLibraryDto",
      "properties": {
        "scan": {
          "$ref": "#/$defs/SystemConfigLibraryScanDto"
        },
        "watch": {
          "$ref": "#/$defs/SystemConfigLibraryWatchDto"
        }
      },
      "required": [
        "scan",
        "watch"
      ],
      "title": "SystemConfigLibraryDto",
      "type": "object"
    },
    "SystemConfigLibraryScanDto": {
      "description": "SystemConfigLibraryScanDto",
      "properties": {
        "cronExpression": {
          "title": "Cronexpression",
          "type": "string"
        },
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "cronExpression",
        "enabled"
      ],
      "title": "SystemConfigLibraryScanDto",
      "type": "object"
    },
    "SystemConfigLibraryWatchDto": {
      "description": "SystemConfigLibraryWatchDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "SystemConfigLibraryWatchDto",
      "type": "object"
    },
    "SystemConfigLoggingDto": {
      "description": "SystemConfigLoggingDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "level": {
          "$ref": "#/$defs/LogLevel"
        }
      },
      "required": [
        "enabled",
        "level"
      ],
      "title": "SystemConfigLoggingDto",
      "type": "object"
    },
    "SystemConfigMachineLearningDto": {
      "description": "SystemConfigMachineLearningDto",
      "properties": {
        "availabilityChecks": {
          "$ref": "#/$defs/MachineLearningAvailabilityChecksDto"
        },
        "clip": {
          "$ref": "#/$defs/CLIPConfig"
        },
        "duplicateDetection": {
          "$ref": "#/$defs/DuplicateDetectionConfig"
        },
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "facialRecognition": {
          "$ref": "#/$defs/FacialRecognitionConfig"
        },
        "ocr": {
          "$ref": "#/$defs/OcrConfig"
        },
        "urls": {
          "items": {
            "type": "string"
          },
          "minItems": 1,
          "title": "Urls",
          "type": "array"
        }
      },
      "required": [
        "availabilityChecks",
        "clip",
        "duplicateDetection",
        "enabled",
        "facialRecognition",
        "ocr",
        "urls"
      ],
      "title": "SystemConfigMachineLearningDto",
      "type": "object"
    },
    "SystemConfigMapDto": {
      "description": "SystemConfigMapDto",
      "properties": {
        "darkStyle": {
          "title": "Darkstyle",
          "type": "string"
        },
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "lightStyle": {
          "title": "Lightstyle",
          "type": "string"
        }
      },
      "required": [
        "darkStyle",
        "enabled",
        "lightStyle"
      ],
      "title": "SystemConfigMapDto",
      "type": "object"
    },
    "SystemConfigMetadataDto": {
      "description": "SystemConfigMetadataDto",
      "properties": {
        "faces": {
          "$ref": "#/$defs/SystemConfigFacesDto"
        }
      },
      "required": [
        "faces"
      ],
      "title": "SystemConfigMetadataDto",
      "type": "object"
    },
    "SystemConfigNewVersionCheckDto": {
      "description": "SystemConfigNewVersionCheckDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "SystemConfigNewVersionCheckDto",
      "type": "object"
    },
    "SystemConfigNightlyTasksDto": {
      "description": "SystemConfigNightlyTasksDto",
      "properties": {
        "clusterNewFaces": {
          "description": "Cluster new faces",
          "title": "Clusternewfaces",
          "type": "boolean"
        },
        "databaseCleanup": {
          "description": "Database cleanup",
          "title": "Databasecleanup",
          "type": "boolean"
        },
        "generateMemories": {
          "description": "Generate memories",
          "title": "Generatememories",
          "type": "boolean"
        },
        "missingThumbnails": {
          "description": "Missing thumbnails",
          "title": "Missingthumbnails",
          "type": "boolean"
        },
        "startTime": {
          "title": "Starttime",
          "type": "string"
        },
        "syncQuotaUsage": {
          "description": "Sync quota usage",
          "title": "Syncquotausage",
          "type": "boolean"
        }
      },
      "required": [
        "clusterNewFaces",
        "databaseCleanup",
        "generateMemories",
        "missingThumbnails",
        "startTime",
        "syncQuotaUsage"
      ],
      "title": "SystemConfigNightlyTasksDto",
      "type": "object"
    },
    "SystemConfigNotificationsDto": {
      "description": "SystemConfigNotificationsDto",
      "properties": {
        "smtp": {
          "$ref": "#/$defs/SystemConfigSmtpDto"
        }
      },
      "required": [
        "smtp"
      ],
      "title": "SystemConfigNotificationsDto",
      "type": "object"
    },
    "SystemConfigOAuthDto": {
      "description": "SystemConfigOAuthDto",
      "properties": {
        "autoLaunch": {
          "description": "Auto launch",
          "title": "Autolaunch",
          "type": "boolean"
        },
        "autoRegister": {
          "description": "Auto register",
          "title": "Autoregister",
          "type": "boolean"
        },
        "buttonText": {
          "description": "Button text",
          "title": "Buttontext",
          "type": "string"
        },
        "clientId": {
          "description": "Client ID",
          "title": "Clientid",
          "type": "string"
        },
        "clientSecret": {
          "description": "Client secret",
          "title": "Clientsecret",
          "type": "string"
        },
        "defaultStorageQuota": {
          "anyOf": [
            {
              "minimum": 0,
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "description": "Default storage quota",
          "title": "Defaultstoragequota"
        },
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "issuerUrl": {
          "description": "Issuer URL",
          "title": "Issuerurl",
          "type": "string"
        },
        "mobileOverrideEnabled": {
          "description": "Mobile override enabled",
          "title": "Mobileoverrideenabled",
          "type": "boolean"
        },
        "mobileRedirectUri": {
          "description": "Mobile redirect URI",
          "title": "Mobileredirecturi",
          "type": "string"
        },
        "profileSigningAlgorithm": {
          "description": "Profile signing algorithm",
          "title": "Profilesigningalgorithm",
          "type": "string"
        },
        "roleClaim": {
          "description": "Role claim",
          "title": "Roleclaim",
          "type": "string"
        },
        "scope": {
          "description": "Scope",
          "title": "Scope",
          "type": "string"
        },
        "signingAlgorithm": {
          "title": "Signingalgorithm",
          "type": "string"
        },
        "storageLabelClaim": {
          "description": "Storage label claim",
          "title": "Storagelabelclaim",
          "type": "string"
        },
        "storageQuotaClaim": {
          "description": "Storage quota claim",
          "title": "Storagequotaclaim",
          "type": "string"
        },
        "timeout": {
          "description": "Timeout",
          "minimum": 1,
          "title": "Timeout",
          "type": "integer"
        },
        "tokenEndpointAuthMethod": {
          "$ref": "#/$defs/OAuthTokenEndpointAuthMethod"
        }
      },
      "required": [
        "autoLaunch",
        "autoRegister",
        "buttonText",
        "clientId",
        "clientSecret",
        "defaultStorageQuota",
        "enabled",
        "issuerUrl",
        "mobileOverrideEnabled",
        "mobileRedirectUri",
        "profileSigningAlgorithm",
        "roleClaim",
        "scope",
        "signingAlgorithm",
        "storageLabelClaim",
        "storageQuotaClaim",
        "timeout",
        "tokenEndpointAuthMethod"
      ],
      "title": "SystemConfigOAuthDto",
      "type": "object"
    },
    "SystemConfigPasswordLoginDto": {
      "description": "SystemConfigPasswordLoginDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "SystemConfigPasswordLoginDto",
      "type": "object"
    },
    "SystemConfigReverseGeocodingDto": {
      "description": "SystemConfigReverseGeocodingDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "SystemConfigReverseGeocodingDto",
      "type": "object"
    },
    "SystemConfigServerDto": {
      "description": "SystemConfigServerDto",
      "properties": {
        "externalDomain": {
          "description": "External domain",
          "title": "Externaldomain",
          "type": "string"
        },
        "loginPageMessage": {
          "description": "Login page message",
          "title": "Loginpagemessage",
          "type": "string"
        },
        "publicUsers": {
          "description": "Public users",
          "title": "Publicusers",
          "type": "boolean"
        }
      },
      "required": [
        "externalDomain",
        "loginPageMessage",
        "publicUsers"
      ],
      "title": "SystemConfigServerDto",
      "type": "object"
    },
    "SystemConfigSmtpDto": {
      "description": "SystemConfigSmtpDto",
      "properties": {
        "enabled": {
          "description": "Whether SMTP email notifications are enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "from": {
          "description": "Email address to send from",
          "title": "From",
          "type": "string"
        },
        "replyTo": {
          "description": "Email address for replies",
          "title": "Replyto",
          "type": "string"
        },
        "transport": {
          "$ref": "#/$defs/SystemConfigSmtpTransportDto"
        }
      },
      "required": [
        "enabled",
        "from",
        "replyTo",
        "transport"
      ],
      "title": "SystemConfigSmtpDto",
      "type": "object"
    },
    "SystemConfigSmtpTransportDto": {
      "description": "SystemConfigSmtpTransportDto",
      "properties": {
        "host": {
          "description": "SMTP server hostname",
          "title": "Host",
          "type": "string"
        },
        "ignoreCert": {
          "description": "Whether to ignore SSL certificate errors",
          "title": "Ignorecert",
          "type": "boolean"
        },
        "password": {
          "description": "SMTP password",
          "title": "Password",
          "type": "string"
        },
        "port": {
          "anyOf": [
            {
              "maximum": 65535,
              "minimum": 0,
              "type": "number"
            },
            {
              "maximum": 65535,
              "minimum": 0,
              "type": "integer"
            }
          ],
          "description": "SMTP server port",
          "title": "Port"
        },
        "secure": {
          "description": "Whether to use secure connection (TLS/SSL)",
          "title": "Secure",
          "type": "boolean"
        },
        "username": {
          "description": "SMTP username",
          "title": "Username",
          "type": "string"
        }
      },
      "required": [
        "host",
        "ignoreCert",
        "password",
        "port",
        "secure",
        "username"
      ],
      "title": "SystemConfigSmtpTransportDto",
      "type": "object"
    },
    "SystemConfigStorageTemplateDto": {
      "description": "SystemConfigStorageTemplateDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "hashVerificationEnabled": {
          "description": "Hash verification enabled",
          "title": "Hashverificationenabled",
          "type": "boolean"
        },
        "template": {
          "description": "Template",
          "title": "Template",
          "type": "string"
        }
      },
      "required": [
        "enabled",
        "hashVerificationEnabled",
        "template"
      ],
      "title": "SystemConfigStorageTemplateDto",
      "type": "object"
    },
    "SystemConfigTemplateEmailsDto": {
      "description": "SystemConfigTemplateEmailsDto",
      "properties": {
        "albumInviteTemplate": {
          "title": "Albuminvitetemplate",
          "type": "string"
        },
        "albumUpdateTemplate": {
          "title": "Albumupdatetemplate",
          "type": "string"
        },
        "welcomeTemplate": {
          "title": "Welcometemplate",
          "type": "string"
        }
      },
      "required": [
        "albumInviteTemplate",
        "albumUpdateTemplate",
        "welcomeTemplate"
      ],
      "title": "SystemConfigTemplateEmailsDto",
      "type": "object"
    },
    "SystemConfigTemplatesDto": {
      "description": "SystemConfigTemplatesDto",
      "properties": {
        "email": {
          "$ref": "#/$defs/SystemConfigTemplateEmailsDto"
        }
      },
      "required": [
        "email"
      ],
      "title": "SystemConfigTemplatesDto",
      "type": "object"
    },
    "SystemConfigThemeDto": {
      "description": "SystemConfigThemeDto",
      "properties": {
        "customCss": {
          "description": "Custom CSS for theming",
          "title": "Customcss",
          "type": "string"
        }
      },
      "required": [
        "customCss"
      ],
      "title": "SystemConfigThemeDto",
      "type": "object"
    },
    "SystemConfigTrashDto": {
      "description": "SystemConfigTrashDto",
      "properties": {
        "days": {
          "description": "Days",
          "minimum": 0,
          "title": "Days",
          "type": "integer"
        },
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "days",
        "enabled"
      ],
      "title": "SystemConfigTrashDto",
      "type": "object"
    },
    "SystemConfigUserDto": {
      "description": "SystemConfigUserDto",
      "properties": {
        "deleteDelay": {
          "description": "Delete delay",
          "minimum": 1,
          "title": "Deletedelay",
          "type": "integer"
        }
      },
      "required": [
        "deleteDelay"
      ],
      "title": "SystemConfigUserDto",
      "type": "object"
    },
    "ToneMapping": {
      "description": "Tone mapping",
      "enum": [
        "hable",
        "mobius",
        "reinhard",
        "disabled"
      ],
      "title": "ToneMapping",
      "type": "string"
    },
    "TranscodeHWAccel": {
      "description": "Transcode hardware acceleration",
      "enum": [
        "nvenc",
        "qsv",
        "vaapi",
        "rkmpp",
        "disabled"
      ],
      "title": "TranscodeHWAccel",
      "type": "string"
    },
    "TranscodePolicy": {
      "description": "Transcode policy",
      "enum": [
        "all",
        "optimal",
        "bitrate",
        "required",
        "disabled"
      ],
      "title": "TranscodePolicy",
      "type": "string"
    },
    "VideoCodec": {
      "description": "Target video codec",
      "enum": [
        "h264",
        "hevc",
        "vp9",
        "av1"
      ],
      "title": "VideoCodec",
      "type": "string"
    },
    "VideoContainer": {
      "description": "Accepted containers",
      "enum": [
        "mov",
        "mp4",
        "ogg",
        "webm"
      ],
      "title": "VideoContainer",
      "type": "string"
    }
  },
  "description": "SystemConfigDto",
  "properties": {
    "backup": {
      "$ref": "#/$defs/SystemConfigBackupsDto"
    },
    "ffmpeg": {
      "$ref": "#/$defs/SystemConfigFFmpegDto"
    },
    "image": {
      "$ref": "#/$defs/SystemConfigImageDto"
    },
    "job": {
      "$ref": "#/$defs/SystemConfigJobDto"
    },
    "library": {
      "$ref": "#/$defs/SystemConfigLibraryDto"
    },
    "logging": {
      "$ref": "#/$defs/SystemConfigLoggingDto"
    },
    "machineLearning": {
      "$ref": "#/$defs/SystemConfigMachineLearningDto"
    },
    "map": {
      "$ref": "#/$defs/SystemConfigMapDto"
    },
    "metadata": {
      "$ref": "#/$defs/SystemConfigMetadataDto"
    },
    "newVersionCheck": {
      "$ref": "#/$defs/SystemConfigNewVersionCheckDto"
    },
    "nightlyTasks": {
      "$ref": "#/$defs/SystemConfigNightlyTasksDto"
    },
    "notifications": {
      "$ref": "#/$defs/SystemConfigNotificationsDto"
    },
    "oauth": {
      "$ref": "#/$defs/SystemConfigOAuthDto"
    },
    "passwordLogin": {
      "$ref": "#/$defs/SystemConfigPasswordLoginDto"
    },
    "reverseGeocoding": {
      "$ref": "#/$defs/SystemConfigReverseGeocodingDto"
    },
    "server": {
      "$ref": "#/$defs/SystemConfigServerDto"
    },
    "storageTemplate": {
      "$ref": "#/$defs/SystemConfigStorageTemplateDto"
    },
    "templates": {
      "$ref": "#/$defs/SystemConfigTemplatesDto"
    },
    "theme": {
      "$ref": "#/$defs/SystemConfigThemeDto"
    },
    "trash": {
      "$ref": "#/$defs/SystemConfigTrashDto"
    },
    "user": {
      "$ref": "#/$defs/SystemConfigUserDto"
    }
  },
  "required": [
    "backup",
    "ffmpeg",
    "image",
    "job",
    "library",
    "logging",
    "machineLearning",
    "map",
    "metadata",
    "newVersionCheck",
    "nightlyTasks",
    "notifications",
    "oauth",
    "passwordLogin",
    "reverseGeocoding",
    "server",
    "storageTemplate",
    "templates",
    "theme",
    "trash",
    "user"
  ],
  "title": "SystemConfigDto",
  "type": "object"
}

Config:

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

Fields:

from_dict classmethod 

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

Create an instance of SystemConfigDto from a dict

Source code in immichpy/client/generated/models/system_config_dto.py 
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of SystemConfigDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "backup": SystemConfigBackupsDto.from_dict(obj["backup"])
            if obj.get("backup") is not None
            else None,
            "ffmpeg": SystemConfigFFmpegDto.from_dict(obj["ffmpeg"])
            if obj.get("ffmpeg") is not None
            else None,
            "image": SystemConfigImageDto.from_dict(obj["image"])
            if obj.get("image") is not None
            else None,
            "job": SystemConfigJobDto.from_dict(obj["job"])
            if obj.get("job") is not None
            else None,
            "library": SystemConfigLibraryDto.from_dict(obj["library"])
            if obj.get("library") is not None
            else None,
            "logging": SystemConfigLoggingDto.from_dict(obj["logging"])
            if obj.get("logging") is not None
            else None,
            "machineLearning": SystemConfigMachineLearningDto.from_dict(
                obj["machineLearning"]
            )
            if obj.get("machineLearning") is not None
            else None,
            "map": SystemConfigMapDto.from_dict(obj["map"])
            if obj.get("map") is not None
            else None,
            "metadata": SystemConfigMetadataDto.from_dict(obj["metadata"])
            if obj.get("metadata") is not None
            else None,
            "newVersionCheck": SystemConfigNewVersionCheckDto.from_dict(
                obj["newVersionCheck"]
            )
            if obj.get("newVersionCheck") is not None
            else None,
            "nightlyTasks": SystemConfigNightlyTasksDto.from_dict(
                obj["nightlyTasks"]
            )
            if obj.get("nightlyTasks") is not None
            else None,
            "notifications": SystemConfigNotificationsDto.from_dict(
                obj["notifications"]
            )
            if obj.get("notifications") is not None
            else None,
            "oauth": SystemConfigOAuthDto.from_dict(obj["oauth"])
            if obj.get("oauth") is not None
            else None,
            "passwordLogin": SystemConfigPasswordLoginDto.from_dict(
                obj["passwordLogin"]
            )
            if obj.get("passwordLogin") is not None
            else None,
            "reverseGeocoding": SystemConfigReverseGeocodingDto.from_dict(
                obj["reverseGeocoding"]
            )
            if obj.get("reverseGeocoding") is not None
            else None,
            "server": SystemConfigServerDto.from_dict(obj["server"])
            if obj.get("server") is not None
            else None,
            "storageTemplate": SystemConfigStorageTemplateDto.from_dict(
                obj["storageTemplate"]
            )
            if obj.get("storageTemplate") is not None
            else None,
            "templates": SystemConfigTemplatesDto.from_dict(obj["templates"])
            if obj.get("templates") is not None
            else None,
            "theme": SystemConfigThemeDto.from_dict(obj["theme"])
            if obj.get("theme") is not None
            else None,
            "trash": SystemConfigTrashDto.from_dict(obj["trash"])
            if obj.get("trash") is not None
            else None,
            "user": SystemConfigUserDto.from_dict(obj["user"])
            if obj.get("user") is not None
            else None,
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of SystemConfigDto from a JSON string

Source code in immichpy/client/generated/models/system_config_dto.py 
147
148
149
150
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SystemConfigDto 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/system_config_dto.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
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 backup
    if self.backup:
        _dict["backup"] = self.backup.to_dict()
    # override the default output from pydantic by calling `to_dict()` of ffmpeg
    if self.ffmpeg:
        _dict["ffmpeg"] = self.ffmpeg.to_dict()
    # override the default output from pydantic by calling `to_dict()` of image
    if self.image:
        _dict["image"] = self.image.to_dict()
    # override the default output from pydantic by calling `to_dict()` of job
    if self.job:
        _dict["job"] = self.job.to_dict()
    # override the default output from pydantic by calling `to_dict()` of library
    if self.library:
        _dict["library"] = self.library.to_dict()
    # override the default output from pydantic by calling `to_dict()` of logging
    if self.logging:
        _dict["logging"] = self.logging.to_dict()
    # override the default output from pydantic by calling `to_dict()` of machine_learning
    if self.machine_learning:
        _dict["machineLearning"] = self.machine_learning.to_dict()
    # override the default output from pydantic by calling `to_dict()` of map
    if self.map:
        _dict["map"] = self.map.to_dict()
    # override the default output from pydantic by calling `to_dict()` of metadata
    if self.metadata:
        _dict["metadata"] = self.metadata.to_dict()
    # override the default output from pydantic by calling `to_dict()` of new_version_check
    if self.new_version_check:
        _dict["newVersionCheck"] = self.new_version_check.to_dict()
    # override the default output from pydantic by calling `to_dict()` of nightly_tasks
    if self.nightly_tasks:
        _dict["nightlyTasks"] = self.nightly_tasks.to_dict()
    # override the default output from pydantic by calling `to_dict()` of notifications
    if self.notifications:
        _dict["notifications"] = self.notifications.to_dict()
    # override the default output from pydantic by calling `to_dict()` of oauth
    if self.oauth:
        _dict["oauth"] = self.oauth.to_dict()
    # override the default output from pydantic by calling `to_dict()` of password_login
    if self.password_login:
        _dict["passwordLogin"] = self.password_login.to_dict()
    # override the default output from pydantic by calling `to_dict()` of reverse_geocoding
    if self.reverse_geocoding:
        _dict["reverseGeocoding"] = self.reverse_geocoding.to_dict()
    # override the default output from pydantic by calling `to_dict()` of server
    if self.server:
        _dict["server"] = self.server.to_dict()
    # override the default output from pydantic by calling `to_dict()` of storage_template
    if self.storage_template:
        _dict["storageTemplate"] = self.storage_template.to_dict()
    # override the default output from pydantic by calling `to_dict()` of templates
    if self.templates:
        _dict["templates"] = self.templates.to_dict()
    # override the default output from pydantic by calling `to_dict()` of theme
    if self.theme:
        _dict["theme"] = self.theme.to_dict()
    # override the default output from pydantic by calling `to_dict()` of trash
    if self.trash:
        _dict["trash"] = self.trash.to_dict()
    # override the default output from pydantic by calling `to_dict()` of user
    if self.user:
        _dict["user"] = self.user.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/system_config_dto.py 
142
143
144
145
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/system_config_dto.py 
138
139
140
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))