| external help file | PSOpenAI-help.xml |
|---|---|
| Module Name | PSOpenAI |
| online version | https://github.com/mkht/PSOpenAI/blob/main/Docs/Connect-RealtimeTranscriptionSession.md |
| schema | 2.0.0 |
Create a new OpenAI realtime transcription session.
Connect-RealtimeTranscriptionSession
[-ApiType <OpenAIApiType>]
[-ApiBase <Uri>]
[-AuthType <String>]
[-ApiKey <SecureString>]
Create a new realtime transcription session. This technically means connecting to the WebSocket endpoint provided by the OpenAI Realtime API.
Once the session is opened, the connection will continue until it is disconnected from the server side or a DisConnect-RealtimeSession is executed. You always need run DisConnect-RealtimeSession when you are finished conversation.
PS C:\> Connect-RealtimeTranscriptionSessionSpecifies an API endpoint URL such like: https://your-api-endpoint.test/v1
If not specified, it will use https://api.openai.com/v1
Type: System.Uri
Required: False
Position: Named
Default value: https://api.openai.com/v1Specifies API key for authentication.
The type of data should [string] or [securestring].
If not specified, it will try to use $global:OPENAI_API_KEY or $env:OPENAI_API_KEY
Type: Object
Required: False
Position: NamedSpecifies API type of use. OpenAI(default) or Azure
Type: OpenAIApiType
Accepted values: OpenAI, Azure
Required: False
Position: Named
Default value: OpenAIIf you wish to use Entra-ID based authentication, specifies as azure_ad.
Type: String
Accepted values: openai, azure, azure_ad
Required: False
Position: Namedhttps://developers.openai.com/api/docs/guides/realtime-transcription