Rename tool parameters for consistency in Request-Response function and documentation

Author: mkht

Docs/Request-Response.md

@@ -33,43 +33,43 @@ Request-Response
     [-ParallelToolCalls <Boolean>]
     [-Functions <IDictionary[]>]
     [-CustomTools <IDictionary[]>]
-    [-UseFileSearch] 
+    [-UseFileSearchTool] 
     [-FileSearchVectorStoreIds <String[]>]
     [-FileSearchMaxNumberOfResults <Int32>]
     [-FileSearchRanker <String>]
     [-FileSearchScoreThreshold <Float>]
     [-FileSearchHybridSearchEmbeddingWeight <Float>]
     [-FileSearchHybridSearchTextWeight <Float>]
-    [-UseWebSearch]
+    [-UseWebSearchTool]
     [-WebSearchType <String>]
     [-WebSearchContextSize <String>]
     [-WebSearchAllowedDomains <String[]>]
     [-WebSearchUserLocationCity <String>]
     [-WebSearchUserLocationCountry <String>]
     [-WebSearchUserLocationRegion <String>]
     [-WebSearchUserLocationTimeZone <String>]
-    [-UseComputerUse]
+    [-UseComputerUseTool]
     [-ComputerUseEnvironment <String>]
     [-ComputerUseDisplayHeight <Int32>]
     [-ComputerUseDisplayWidth <Int32>]
-    [-UseRemoteMCP]
+    [-UseRemoteMCPTool]
     [-RemoteMCPServerLabel <String>]
     [-RemoteMCPServerUrl <String>]
     [-RemoteMCPServerDescription <String>]
     [-RemoteMCPAllowedTools <Object>]
     [-RemoteMCPRequireApproval <Object>]
     [-RemoteMCPHeaders <IDictionary>]
     [-RemoteMCPAuthorization <String>]
-    [-UseConnector]
+    [-UseConnectorTool]
     [-ConnectorLabel <String>]
     [-ConnectorId <String>]
     [-ConnectorRequireApproval <String>]
     [-ConnectorAuthorization <String>]
-    [-UseCodeInterpreter]
+    [-UseCodeInterpreterTool]
     [-CodeInterpreterMemoryLimit <String>]
     [-ContainerId <String>]
     [-ContainerFileIds <String[]>]
-    [-UseImageGeneration]
+    [-UseImageGenerationTool]
     [-ImageGenerationModel <String>]
     [-ImageGenerationBackGround <String>]
     [-ImageGenerationInputImageMask <String>]
@@ -79,7 +79,9 @@ Request-Response
     [-ImageGenerationPartialImages <Int32>]
     [-ImageGenerationQuality <String>]
     [-ImageGenerationSize <String>]
-    [-UseLocalShell]
+    [-UseLocalShellTool]
+    [-UseShellTool]
+    [-UseApplyPatchTool]
     [-Include <String[]>]
     [-Truncation <String>]
     [-Temperature <Float>] 
@@ -141,7 +143,7 @@ PS C:\> Request-Response "Summarize this document" -Files 'C:\recipient.pdf' -Mo
 
 ### Example 4: Web search
 ```powershell
-PS C:\> Request-Response "Tell me a recent top 3 tech news." -UseWebSearch -Model 'gpt-4o'
+PS C:\> Request-Response "Tell me a recent top 3 tech news." -UseWebSearchTool -Model 'gpt-4o'
 ```
 
 ### Example 5: Streaming output
@@ -337,7 +339,7 @@ Required: False
 Position: Named
 ```
 
-### -UseFileSearch
+### -UseFileSearchTool
 If you want to use the File search built-in tool, Should specify this switch as enabled.
 
 ```yaml
@@ -400,7 +402,7 @@ Required: False
 Position: Named
 ```
 
-### -UseWebSearch
+### -UseWebSearchTool
 If you want to use the Web search built-in tool, Should specify this switch as enabled.
 
 ```yaml
