Misc API updates.

Author: mkht

Docs/Request-RealtimeSessionResponse.md

@@ -16,7 +16,7 @@ Instruct the server to generate a response.
 Request-RealtimeSessionResponse
     [-EventId <String>]
     [-Instructions <String>]
-    [-Modalities <String[]>]
+    [-OutputModalities <String[]>]
     [-Voice <String>]
     [-OutputAudioFormat <String>]
     [-Temperature <Single>]
@@ -63,7 +63,7 @@ Position: Named
 Default value: -1
 ```
 
-### -Modalities
+### -OutputModalities
 The set of modalities the model can respond with.
 
 ```yaml

Docs/Request-Response.md

@@ -37,7 +37,9 @@ Request-Response
     [-FileSearchVectorStoreIds <String[]>]
     [-FileSearchMaxNumberOfResults <Int32>]
     [-FileSearchRanker <String>]
-    [-FileSearchScoreThreshold <Double>]
+    [-FileSearchScoreThreshold <Float>]
+    [-FileSearchHybridSearchEmbeddingWeight <Float>]
+    [-FileSearchHybridSearchTextWeight <Float>]
     [-UseWebSearch]
     [-WebSearchType <String>]
     [-WebSearchContextSize <String>]
@@ -64,6 +66,7 @@ Request-Response
     [-ConnectorRequireApproval <String>]
     [-ConnectorAuthorization <String>]
     [-UseCodeInterpreter]
+    [-CodeInterpreterMemoryLimit <String>]
     [-ContainerId <String>]
     [-ContainerFileIds <String[]>]
     [-UseImageGeneration]
@@ -79,9 +82,9 @@ Request-Response
     [-UseLocalShell]
     [-Include <String[]>]
     [-Truncation <String>]
-    [-Temperature <Double>] 
+    [-Temperature <Float>] 
     [-TopLogprobs <Int32>]
-    [-TopP <Double>] 
+    [-TopP <Float>] 
     [-Store <Boolean>]
     [-Background]
     [-Stream]
@@ -373,7 +376,25 @@ Position: Named
 The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.
 
 ```yaml
-Type: Double
+Type: Float
+Required: False
+Position: Named
+```
+
+### -FileSearchHybridSearchEmbeddingWeight
+The weight of the embedding in the reciprocal ranking fusion.
+
+```yaml
+Type: Float
+Required: False
+Position: Named
+```
+
+### -FileSearchHybridSearchTextWeight
+The weight of the text in the reciprocal ranking fusion.
+
+```yaml
+Type: Float
 Required: False
 Position: Named
 ```
@@ -623,6 +644,15 @@ Required: False
 Position: Named
 ```
 
+### -CodeInterpreterMemoryLimit
+{{No description provided}}
+
+```yaml
+Type: String
+Required: False
+Position: Named
+```
+
 ### -ContainerId
 The code interpreter container. Can be a container ID or `auto` to use the default container.
 
@@ -769,7 +799,7 @@ Default value: disabled
 What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random.
 
 ```yaml
-Type: Double
+Type: Float
 Required: False
 Position: Named
 ```
@@ -788,7 +818,7 @@ Position: Named
 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.
 
 ```yaml
-Type: Double
+Type: Float
 Aliases: top_p
 Required: False
 Position: Named

Docs/Set-RealtimeSessionConfiguration.md

@@ -19,7 +19,7 @@ Set-RealtimeSessionConfiguration
     [-PromptId <String>]
     [-PromptVariables <IDictionary>]
     [-PromptVersion <String>]
-    [-Modalities <String[]>]
+    [-OutputModalities <String[]>]
     [-Voice <String>] 
     [-Speed <Double>] 
     [-InputAudioFormat <String>]
@@ -46,6 +46,9 @@ Set-RealtimeSessionConfiguration
     [-TracingGroupId <String>]
     [-TracingMetadata <IDictionary>]
     [-TracingWorkflowName <String>]
+    [-Truncation <String>]
+    [-TruncationRetentionRatio <Float>]
+    [-TruncationTokenLimitsPostInstructions <Int32>]
 ```
 
 ## DESCRIPTION
@@ -56,7 +59,7 @@ Set the realtime session's configuration.
 ### Example 1
 ```powershell
 PS C:\> Set-RealtimeSessionConfiguration `
-    -Modalities 'audio' `
+    -OutputModalities 'audio' `
     -Voice 'marin' `
     -EnableInputAudioTranscription $true `
     -EnableTurnDetection $true
@@ -183,7 +186,7 @@ Position: Named
 Default value: -1
 ```
 
