feat(server): Import face regions from metadata (#6455)

* feat: faces-from-metadata - Import face regions from metadata

Implements immich-app#1692.
- OpenAPI spec changes to accomodate metadata face import configs. New settings to enable the feature.
- Updates admin UI compoments
- ML faces detection/recognition & Exif/Metadata faces compatibility

Signed-off-by: BugFest <bugfest.dev@pm.me>

* chore(web): remove unused file confirm-enable-import-faces

* chore(web): format metadata-settings

* fix(server): faces-from-metadata tests and format

* fix(server): code refinements, nullable face asset sourceType

* fix(server): Add RegionInfo to ImmichTags interface

* fix(server): deleteAllFaces sourceType param can be undefined

* fix(server): exiftool-vendored 27.0.0 moves readArgs into ExifToolOptions

* fix(server): rename isImportFacesFromMetadataEnabled to isFaceImportEnabled

* fix(server): simplify sourceType conditional

* fix(server): small fixes

* fix(server): handling sourceType

* fix(server): sourceType enum

* fix(server): refactor metadata applyTaggedFaces

* fix(server): create/update signature changes

* fix(server): reduce computational cost of Person.getManyByName

* fix(server): use faceList instead of faceSet

* fix(server): Skip regions without Name defined

* fix(mobile): Update open-api (face assets feature changes)

* fix(server): Face-Person reconciliation with map/index

* fix(server): tags.RegionInfo.AppliedToDimensions must be defined to process face-region

* fix(server): fix shared-link.service.ts format

* fix(mobile): Update open-api after branch update

* simplify

* fix(server): minor fixes

* fix(server): person create/update methods type enforcement

* fix(server): style fixes

* fix(server): remove unused metadata code

* fix(server): metadata faces unit tests

* fix(server): top level config metadata category

* fix(server): rename upsertFaces to replaceFaces

* fix(server): remove sourceType when unnecessary

* fix(server): sourceType as ENUM

* fix(server): format fixes

* fix(server): fix tests after sourceType ENUM change

* fix(server): remove unnecessary JobItem cast

* fix(server): fix asset enum imports

* fix(open-api): add metadata config

* fix(mobile): update open-api after metadata open-api spec changes

* fix(web): update web/api metadata config

* fix(server): remove duplicated sourceType def

* fix(server): update generated sql queries

* fix(e2e): tests for metadata face import feature

* fix(web): Fix check:typescript

* fix(e2e): update subproject ref

* fix(server): revert format changes to pass format checks after ci

* fix(mobile): update open-api

* fix(server,movile,open-api,mobile): sourceType as DB data type

* fix(e2e): upload face asset after enabling metadata face import

* fix(web): simplify metadata admin settings and i18n keys

* Update person.repository.ts

Co-authored-by: Jason Rasmussen <jason@rasm.me>

* fix(server): asset_faces.sourceType column not nullable

* fix(server): simplified syntax

* fix(e2e): use SDK for everything except the endpoint being tested

* fix(e2e): fix test format

* chore: clean up

* chore: clean up

* chore: update e2e/test-assets

---------

Signed-off-by: BugFest <bugfest.dev@pm.me>
Co-authored-by: mertalev <101130780+mertalev@users.noreply.github.com>
Co-authored-by: Jason Rasmussen <jason@rasm.me>
This commit is contained in:
BugFest
2024-09-05 00:23:58 +02:00
committed by GitHub
parent 720412645f
commit 77e6a6d78b
48 changed files with 1058 additions and 96 deletions

View File

@@ -8018,6 +8018,9 @@
}
],
"nullable": true
},
"sourceType": {
"$ref": "#/components/schemas/SourceType"
}
},
"required": [
@@ -8086,6 +8089,9 @@
},
"imageWidth": {
"type": "integer"
},
"sourceType": {
"$ref": "#/components/schemas/SourceType"
}
},
"required": [
@@ -10688,6 +10694,9 @@
"facialRecognition": {
"type": "boolean"
},
"importFaces": {
"type": "boolean"
},
"map": {
"type": "boolean"
},
@@ -10721,6 +10730,7 @@
"duplicateDetection",
"email",
"facialRecognition",
"importFaces",
"map",
"oauth",
"oauthAutoLaunch",
@@ -11229,6 +11239,13 @@
],
"type": "object"
},
"SourceType": {
"enum": [
"machine-learning",
"exif"
],
"type": "string"
},
"StackCreateDto": {
"properties": {
"assetIds": {
@@ -11299,6 +11316,9 @@
"map": {
"$ref": "#/components/schemas/SystemConfigMapDto"
},
"metadata": {
"$ref": "#/components/schemas/SystemConfigMetadataDto"
},
"newVersionCheck": {
"$ref": "#/components/schemas/SystemConfigNewVersionCheckDto"
},
@@ -11338,6 +11358,7 @@
"logging",
"machineLearning",
"map",
"metadata",
"newVersionCheck",
"notifications",
"oauth",
@@ -11464,6 +11485,17 @@
],
"type": "object"
},
"SystemConfigFacesDto": {
"properties": {
"import": {
"type": "boolean"
}
},
"required": [
"import"
],
"type": "object"
},
"SystemConfigImageDto": {
"properties": {
"colorspace": {
@@ -11656,6 +11688,17 @@
],
"type": "object"
},
"SystemConfigMetadataDto": {
"properties": {
"faces": {
"$ref": "#/components/schemas/SystemConfigFacesDto"
}
},
"required": [
"faces"
],
"type": "object"
},
"SystemConfigNewVersionCheckDto": {
"properties": {
"enabled": {

View File

@@ -207,6 +207,7 @@ export type AssetFaceWithoutPersonResponseDto = {
id: string;
imageHeight: number;
imageWidth: number;
sourceType?: SourceType;
};
export type PersonWithFacesResponseDto = {
birthDate: string | null;
@@ -508,6 +509,7 @@ export type AssetFaceResponseDto = {
imageHeight: number;
imageWidth: number;
person: (PersonResponseDto) | null;
sourceType?: SourceType;
};
export type FaceDto = {
id: string;
@@ -893,6 +895,7 @@ export type ServerFeaturesDto = {
duplicateDetection: boolean;
email: boolean;
facialRecognition: boolean;
importFaces: boolean;
map: boolean;
oauth: boolean;
oauthAutoLaunch: boolean;
@@ -1122,6 +1125,12 @@ export type SystemConfigMapDto = {
enabled: boolean;
lightStyle: string;
};
export type SystemConfigFacesDto = {
"import": boolean;
};
export type SystemConfigMetadataDto = {
faces: SystemConfigFacesDto;
};
export type SystemConfigNewVersionCheckDto = {
enabled: boolean;
};
@@ -1178,6 +1187,7 @@ export type SystemConfigDto = {
logging: SystemConfigLoggingDto;
machineLearning: SystemConfigMachineLearningDto;
map: SystemConfigMapDto;
metadata: SystemConfigMetadataDto;
newVersionCheck: SystemConfigNewVersionCheckDto;
notifications: SystemConfigNotificationsDto;
oauth: SystemConfigOAuthDto;
@@ -3226,6 +3236,10 @@ export enum AlbumUserRole {
Editor = "editor",
Viewer = "viewer"
}
export enum SourceType {
MachineLearning = "machine-learning",
Exif = "exif"
}
export enum AssetTypeEnum {
Image = "IMAGE",
Video = "VIDEO",