Skip to main content

Get-IMFace

SYNOPSIS​

Retrieves detected faces from Immich assets

SYNTAX​

Get-IMFace [[-Session] <ImmichSession>] [-Id] <String[]> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Retrieves information about faces detected in one or more Immich assets. This includes face detection data, bounding boxes, and any associated person identifications from facial recognition.

EXAMPLES​

EXAMPLE 1​

Get-IMFace -Id 'asset-uuid'

Retrieves all detected faces for the specified asset.

EXAMPLE 2​

@('asset1-uuid', 'asset2-uuid') | Get-IMFace

Retrieves face information for multiple assets via pipeline.

EXAMPLE 3​

Get-IMAsset -Random -Count 5 | Get-IMFace

Gets face detection data for 5 random assets.

EXAMPLE 4​

Get-IMFace -Id 'asset-uuid' | Where-Object {$_.person}

Retrieves faces that have been identified as specific persons.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

The UUID(s) of the asset(s) to retrieve face information for. Accepts pipeline input and multiple values.

Type: String[]
Parameter Sets: (All)
Aliases: assetId

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

Requires that face detection has been run on the assets. Use Start-IMJob with 'faceDetection' to process assets for face detection.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github