Rename -Format parameter to -ResponseFormat for consistency across commands

Author: mkht

Docs/New-Assistant.md

@@ -31,7 +31,7 @@ New-Assistant
     [-Temperature <Double>]
     [-TopP <Double>]
     [-MetaData <IDictionary>]
-    [-Format <Object>]
+    [-ResponseFormat <Object>]
     [-JsonSchema <String>]
     [-TimeoutSec <Int32>]
     [-MaxRetryCount <Int32>]
@@ -216,7 +216,7 @@ Required: False
 Position: Named
 ```
 
-### -Format
+### -ResponseFormat
 Specifies the format that the model must output.  
 - `auto` is default.  
 - `json_object` enables JSON mode, which ensures the message the model generates is valid JSON.  
@@ -232,7 +232,7 @@ Position: Named
 
 ### -JsonSchema
 Specifies an object or data structure to represent the JSON Schema that the model should be constrained to follow.  
-Required if `json_schema` is specified for `-Format`. Otherwise, it is ignored.
+Required if `json_schema` is specified for `-ResponseFormat`. Otherwise, it is ignored.
 
 ```yaml
 Type: String

Docs/Request-AudioSpeech.md

@@ -19,7 +19,7 @@ Request-AudioSpeech
     [-Model <String>]
     [-Voice <String>]
     [-Instructions <String>]
-    [-Format <String>]
+    [-ResponseFormat <String>]
     -OutFile <String>
     [-Speed <Double>]
     [-TimeoutSec <Int32>]
@@ -97,7 +97,7 @@ Required: True
 Position: Named
 ```
 
-### -Format
+### -ResponseFormat
 The format of audio. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`
 
 ```yaml

Docs/Request-AudioTranscription.md

@@ -18,7 +18,7 @@ Request-AudioTranscription
     [[-File] <String>]
     [-Model <String>]
     [-Prompt <String>]
-    [-Format <String>]
+    [-ResponseFormat <String>]
     [-Temperature <Double>]
     [-Include <String[]>]
     [-TimestampGranularities <String[]>]
@@ -42,7 +42,7 @@ https://platform.openai.com/docs/guides/speech-to-text/speech-to-text
 
 ### Example 1: Audio-to-Text
 ```PowerShell
-PS C:\> Request-AudioTranscription -File C:\sample\audio.mp3 -Format text
+PS C:\> Request-AudioTranscription -File C:\sample\audio.mp3 -ResponseFormat text
 ```
 ```
 Hello, I am david.
@@ -82,7 +82,7 @@ Required: False
 Position: Named
 ```
 
-### -Format
+### -ResponseFormat
 The format of the transcript output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`.  
 The default value is `text`.
 
@@ -106,7 +106,7 @@ Position: Named
 
 ### -Include
 Additional information to include in the transcription response.  
-`logprobs` only works with `-Format` set to `json` and only with the models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`
+`logprobs` only works with `-ResponseFormat` set to `json` and only with the models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`
 
 ```yaml
 Type: String[]

Docs/Request-AudioTranslation.md

@@ -17,7 +17,7 @@ Request-AudioTranslation
     [[-File] <String>]
     [-Model <String>]
     [-Prompt <String>]
-    [-Format <String>]
+    [-ResponseFormat <String>]
     [-Temperature <Double>]
     [-TimeoutSec <Int32>]
     [-MaxRetryCount <Int32>]
@@ -35,7 +35,7 @@ https://platform.openai.com/docs/guides/speech-to-text/speech-to-text
 
 ### Example 1: Japanese speech to English text.
 ```PowerShell
-Request-AudioTranslation -File C:\sample\japanese.mp3 -Format text
+Request-AudioTranslation -File C:\sample\japanese.mp3 -ResponseFormat text
 ```
 ```
 Hello, My name is tanaka yoshio.
@@ -75,7 +75,7 @@ Required: False
 Position: Named
 ```
 
-### -Format
+### -ResponseFormat
 The format of the transcript output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`.  
 The default value is `text`.
 

Docs/Request-ChatCompletion.md

