v4.9.0

mkht · Nov 1, 2024 · 0044cb9 · 0044cb9
1 parent a7d32de
commit 0044cb9
Show file tree

Hide file tree

Showing 4 changed files with 167 additions and 3 deletions.
diff --git a/CHANGELOG.ja.md b/CHANGELOG.ja.md
@@ -1,4 +1,15 @@
 # 変更履歴
+### 4.9.0
+- `Request-ChatCompletion`が音声入出力に対応しました
+
+  ```PowerShell
+  Request-ChatCompletion -Model gpt-4o-audio-preview `
+    -Modalities text, audio `
+    -Voice 'shimmer' `
+    -InputAudio 'C:\hello.mp3' `
+    -AudioOutFile 'C:\response.mp3'
+  ```
+
 ### 4.8.0
 - Realtime APIの実験的なサポートを追加します  
   これを使用するとAIアシスタントとリアルタイムの会話が可能になります  

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog
-### Unreleased
-- Add a support for audio input / output in `Request-ChatCompletions`.
+### 4.9.0
+- Add a support for audio input / output in `Request-ChatCompletion`.
 
   ```PowerShell
   Request-ChatCompletion -Model gpt-4o-audio-preview `

diff --git a/PSOpenAI-Help.xml b/PSOpenAI-Help.xml
@@ -12170,6 +12170,79 @@ This is an optional field, and may contain a-z, A-Z, 0-9, hyphens, and underscor
           </dev:type>
           <dev:defaultValue>None</dev:defaultValue>
         </command:parameter>
+        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
+          <maml:name>Modalities</maml:name>
+          <maml:description>
+            <maml:para>Output types that you would like the model to generate for this request.
+Some models can generate both text and audio. To request that responses, you can specify: `("text", "audio")`</maml:para>
+          </maml:description>
+          <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
+          <dev:type>
+            <maml:name>String[]</maml:name>
+            <maml:uri />
+          </dev:type>
+          <dev:defaultValue>None</dev:defaultValue>
+        </command:parameter>
+        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
+          <maml:name>Voice</maml:name>
+          <maml:description>
+            <maml:para>The voice the model uses to respond.</maml:para>
+          </maml:description>
+          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+          <dev:type>
+            <maml:name>String</maml:name>
+            <maml:uri />
+          </dev:type>
+          <dev:defaultValue>None</dev:defaultValue>
+        </command:parameter>
+        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="input_audio">
+          <maml:name>InputAudio</maml:name>
+          <maml:description>
+            <maml:para>The path of the audio file to passing the model. Supported formats are `wav` and `mp3`.</maml:para>
+          </maml:description>
+          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+          <dev:type>
+            <maml:name>String</maml:name>
+            <maml:uri />
+          </dev:type>
+          <dev:defaultValue>None</dev:defaultValue>
+        </command:parameter>
+        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
+          <maml:name>InputAudioFormat</maml:name>
+          <maml:description>
+            <maml:para>Specifies the format of the input audio file. If not specified, the format is automatically determined from the file extension.</maml:para>
+          </maml:description>
+          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+          <dev:type>
+            <maml:name>String</maml:name>
+            <maml:uri />
+          </dev:type>
+          <dev:defaultValue>None</dev:defaultValue>
+        </command:parameter>
+        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
+          <maml:name>AudioOutFile</maml:name>
+          <maml:description>
+            <maml:para>Specifies where audio response from the model will be saved. If the model does not return a audio response, nothing is saved.</maml:para>
+          </maml:description>
+          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+          <dev:type>
+            <maml:name>String</maml:name>
+            <maml:uri />
+          </dev:type>
+          <dev:defaultValue>None</dev:defaultValue>
+        </command:parameter>
+        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
+          <maml:name>OutputAudioFormat</maml:name>
+          <maml:description>
+            <maml:para>Specifies the format of the output audio file. The default value is `mp3`.</maml:para>
+          </maml:description>
+          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+          <dev:type>
+            <maml:name>String</maml:name>
+            <maml:uri />
+          </dev:type>
+          <dev:defaultValue>None</dev:defaultValue>
+        </command:parameter>
         <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
           <maml:name>Images</maml:name>
           <maml:description>
