Functions/GenXdev.AI.Queries/Invoke-ImageKeywordUpdate.ps1
|
############################################################################### <# .SYNOPSIS Updates image metadata with AI-generated descriptions and keywords. .DESCRIPTION The Invoke-ImageKeywordUpdate function analyzes images using AI to generate descriptions, keywords, and other metadata. It creates a companion JSON file for each image containing this information. The function can process new images only or update existing metadata, and supports recursive directory scanning. .PARAMETER ImageDirectories Specifies the directory containing images to process. Defaults to current directory if not specified. .PARAMETER Language Specifies the language for generated descriptions and keywords. Defaults to English. .PARAMETER PreferencesDatabasePath Database path for preference data files. .PARAMETER Recurse When specified, searches for images in the specified directory and all subdirectories. .PARAMETER OnlyNew When specified, only processes images that don't already have metadata JSON files. .PARAMETER RetryFailed When specified, reprocesses images where previous metadata generation attempts failed. .PARAMETER SessionOnly Use alternative settings stored in session for AI preferences like Language, Image collections, etc. .PARAMETER ClearSession Clear alternative settings stored in session for AI preferences like Language, Image collections, etc. .PARAMETER SkipSession Dont use alternative settings stored in session for AI preferences like Language, Image collections, etc. .EXAMPLE Invoke-ImageKeywordUpdate -ImageDirectories "C:\Photos" -Recurse -OnlyNew .EXAMPLE updateimages -Recurse -RetryFailed -Language "Spanish" #> ############################################################################### function Invoke-ImageKeywordUpdate { [CmdletBinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '')] [Alias('updateimages')] param( ####################################################################### [Parameter( Position = 0, Mandatory = $false, HelpMessage = 'The directory path containing images to process' )] [string] $ImageDirectories = '.\', ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ('Process images in specified directory and all ' + 'subdirectories') )] [switch] $Recurse, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ("Only process images that don't already have face " + 'metadata files') )] [switch] $OnlyNew, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ('Will retry previously failed image keyword ' + 'updates') )] [switch] $RetryFailed, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ('The language for generated descriptions and ' + 'keywords') )] [PSDefaultValue(Value = 'English')] [ValidateSet( 'Afrikaans', 'Akan', 'Albanian', 'Amharic', 'Arabic', 'Armenian', 'Azerbaijani', 'Basque', 'Belarusian', 'Bemba', 'Bengali', 'Bihari', 'Bosnian', 'Breton', 'Bulgarian', 'Cambodian', 'Catalan', 'Cherokee', 'Chichewa', 'Chinese (Simplified)', 'Chinese (Traditional)', 'Corsican', 'Croatian', 'Czech', 'Danish', 'Dutch', 'English', 'Esperanto', 'Estonian', 'Ewe', 'Faroese', 'Filipino', 'Finnish', 'French', 'Frisian', 'Ga', 'Galician', 'Georgian', 'German', 'Greek', 'Guarani', 'Gujarati', 'Haitian Creole', 'Hausa', 'Hawaiian', 'Hebrew', 'Hindi', 'Hungarian', 'Icelandic', 'Igbo', 'Indonesian', 'Interlingua', 'Irish', 'Italian', 'Japanese', 'Javanese', 'Kannada', 'Kazakh', 'Kinyarwanda', 'Kirundi', 'Kongo', 'Korean', 'Krio (Sierra Leone)', 'Kurdish', 'Kurdish (Soranî)', 'Kyrgyz', 'Laothian', 'Latin', 'Latvian', 'Lingala', 'Lithuanian', 'Lozi', 'Luganda', 'Luo', 'Macedonian', 'Malagasy', 'Malay', 'Malayalam', 'Maltese', 'Maori', 'Marathi', 'Mauritian Creole', 'Moldavian', 'Mongolian', 'Montenegrin', 'Nepali', 'Nigerian Pidgin', 'Northern Sotho', 'Norwegian', 'Norwegian (Nynorsk)', 'Occitan', 'Oriya', 'Oromo', 'Pashto', 'Persian', 'Polish', 'Portuguese (Brazil)', 'Portuguese (Portugal)', 'Punjabi', 'Quechua', 'Romanian', 'Romansh', 'Runyakitara', 'Russian', 'Scots Gaelic', 'Serbian', 'Serbo-Croatian', 'Sesotho', 'Setswana', 'Seychellois Creole', 'Shona', 'Sindhi', 'Sinhalese', 'Slovak', 'Slovenian', 'Somali', 'Spanish', 'Spanish (Latin American)', 'Sundanese', 'Swahili', 'Swedish', 'Tajik', 'Tamil', 'Tatar', 'Telugu', 'Thai', 'Tigrinya', 'Tonga', 'Tshiluba', 'Tumbuka', 'Turkish', 'Turkmen', 'Twi', 'Uighur', 'Ukrainian', 'Urdu', 'Uzbek', 'Vietnamese', 'Welsh', 'Wolof', 'Xhosa', 'Yiddish', 'Yoruba', 'Zulu')] [string] $Language, ####################################################################### [parameter( Mandatory = $false, HelpMessage = ('The directory containing face images organized ' + 'by person folders. If not specified, uses the configured ' + 'faces directory preference.') )] [string] $FacesDirectory, ######################################################################## [Parameter( Mandatory = $false, Position = 2, HelpMessage = 'System instructions for the model' )] [string] $Instructions, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'A JSON schema for the requested output format' )] [string] $ResponseFormat = $null, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'Temperature for response randomness (0.0-1.0)' )] [ValidateRange(0.0, 1.0)] [double] $Temperature = 0.2, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'Image detail level' )] [ValidateSet('low', 'medium', 'high')] [string] $ImageDetail = 'high', ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'The type of LLM query' )] [ValidateSet( 'SimpleIntelligence', 'Knowledge', 'Pictures', 'TextTranslation', 'Coding', 'ToolUse' )] [string] $LLMQueryType = 'Pictures', ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'The model identifier or pattern to use for AI operations' )] [string] $Model, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'The LM Studio specific model identifier' )] [Alias('ModelLMSGetIdentifier')] [string] $HuggingFaceIdentifier, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'The maximum number of tokens to use in AI operations' )] [int] $MaxToken, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'The number of CPU cores to dedicate to AI operations' )] [int] $Cpu, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = ("How much to offload to the GPU. If 'off', GPU " + "offloading is disabled. If 'max', all layers are " + 'offloaded to GPU. If a number between 0 and 1, ' + 'that fraction of layers will be offloaded to the ' + 'GPU. -1 = LM Studio will decide how much to ' + 'offload to the GPU. -2 = Auto') )] [ValidateRange(-2, 1)] [int] $Gpu = -1, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'The API endpoint URL for AI operations' )] [string] $ApiEndpoint, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'The API key for authenticated AI operations' )] [string] $ApiKey, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'The timeout in seconds for AI operations' )] [int] $TimeoutSeconds, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'Database path for preference data files' )] [Alias('DatabasePath')] [string] $PreferencesDatabasePath, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'Show the LM Studio window' )] [switch] $ShowWindow, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ('Skip LM-Studio initialization (used when already ' + 'called by parent function)') )] [switch] $NoLMStudioInitialize, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = 'Force stop LM Studio before initialization' )] [switch] $Force, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = "Include model's thoughts in output" )] [switch] $IncludeThoughts, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = ('Use alternative settings stored in session for AI ' + 'preferences') )] [switch] $SessionOnly, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = ('Clear alternative settings stored in session for AI ' + 'preferences') )] [switch] $ClearSession, ######################################################################## [Parameter( Mandatory = $false, HelpMessage = ('Store settings only in persistent preferences without ' + 'affecting session') )] [Alias('FromPreferences')] [switch] $SkipSession, ######################################################################## ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Specifies the functions to use for the AI operation.' )] [string[]] $Functions, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Specifies the exposed cmdlets for the AI operation.' )] [string[]] $ExposedCmdLets, ############################################################################### [Alias('NoConfirmationFor')] [Parameter( Mandatory = $false, HelpMessage = 'Specifies tool function names that do not require confirmation.' )] [string[]] $NoConfirmationToolFunctionNames, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Time-to-live in seconds for the AI operation.' )] [int] $TTLSeconds, ############################################################################### [Alias('m','mon')] [Parameter( Mandatory = $false, HelpMessage = 'Specifies the monitor to use for display.' )] [string] $Monitor, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Width for the display window.' )] [int] $Width, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Temperature for audio response generation.' )] [double] $AudioTemperature, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Temperature for the response generation.' )] [double] $TemperatureResponse, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Number of CPU threads to use.' )] [int] $CpuThreads, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Regular expression to suppress output.' )] [string] $SuppressRegex, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Audio context size for processing.' )] [int] $AudioContextSize, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Silence threshold for audio processing.' )] [double] $SilenceThreshold, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Length penalty for sequence generation.' )] [double] $LengthPenalty, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Entropy threshold for output filtering.' )] [double] $EntropyThreshold, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Log probability threshold for output filtering.' )] [double] $LogProbThreshold, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'No speech threshold for audio detection.' )] [double] $NoSpeechThreshold, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'If specified, do not speak the output.' )] [switch] $DontSpeak, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = "If specified, do not speak the model's thoughts." )] [switch] $DontSpeakThoughts, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'If specified, disables VOX.' )] [switch] $NoVOX, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'If specified, use desktop audio capture.' )] [switch] $UseDesktopAudioCapture, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'If specified, disables context usage.' )] [switch] $NoContext, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'If specified, use beam search sampling strategy.' )] [switch] $WithBeamSearchSamplingStrategy, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'If specified, only return responses.' )] [switch] $OnlyResponses, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Height for the display window.' )] [int] $Height, ############################################################################### [Alias('DelayMilliSeconds')] [Parameter( Mandatory = $false, HelpMessage = 'Delay in milliseconds between sending keys.' )] [int] $SendKeyDelayMilliSeconds, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = "If specified, don't add thoughts to the history." )] [switch] $DontAddThoughtsToHistory, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Continue the last conversation.' )] [switch] $ContinueLast, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Speak the output.' )] [switch] $Speak, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = "Speak the model's thoughts." )] [switch] $SpeakThoughts, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Output only markup blocks.' )] [switch] $OutputMarkdownBlocksOnly, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Filter for markup block types.' )] [string[]] $MarkupBlocksTypeFilter, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'If specified, only chat once.' )] [switch] $ChatOnce, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Disable session caching.' )] [switch] $NoSessionCaching, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Unload after operation.' )] [switch] $Unload, ############################################################################### [Alias('nb')] [Parameter( Mandatory = $false, HelpMessage = 'Disable window borders.' )] [switch] $NoBorders, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Set window position: left.' )] [switch] $Left, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Set window position: right.' )] [switch] $Right, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Set window position: bottom.' )] [switch] $Bottom, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Center the window.' )] [switch] $Centered, ############################################################################### [Alias('fs')] [Parameter( Mandatory = $false, HelpMessage = 'Set window to full screen.' )] [switch] $FullScreen, ############################################################################### [Alias('rf','bg')] [Parameter( Mandatory = $false, HelpMessage = 'Restore focus to the window.' )] [switch] $RestoreFocus, ############################################################################### [Alias('sbs')] [Parameter( Mandatory = $false, HelpMessage = 'Display side by side.' )] [switch] $SideBySide, ############################################################################### [Alias('fw','focus')] [Parameter( Mandatory = $false, HelpMessage = 'Focus the window.' )] [switch] $FocusWindow, ############################################################################### [Alias('fg')] [Parameter( Mandatory = $false, HelpMessage = 'Set the window to foreground.' )] [switch] $SetForeground, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Maximize the window.' )] [switch] $Maximize, ############################################################################### [Alias('Escape')] [Parameter( Mandatory = $false, HelpMessage = 'Send Escape key.' )] [switch] $SendKeyEscape, ############################################################################### [Alias('HoldKeyboardFocus')] [Parameter( Mandatory = $false, HelpMessage = 'Hold keyboard focus when sending keys.' )] [switch] $SendKeyHoldKeyboardFocus, ############################################################################### [Alias('UseShiftEnter')] [Parameter( Mandatory = $false, HelpMessage = 'Use Shift+Enter when sending keys.' )] [switch] $SendKeyUseShiftEnter, ############################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Maximum callback length for tool calls.' )] [int] $MaxToolcallBackLength, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ('PassThru to return structured objects instead ' + 'of outputting to console') )] [Alias('pt')] [switch]$PassThru, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ('Detects changes in the faces directory and ' + 're-registers faces if needed') )] [switch] $AutoUpdateFaces ) begin { # copy identical parameter values for ai meta language function $params = GenXdev.Helpers\Copy-IdenticalParamValues ` -BoundParameters $PSBoundParameters ` -FunctionName 'GenXdev.AI\Get-AIMetaLanguage' ` -DefaultValues (Microsoft.PowerShell.Utility\Get-Variable ` -Scope Local -ErrorAction SilentlyContinue) # get the resolved language setting from ai meta system $language = Get-AIMetaLanguage @params # convert relative path to absolute path $path = GenXdev.FileSystem\Expand-Path $ImageDirectories # verify directory exists before proceeding if (-not [System.IO.Directory]::Exists($path)) { Microsoft.PowerShell.Utility\Write-Host ("The directory '$path' " + 'does not exist.') return } } process { # get all supported image files from the specified directory Microsoft.PowerShell.Management\Get-ChildItem ` -Path "$path\*.jpg", "$path\*.jpeg", "$path\*.gif", "$path\*.png" ` -Recurse:$Recurse -File -ErrorAction SilentlyContinue | Microsoft.PowerShell.Core\ForEach-Object { try { # get the full path of the current image file $image = $PSItem.FullName # ensure image is writable by removing read-only flag if present if ($PSItem.Attributes -band [System.IO.FileAttributes]::ReadOnly) { $PSItem.Attributes = $PSItem.Attributes -bxor ` [System.IO.FileAttributes]::ReadOnly } # determine which metadata file to check based on language preference $metadataFile = if ($language -eq 'English') { "$($image):description.json" } else { "$($image):description.$language.json" } # check if metadata file already exists $fileExists = [System.IO.File]::Exists($metadataFile) # check if we have valid existing content $hasValidContent = $false if ($fileExists) { try { $content = [System.IO.File]::ReadAllText($metadataFile) $existingData = $content | Microsoft.PowerShell.Utility\ConvertFrom-Json $hasValidContent = $existingData.short_description -and $existingData.keywords } catch { # If JSON parsing fails, treat as invalid content $hasValidContent = $false } } # process image if conditions are met (new files or update requested) if ((-not $OnlyNew) -or (-not $fileExists) -or (-not $hasValidContent)) { # define response format schema for ai analysis $responseSchema = @{ type = 'json_schema' json_schema = @{ name = 'image_analysis_response' strict = 'true' schema = @{ type = 'object' properties = @{ short_description = @{ type = 'string' description = ('Brief description of the ' + 'image (max 80 chars)') maxLength = 80 } long_description = @{ type = 'string' description = ('Detailed description of ' + 'the image') } has_nudity = @{ type = 'boolean' description = ('Whether the image ' + 'contains nudity') } keywords = @{ type = 'array' items = @{ type = 'string' } description = 'Array of descriptive keywords' } has_explicit_content = @{ type = 'boolean' description = ('Whether the image contains ' + 'explicit content') } overall_mood_of_image = @{ type = 'string' description = ('The general mood or emotion ' + 'conveyed by the image') } picture_type = @{ type = 'string' description = ('The type or category of ' + 'the image') } style_type = @{ type = 'string' description = ('The artistic or visual style ' + 'of the image') } } required = @( 'short_description', 'long_description', 'has_nudity', 'keywords', 'has_explicit_content', 'overall_mood_of_image', 'picture_type', 'style_type' ) } } } | Microsoft.PowerShell.Utility\ConvertTo-Json -Depth 10 # output verbose information about the image being analyzed Microsoft.PowerShell.Utility\Write-Verbose ('Analyzing image ' + "content: $image with language: $language") $Additional = @{metadata =@( GenXdev.FileSystem\Find-Item "$($image):people.json" -IncludeAlternateFileStreams -PassThru | Microsoft.PowerShell.Core\ForEach-Object FullName | Microsoft.PowerShell.Core\ForEach-Object { try { $content = [IO.File]::ReadAllText($_) $obj = $content | Microsoft.PowerShell.Utility\ConvertFrom-Json if (($null -ne $obj) -and ($null -ne $obj.predictions) -and ($obj.predictions.Count -gt 0)) { $obj.predictions | Microsoft.PowerShell.Core\ForEach-Object { $_ } } } catch { # ignore errors reading existing metadata } }); FileInfo = @{ ImageCollection = [IO.Path]::GetFileName($ImageDirectories) ImageFilename = $image.Substring($ImageDirectories.Length + 1) }}; $json = $Additional | Microsoft.PowerShell.Utility\ConvertTo-Json -Depth 20 # construct comprehensive ai query for image analysis $query = ( 'Analyze image and return a JSON object with properties: ' + "'short_description' (max 80 chars), 'long_description', " + "'has_nudity', 'keywords' (array of strings with all " + 'detected objects, text or anything describing this ' + 'picture, max 15 keywords), ' + "'has_explicit_content', 'overall_mood_of_image', " + "'picture_type' and 'style_type'.`r`n`r`n" + "Generate all descriptions and keywords in $language " + "language.`r`n`r`n" + "Output only JSON, no markdown or anything other than JSON.`r`n`r`n" + "$(($Additional.metadata.Count -gt 0 ? @" Use the metadata below to enrich the descriptions and titles. Like mentioning the person's name in the title when high confidence is detected (> 0.8). If it the name is that of a famous person, tell about his/her life in the long description and mention his name in the title. $json`r`n "@ : "$json`r`n"))" ); # get ai-generated image description and metadata $params = GenXdev.Helpers\Copy-IdenticalParamValues ` -BoundParameters $PSBoundParameters ` -FunctionName 'GenXdev.AI\Invoke-QueryImageContent' ` -DefaultValues (Microsoft.PowerShell.Utility\Get-Variable ` -Scope Local -ErrorAction SilentlyContinue) $description = Invoke-QueryImageContent ` @params ` -ResponseFormat $responseSchema ` -Query $query ` -ImagePath $image ` -Temperature 0.1 $NoLMStudioInitialize = $true # output verbose information about the received analysis Microsoft.PowerShell.Utility\Write-Verbose ('Received ' + "analysis: $description") try { # extract just the json portion of the response text $description = $description.trim() # find the first opening brace position $i0 = $description.IndexOf('{') # find the last closing brace position $i1 = $description.LastIndexOf('}') # extract only the json content if braces found if ($i0 -ge 0) { $description = $description.Substring( $i0, $i1 - $i0 + 1) } $description = (($description | Microsoft.PowerShell.Utility\ConvertFrom-Json | GenXdev.Helpers\ConvertTo-HashTable) + $Additional.FileInfo) | Microsoft.PowerShell.Utility\ConvertTo-Json -Compress -Depth 20 -WarningAction SilentlyContinue # save formatted json metadata to companion file $null = [System.IO.File]::WriteAllText( $metadataFile, $description ) } catch { # output warning if json processing or file writing fails Microsoft.PowerShell.Utility\Write-Verbose ("$PSItem`r`n" + "$description") } } } catch { # output error message if image processing fails Microsoft.PowerShell.Utility\Write-Verbose ("Failed to process image: $image`r`n" + "Error: $($_.Exception.Message)") } } } end { } } ############################################################################### |