@@ -474,7 +476,7 @@ Required: False
 Position: Named
 ```
 
-### -UseComputerUse
+### -UseComputerUseTool
 If you want to use the Computer-use built-in tool, Should specify this switch as enabled.
 
 ```yaml
@@ -511,7 +513,7 @@ Required: False
 Position: Named
 ```
 
-### -UseRemoteMCP
+### -UseRemoteMCPTool
 If you want to use the Remote MCP built-in tool, Should specify this switch as enabled.
 
 ```yaml
@@ -583,7 +585,7 @@ Required: False
 Position: Named
 ```
 
-### -UseConnector
+### -UseConnectorTool
 If you want to use the service connector, Should specify this switch as enabled.
 
 ```yaml
@@ -636,7 +638,7 @@ Required: False
 Position: Named
 ```
 
-### -UseCodeInterpreter
+### -UseCodeInterpreterTool
 If you want to use the Code Interpreter built-in tool, Should specify this switch as enabled.
 
 ```yaml
@@ -673,7 +675,7 @@ Required: False
 Position: Named
 ```
 
-### -UseImageGeneration
+### -UseImageGenerationTool
 If you want to use the Imagae Generation built-in tool, Should specify this switch as enabled.
 
 ```yaml
@@ -768,7 +770,7 @@ Position: Named
 Default value: auto
 ```
 
-### -UseLocalShell
+### -UseLocalShellTool
 If you want to use the Local Shell built-in tool, Should specify this switch as enabled.
 
 ```yaml