-### -Modalities
+### -OutputModalities
 The set of modalities the model can respond with.
 
 ```yaml
@@ -350,6 +353,33 @@ Required: False
 Position: Named
 ```
 
+### -Truncation
+The truncation strategy to use for the session. `auto` is the default truncation strategy. `disabled` will disable truncation and emit errors when the conversation exceeds the input token limit.
+
+```yaml
+Type: String
+Required: False
+Position: Named
+```
+
+### -TruncationRetentionRatio
+Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit.
+
+```yaml
+Type: Float
+Required: False
+Position: Named
+```
+
+### -TruncationTokenLimitsPostInstructions
+Maximum tokens allowed in the conversation after instructions (which including tool definitions).
+
+```yaml
+Type: Int32
+Required: False
+Position: Named
+```
+
 ## INPUTS
 
 ## OUTPUTS

Docs/Set-RealtimeTranscriptionSessionConfiguration.md

@@ -15,7 +15,6 @@ Set the realtime transcription session's configuration.
 ```
 Set-RealtimeTranscriptionSessionConfiguration
     [-EventId <String>]
-    [-Modalities <String[]>]
     [-InputAudioFormat <String>]
     [-InputAudioNoiseReductionType <String>]
     [-InputAudioTranscriptionModel <String>]
@@ -113,16 +112,6 @@ Required: False
 Position: Named
 ```
 
-### -Modalities
-The set of modalities the model can respond with.
-
-```yaml
-Type: String[]
-Accepted values: text, audio
-Required: False
-Position: Named
-```
-
 ### -TurnDetectionPrefixPadding
 Amount of audio to include before the VAD detected speech (in milliseconds).
 

Docs/Start-VectorStoreFileBatch.md

@@ -15,7 +15,8 @@ Create and run vector store file batch.
 ```
 Start-VectorStoreFileBatch
     [-VectorStoreId] <String>
-    [-FileId] <Object[]>
+    [-Attributes <Hashtable>]
+    [-Files] <Object[]>
     [-ChunkingStrategy <String>]
     [-MaxChunkSizeTokens <Int32>]
     [-ChunkOverlapTokens <Int32>]
@@ -34,7 +35,7 @@ Create and run vector store file batch.
 
 ### Example 1
 ```powershell
-PS C:\> Start-VectorStoreFileBatch -VectorStoreId 'vs_abc123' -FileId ('file-abc123', 'file-def456', 'file-ghi789')
+PS C:\> Start-VectorStoreFileBatch -VectorStoreId 'vs_abc123' -Files ('file-abc123', 'file-def456', 'file-ghi789')
 ```
 
 Start a batch for adding 3 files to the vector store with ID `vs_abc123`
@@ -52,12 +53,21 @@ Position: 0
 Accept pipeline input: True (ByValue, ByPropertyName)
 ```
 
-### -FileId
+### -Attributes
+Set of 16 key-value pairs that can be attached to an object. 
+
+```yaml
+Type: Hashtable
+Required: False
+Position: Named
+```
+
+### -Files
 A list of File IDs that the vector store should use.
 
 ```yaml
 Type: object[]
-Aliases: file_ids
+Aliases: file_ids, FileId
 Required: True
 Position: 1
 ```

Docs/Wait-VectorStoreFileBatch.md

@@ -34,7 +34,7 @@ Waits until the vector store file batch is completed.
 
 ### Example 1
 ```powershell
-PS C:\> Start-VectorStoreFileBatch -VectorStoreId 'vs_abc123' -FileId ('file-abc123', 'file-def456', 'file-ghi789') | Wait-VectorStoreFileBatch
+PS C:\> Start-VectorStoreFileBatch -VectorStoreId 'vs_abc123' -Files ('file-abc123', 'file-def456', 'file-ghi789') | Wait-VectorStoreFileBatch
 ```
 
 Start a batch and wait for completes.

Guides/How_to_use_Realtime_API.md

@@ -68,7 +68,7 @@ Then, configure session settings as needed.
 ```powershell
 # Configure system message, output type, etc.
 Set-RealtimeSessionConfiguration `
-    -Modalities 'text' `
+    -OutputModalities 'text' `
     -Instructions 'You are a assistant for children. Always choose words that are easy for the child to understand.' `
     -Temperature 0.6
 ```