@@ -12660,6 +12733,79 @@ This is an optional field, and may contain a-z, A-Z, 0-9, hyphens, and underscor
         </dev:type>
         <dev:defaultValue>None</dev:defaultValue>
       </command:parameter>
+      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
+        <maml:name>Modalities</maml:name>
+        <maml:description>
+          <maml:para>Output types that you would like the model to generate for this request.
+Some models can generate both text and audio. To request that responses, you can specify: `("text", "audio")`</maml:para>
+        </maml:description>
+        <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
+        <dev:type>
+          <maml:name>String[]</maml:name>
+          <maml:uri />
+        </dev:type>
+        <dev:defaultValue>None</dev:defaultValue>
+      </command:parameter>
+      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
+        <maml:name>Voice</maml:name>
+        <maml:description>
+          <maml:para>The voice the model uses to respond.</maml:para>
+        </maml:description>
+        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+        <dev:type>
+          <maml:name>String</maml:name>
+          <maml:uri />
+        </dev:type>
+        <dev:defaultValue>None</dev:defaultValue>
+      </command:parameter>
+      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="input_audio">
+        <maml:name>InputAudio</maml:name>
+        <maml:description>
+          <maml:para>The path of the audio file to passing the model. Supported formats are `wav` and `mp3`.</maml:para>
+        </maml:description>
+        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+        <dev:type>
+          <maml:name>String</maml:name>
+          <maml:uri />
+        </dev:type>
+        <dev:defaultValue>None</dev:defaultValue>
+      </command:parameter>
+      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
+        <maml:name>InputAudioFormat</maml:name>
+        <maml:description>
+          <maml:para>Specifies the format of the input audio file. If not specified, the format is automatically determined from the file extension.</maml:para>
+        </maml:description>
+        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+        <dev:type>
+          <maml:name>String</maml:name>
+          <maml:uri />
+        </dev:type>
+        <dev:defaultValue>None</dev:defaultValue>
+      </command:parameter>
+      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
+        <maml:name>AudioOutFile</maml:name>
+        <maml:description>
+          <maml:para>Specifies where audio response from the model will be saved. If the model does not return a audio response, nothing is saved.</maml:para>
+        </maml:description>
+        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+        <dev:type>
+          <maml:name>String</maml:name>
+          <maml:uri />
+        </dev:type>
+        <dev:defaultValue>None</dev:defaultValue>
+      </command:parameter>
+      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
+        <maml:name>OutputAudioFormat</maml:name>
+        <maml:description>
+          <maml:para>Specifies the format of the output audio file. The default value is `mp3`.</maml:para>
+        </maml:description>
+        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+        <dev:type>
+          <maml:name>String</maml:name>
+          <maml:uri />
+        </dev:type>
+        <dev:defaultValue>None</dev:defaultValue>
+      </command:parameter>
       <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
         <maml:name>Images</maml:name>
         <maml:description>
@@ -13155,6 +13301,13 @@ PS C:\&gt; $GPTPingAnswer | select Answer</dev:code>
           <maml:para></maml:para>
         </dev:remarks>
       </command:example>
+      <command:example>
+        <maml:title>--------------- Example 6: Audio input / output ---------------</maml:title>
+        <dev:code>PS C:\&gt; Request-ChatCompletion -Modalities text, audio -InputAudio 'C:\hello.mp3' -AudioOutFile 'C:\response.mp3' -Model gpt-4o-audio-preview</dev:code>
+        <dev:remarks>
+          <maml:para></maml:para>
+        </dev:remarks>
+      </command:example>
     </command:examples>
     <command:relatedLinks>
       <maml:navigationLink>

diff --git a/PSOpenAI.psd1 b/PSOpenAI.psd1
@@ -1,6 +1,6 @@
 @{
     # Version number of this module.
-    ModuleVersion        = '4.8.0'
+    ModuleVersion        = '4.9.0'
 
     # Supported PSEditions
     CompatiblePSEditions = 'Core', 'Desktop'