@@ -54,7 +54,7 @@ Request-ChatCompletion
     [-LogitBias <IDictionary>]
     [-LogProbs <Boolean>]
     [-TopLogProbs <UInt16>]
-    [-Format <Object>]
+    [-ResponseFormat <Object>]
     [-JsonSchema <String>]
     [-Seed <Int64>]
     [-ServiceTier <String>]
@@ -532,7 +532,7 @@ Required: False
 Position: Named
 ```
 
-### -Format
+### -ResponseFormat
 Specifies the format that the model must output.  
 - `text` is default.  
 - `json_object` enables JSON mode, which ensures the message the model generates is valid JSON.  
@@ -548,7 +548,7 @@ Position: Named
 
 ### -JsonSchema
 Specifies an object or data structure to represent the JSON Schema that the model should be constrained to follow.  
-Required if `json_schema` is specified for `-Format`. Otherwise, it is ignored.
+Required if `json_schema` is specified for `-ResponseFormat`. Otherwise, it is ignored.
 
 ```yaml
 Type: String

Docs/Request-Embeddings.md

@@ -16,7 +16,7 @@ Creates an embedding vector representing the input text.
 Request-Embeddings
     [-Text] <String[]>
     [-Model <String>]
-    [-Format <String>]
+    [-EncodingFormat <String>]
     [-Dimensions <Int32>]
     [-User <String>]
     [-AsBatch]
@@ -72,12 +72,13 @@ Position: Named
 Default value: text-embedding-ada-002
 ```
 
-### -Format
+### -EncodingFormat
 The format to return the embeddings in. Can be either `float` or `base64`
 The default value is `float`.
 
 ```yaml
 Type: String
+Aliases: encoding_format
 Required: False
 Position: Named
 Default value: float

Docs/Request-ImageVariation.md

@@ -17,7 +17,7 @@ Request-ImageVariation
     [-Image] <String>
     [-NumberOfImages <UInt16>]
     [-Size <String>]
-    [-Format <String>]
+    [-ResponseFormat <String>]
     [-User <String>]
     [-TimeoutSec <Int32>]
     [-MaxRetryCount <Int32>]
@@ -61,7 +61,7 @@ Request-ImageVariation -Image C:\cupcake.png -OutFile C:\cupcake2.png -Size 256x
 
 ### Example 2: Creates a variation of a given image, then output as base64 string.
 ```PowerShell
-Request-ImageVariation -Image C:\cupcake.png -Format "base64"
+Request-ImageVariation -Image C:\cupcake.png -ResponseFormat "base64"
 ```
 ```
 iVBORw0KGgoAAAANSUhEUgAABAAAAAQACAIAAADwf7zUAAAAaGV......
@@ -107,7 +107,7 @@ Position: Named
 Default value: 1024x1024
 ```
 
-### -Format
+### -ResponseFormat
 The format in which the generated images are returned.  
 Must be one of `url`, `base64` or `byte`.
 
@@ -202,9 +202,9 @@ Position: Named
 
 ## OUTPUTS
 
-### Format = url    : string or array of string
-### Format = base64 : Generated image data represented in base64 string.
-### Format = byte   : Byte array of generated image.
+### ResponseFormat = url    : string or array of string
+### ResponseFormat = base64 : Generated image data represented in base64 string.
+### ResponseFormat = byte   : Byte array of generated image.
 ### OutFile         : Nothing.
 ## NOTES
 

Docs/Set-Assistant.md

@@ -32,7 +32,7 @@ Set-Assistant
     [-Temperature <Double>]
     [-TopP <Double>]
     [-MetaData <IDictionary>]
-    [-Format <Object>]
+    [-ResponseFormat <Object>]
     [-JsonSchema <String>]
     [-TimeoutSec <Int32>]
     [-MaxRetryCount <Int32>]