@@ -150,7 +150,7 @@ $env:OPENAI_API_KEY = '<Put your API key here>'
 Connect-RealtimeSession
 
 # Enables audio response with automatic turn detection.
-Set-RealtimeSessionConfiguration -Modalities audio -EnableTurnDetection $true
+Set-RealtimeSessionConfiguration -OutputModalities audio -EnableTurnDetection $true
 
 # Activates speaker output.
 Start-RealtimeSessionAudioOutput

Public/Realtime/Request-RealtimeSessionResponse.ps1

@@ -9,8 +9,9 @@ function Request-RealtimeSessionResponse {
         [string]$Instructions,
 
         [Parameter()]
+        [Alias('Modalities')] # for backward compatibility
         [ValidateSet('text', 'audio')]
-        [string[]]$Modalities = @('text'),
+        [string[]]$OutputModalities = @('text'),
 
         [Parameter()]
         [Completions('alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse', 'marin', 'cedar')]
@@ -69,8 +70,8 @@ function Request-RealtimeSessionResponse {
         if ($PSBoundParameters.ContainsKey('Instructions')) {
             $MessageObject.response.instructions = $Instructions
         }
-        if ($PSBoundParameters.ContainsKey('Modalities')) {
-            $MessageObject.response.output_modalities = $Modalities
+        if ($PSBoundParameters.ContainsKey('OutputModalities')) {
+            $MessageObject.response.output_modalities = $OutputModalities
         }
         if ($PSBoundParameters.ContainsKey('Tools')) {
             $MessageObject.response.tools = $Tools

Public/Realtime/Set-RealtimeSessionConfiguration.ps1

@@ -18,8 +18,9 @@ function Set-RealtimeSessionConfiguration {
         [string]$PromptVersion,
 
         [Parameter()]
+        [Alias('Modalities')] # for backward compatibility
         [ValidateSet('text', 'audio')]
-        [string[]]$Modalities = @('text'),
+        [string[]]$OutputModalities = @('text'),
 
         [Parameter()]
         [Completions('alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse', 'marin', 'cedar')]
@@ -121,7 +122,22 @@ function Set-RealtimeSessionConfiguration {
         [System.Collections.IDictionary]$TracingMetadata,
 
         [Parameter()]
-        [string]$TracingWorkflowName
+        [string]$TracingWorkflowName,
+
+        [Parameter()]
+        [Completions('auto', 'disabled')]
+        [string]$Truncation = 'auto',
+
+        [Parameter()]
+        [ValidateRange(0.0, 1.0)]
+        [float]$TruncationRetentionRatio,
+
+        [Parameter(DontShow)]
+        [string]$TruncationRetentionRatioType = 'retention_ratio',
+
+        [Parameter()]
+        [int]$TruncationTokenLimitsPostInstructions
+
     )
 
     begin {
@@ -135,8 +151,8 @@ function Set-RealtimeSessionConfiguration {
         if ($PSBoundParameters.ContainsKey('Instructions')) {
             $MessageObject.session.instructions = $Instructions
         }
-        if ($PSBoundParameters.ContainsKey('Modalities')) {
-            $MessageObject.session.output_modalities = $Modalities
+        if ($PSBoundParameters.ContainsKey('OutputModalities')) {
+            $MessageObject.session.output_modalities = $OutputModalities
         }
         if ($PSBoundParameters.ContainsKey('Temperature')) {
             $MessageObject.session.temperature = $Temperature
@@ -187,6 +203,25 @@ function Set-RealtimeSessionConfiguration {
             }
         }
 
+        $TruncationObject = @{'type' = $TruncationRetentionRatioType }
+        if ($PSBoundParameters.ContainsKey('TruncationRetentionRatio')) {
+            $TruncationObject.TruncationRetentionRatio = $TruncationRetentionRatio
+        }
+        if ($PSBoundParameters.ContainsKey('TruncationTokenLimitsPostInstructions')) {
+            $TruncationObject.token_limits = @{
+                'post_instructions' = $TruncationTokenLimitsPostInstructions
+            }
+        }
+
+        if ($TruncationObject.Keys.Count -gt 1) {
+            $MessageObject.session.truncation = $TruncationObject
+        }
+        else {
+            if ($Truncation) {
+                $MessageObject.session.truncation = $Truncation
+            }
+        }
+
         # Input audio settings
         $InputAudioSettings = @{}
         if ($PSBoundParameters.ContainsKey('InputAudioFormat')) {