@@ -777,6 +779,24 @@ Required: False
 Position: Named
 ```
 
+### -UseShellTool
+If you want to use the Shell built-in tool, Should specify this switch as enabled.
+
+```yaml
+Type: SwitchParameter
+Required: False
+Position: Named
+```
+
+### -UseApplyPatchTool
+If you want to use the Apply Patch built-in tool, Should specify this switch as enabled.
+
+```yaml
+Type: SwitchParameter
+Required: False
+Position: Named
+```
+
 ### -Include
 Specify additional output data to include in the model response.
 

Public/Responses/Request-Response.ps1

@@ -105,7 +105,7 @@ function Request-Response {
         # Built-in tools
         #region File Search
         [Parameter()]
-        [switch]$UseFileSearch,
+        [switch]$UseFileSearchTool,
 
         [Parameter(DontShow)]
         [string]$FileSearchType = 'file_search', # Currently, only 'file_search' is acceptable.
@@ -138,7 +138,7 @@ function Request-Response {
 
         #region Web Search
         [Parameter()]
-        [switch]$UseWebSearch,
+        [switch]$UseWebSearchTool,
 
         [Parameter()]
         [Completions('web_search')]
@@ -170,7 +170,7 @@ function Request-Response {
 
         #region Computer use
         [Parameter()]
-        [switch]$UseComputerUse,
+        [switch]$UseComputerUseTool,
 
         [Parameter(DontShow)]
         [string]$ComputerUseType = 'computer_use_preview', # Currently, only 'computer_use_preview' is acceptable.
@@ -188,7 +188,7 @@ function Request-Response {
 
         #region Remote MCP
         [Parameter()]
-        [switch]$UseRemoteMCP,
+        [switch]$UseRemoteMCPTool,
 
         [Parameter(DontShow)]
         [string]$RemoteMCPType = 'mcp', # Always 'mcp'
@@ -220,7 +220,7 @@ function Request-Response {
 
         #region Connectors
         [Parameter()]
-        [switch]$UseConnector,
+        [switch]$UseConnectorTool,
 
         [Parameter()]
         [ValidateNotNullOrEmpty()]
@@ -250,7 +250,7 @@ function Request-Response {
 
         #region Code Interpreter
         [Parameter()]
-        [switch]$UseCodeInterpreter,
+        [switch]$UseCodeInterpreterTool,
 
         [Parameter(DontShow)]
         [string]$CodeInterpreterType = 'code_interpreter', # Always 'code_interpreter'
@@ -268,7 +268,7 @@ function Request-Response {
 
         #region Image Generation
         [Parameter()]
-        [switch]$UseImageGeneration,
+        [switch]$UseImageGenerationTool,
 
         [Parameter(DontShow)]
         [string]$ImageGenerationType = 'image_generation', # Always 'image_generation'
@@ -310,11 +310,21 @@ function Request-Response {
 
         #region Local shell
         [Parameter()]
-        [switch]$UseLocalShell,
+        [switch]$UseLocalShellTool,
 
         [Parameter(DontShow)]
         [string]$LocalShellType = 'local_shell', # Always 'local_shell'
         #endregion Local shell
+
+        #region shell
+        [Parameter()]
+        [switch]$UseShellTool,
+        #endregion shell
+
+        #region Apply patch
+        [Parameter()]
+        [switch]$UseApplyPatchTool,
+        #endregion Apply patch
         #endregion Tools
 
         [Parameter()]
@@ -679,7 +689,7 @@ function Request-Response {
         }
 
         #region File Search
-        if ($UseFileSearch) {
+        if ($UseFileSearchTool) {
             if ($FileSearchVectorStoreIds.Count -eq 0) {
                 Write-Error 'VectorStore Ids must be specified.'
             }
@@ -722,7 +732,7 @@ function Request-Response {
         }
 
         #region Web Search
-        if ($UseWebSearch) {
+        if ($UseWebSearchTool) {
             $UserLocation = @{}
             $WebSearchTool = @{
                 type = $WebSearchType
@@ -756,7 +766,7 @@ function Request-Response {
         }
 
         #region Computer Use
-        if ($UseComputerUse) {
+        if ($UseComputerUseTool) {
             # Computer Use should be used with 'truncation=auto'
             $PostBody.truncation = 'auto'
 
@@ -785,7 +795,7 @@ function Request-Response {
         }
 
         #region Remote MCP
-        if ($UseRemoteMCP) {
+        if ($UseRemoteMCPTool) {
             # Server label and URL are required.
             if ([string]::IsNullOrWhiteSpace($RemoteMCPServerLabel)) {
                 Write-Error 'RemoteMCPServerLabel must be specified.'
@@ -838,7 +848,7 @@ function Request-Response {
         }
 
         #region Connectors
-        if ($UseConnector) {
+        if ($UseConnectorTool) {
             # Server label and connector_id are required.
             if ([string]::IsNullOrWhiteSpace($ConnectorLabel)) {
                 Write-Error 'ConnectorLabel must be specified.'
@@ -865,7 +875,7 @@ function Request-Response {
         }
 
         #region Code Interpreter
-        if ($UseCodeInterpreter) {
+        if ($UseCodeInterpreterTool) {
             $CodeInterpreterTool = @{
                 type      = $CodeInterpreterType
                 container = $ContainerId
@@ -884,7 +894,7 @@ function Request-Response {
         }
 
         #region Image Generation
-        if ($UseImageGeneration) {
+        if ($UseImageGenerationTool) {
             $ImageGenerationTool = @{
                 type = $ImageGenerationType
             }
@@ -928,13 +938,29 @@ function Request-Response {
         }
 
         #region Local Shell
-        if ($UseLocalShell) {
+        if ($UseLocalShellTool) {
             $LocalShellTool = @{
                 type = $LocalShellType
             }
             $Tools += $LocalShellTool
         }
 
+        #region shell
+        if ($UseShellTool) {
+            $ShellTool = @{
+                type = 'shell'
+            }
+            $Tools += $ShellTool
+        }
+
+        #region Apply Patch
+        if ($UseApplyPatchTool) {
+            $ApplyPatchTool = @{
+                type = 'apply_patch'
+            }
+            $Tools += $ApplyPatchTool
+        }
+
         if ($Tools.Count -gt 0) {
             $PostBody.tools = $Tools
         }