@@ -228,7 +228,7 @@ Required: False
 Position: Named
 ```
 
-### -Format
+### -ResponseFormat
 Specifies the format that the model must output.  
 - `auto` is default.  
 - `json_object` enables JSON mode, which ensures the message the model generates is valid JSON.  
@@ -244,7 +244,7 @@ Position: Named
 
 ### -JsonSchema
 Specifies an object or data structure to represent the JSON Schema that the model should be constrained to follow.  
-Required if `json_schema` is specified for `-Format`. Otherwise, it is ignored.
+Required if `json_schema` is specified for `-ResponseFormat`. Otherwise, it is ignored.
 
 ```yaml
 Type: String

Docs/Start-ThreadRun.md

@@ -39,7 +39,7 @@ Start-ThreadRun
     [-MetaData <IDictionary>]
     [-Temperature <Double>]
     [-Stream]
-    [-Format <Object>]
+    [-ResponseFormat <Object>]
     [-JsonSchema <String>]
     [-TimeoutSec <Int32>]
     [-MaxRetryCount <Int32>]
@@ -76,7 +76,7 @@ Start-ThreadRun
     [-MetaData <IDictionary>]
     [-Temperature <Double>]
     [-Stream]
-    [-Format <String>]
+    [-ResponseFormat <String>]
     [-TimeoutSec <Int32>]
     [-MaxRetryCount <Int32>]
     [-ApiBase <Uri>]
@@ -278,7 +278,7 @@ Position: Named
 Default value: False
 ```
 
-### -Format
+### -ResponseFormat
 Specifies the format that the model must output.  
 - `default` will only outputs text message.
 - `json_object` enables JSON mode, which ensures the message the model generates is valid JSON.  
@@ -294,7 +294,7 @@ Position: Named
 
 ### -JsonSchema
 Specifies an object or data structure to represent the JSON Schema that the model should be constrained to follow.  
-Required if `json_schema` is specified for `-Format`. Otherwise, it is ignored.
+Required if `json_schema` is specified for `-ResponseFormat`. Otherwise, it is ignored.
 
 ```yaml
 Type: String

Guides/How_to_use_StructuredOutputs.md

@@ -35,10 +35,10 @@ $Result = Request-ChatCompletion `
             -Model "gpt-4o-2024-08-06" `
             -SystemMessage "You are a helpful math tutor. Guide the user through the solution step by step." `
             -Message "How can I solve 8x + 7 = 31" `
-            -Format ([MathReasoning])
+            -ResponseFormat ([MathReasoning])
 ```
 
-The point is that the `-Format` parameter specifies the defined PowerShell class type `[MathReasoning]`.  
+The point is that the `-ResponseFormat` parameter specifies the defined PowerShell class type `[MathReasoning]`.  
 This instructs the AI model to return an object of this type using Structured Ouputs mode.
 
 PSOpenAI deserialize the response and sets the `Answer` property to an object of the specified type.
@@ -153,7 +153,7 @@ $Result = Request-ChatCompletion `
             -Model "gpt-4o-2024-08-06" `
             -SystemMessage "You are an assistant who reads the meeting information from messages." `
             -Message $TextMessage `
-            -Format ([MeetingEvent])
+            -ResponseFormat ([MeetingEvent])
 
 $Result.Answer[0]
 #> Topics      : {Details of the contract, Potential changes and price adjustments}
@@ -174,7 +174,7 @@ $Result.Answer[0].Attendees
 ## Use Structured Outputs with own JSON schema
 
 If using the built-in parser is not suitable, you can specify your own JSON schema directly.  
-Specify `"json_schema"` to `-Format` and a JSON schema string to `-JsonSchema`.
+Specify `"json_schema"` to `-ResponseFormat` and a JSON schema string to `-JsonSchema`.
 
 Please refer to the official OpenAI guide to creating your own JSON schema.  
 https://platform.openai.com/docs/guides/structured-outputs/supported-schemas
@@ -212,7 +212,7 @@ $ownJsonSchema = @'
 $Result = Request-ChatCompletion `
             -Model "gpt-4o-mini" `
             -Message "9.11 and 9.9 -- which is bigger?" `
-            -Format "json_schema" `
+            -ResponseFormat "json_schema" `
             -JsonSchema $ownJsonSchema
 ```