src/commands/Get-ChatFunction.ps1
|
# # Copyright (c), Adam Edwards # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # <# .SYNOPSIS Retrieves all currently chat functions which are functions defined by natural language. .DESCRIPTION Get-ChatFunction enumerates chat functions defined by the New-ChatFunction command. For more information about chat functions, see the documentation of the New-ChatFunction command. The command can return all chat functions, or just a specific function based on a parameter that specifies a name or id for the function. The output of Get-ChatFunction may also be used with other commands that operate on functions such as Invoke-ChatFunction, Remove-ChatFunction, etc. .PARAMETER Id All chat functions have a unique identifier -- specify the unique identifier of the function to be returned using the Id parameter. .PARAMETER Name For a chat function given an optional friendly name, specify the function's name to the Name parameter in order to obtain the function with that name. .OUTPUTS The chat function or functions given by the parameters specified to the command. .EXAMPLE Get-ChatFunction Id Name Definition -- ---- ---------- 1e23861b-0beb-44fe-a515-8bf0c83138cb Generate PowerShell code that accomplishes the following goal {{$goal}… d7b26b42-241a-43e8-92f4-99df30a1f1ba Merger Provide a single sentence that has the same meaning as the individual … 18677113-80ea-4aec-bebc-17f100cbf938 Pascal Show the first {{$rows}} levels of Pascals triangle b2869d25-7910-4846-be8a-677eab45500e Translator Translate the text {{$sourcetext}} into the language {{$language}} Here Get-ChatFunction is specified with no parameters to retrieve all chat functions defined by invocaions of New-ChatFunction or New-ChaScriptBlock .EXAMPLE Get-ChatFunction Merger Id Name Definition -- ---- ---------- d7b26b42-241a-43e8-92f4-99df30a1f1ba Merger Provide a single sentence that has the same meaning as the individual sentences combined This example demonstrates specifying a value for the name parameter to return a function by name. .EXAMPLE PS > Get-ChatFunction | Where-Object { ! $_.Name } | Remove-ChatFunction This example enumerates all unnamed functions and removes them by piping them to the Remove-ChatFunction command: .LINK New-ChatFunction Invoke-ChatFunction Remove-ChatFunction New-ChatScriptBlock #> function Get-ChatFunction { [cmdletbinding(positionalbinding=$false)] param( [parameter(parametersetname='id', ValueFromPipelineByPropertyName=$true, mandatory=$true)] [Guid] $Id, [parameter(parametersetname='name', position=0)] [string] $Name ) begin { $functions = GetFunctionInfo } process { if ( $Id ) { $functions.GetFunctionById($Id) } elseif ( $Name ) { $functions.GetFunctionByName($Name) } else { $functions.GetFunctions() } } end { } } [Function]::RegisterFunctionNameCompleter('Get-ChatFunction', 'Name') |