Request-AudioTranscription.md

external help file	Module Name	online version	schema
PSOpenAI-help.xml	PSOpenAI	https://github.com/mkht/PSOpenAI/blob/main/Docs/Request-AudioTranscription.md	2.0.0

Request-AudioTranscription

SYNOPSIS

Transcribes audio into the input language.

SYNTAX

Language (Default)

Request-AudioTranscription
    [[-File] <String>]
    [-Model <String>]
    [-Prompt <String>]
    [-Format <String>]
    [-Temperature <Double>]
    [-TimestampGranularities <String[]>]
    [-Language <String>]
    [-TimeoutSec <Int32>]
    [-MaxRetryCount <Int32>]
    [-ApiBase <Uri>]
    [-ApiKey <Object>]
    [-Organization <String>]
    [<CommonParameters>]

DESCRIPTION

Transcribes audio into the input language.
https://platform.openai.com/docs/guides/speech-to-text/speech-to-text

EXAMPLES

Example 1: Audio-to-Text

PS C:\> Request-AudioTranscription -File C:\sample\audio.mp3 -Format text

Hello, I am david.

PARAMETERS

-File

(Required) The audio file to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

Type: String
Required: True
Position: 1
Accept pipeline input: True (ByValue)

-Model

The name of model to use. The default value is whisper-1.

Type: String
Required: False
Position: Named
Default value: whisper-1

-Prompt

An optional text to guide the model's style or continue a previous audio segment.
The prompt should match the audio language.

Type: String
Required: False
Position: Named

-Format

The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.
The default value is text.

Type: String
Aliases: response_format
Required: False
Position: Named
Default value: text

-Temperature

The sampling temperature, between 0 and 1.
Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

Type: Double
Required: False
Position: Named

-TimestampGranularities

The timestamp granularities to populate for this transcription. Any of these options: word, or segment. The default is segment.

Type: String[]
Aliases: timestamp_granularities
Required: False
Position: Named

-Language

The language of the input audio.
Supplying the input language in ISO-639-1 format will improve accuracy and latency.

Type: String
Required: False
Position: Named

-TimeoutSec

Specifies how long the request can be pending before it times out.
The default value is 0 (infinite).

Type: Int32
Required: False
Position: Named
Default value: 0

-MaxRetryCount

Number between 0 and 100.
Specifies the maximum number of retries if the request fails.
The default value is 0 (No retry).
Note : Retries will only be performed if the request fails with a 429 (Rate limit reached) or 5xx (Server side errors) error. Other errors (e.g., authentication failure) will not be performed.

Type: Int32
Required: False
Position: Named
Default value: 0

-ApiBase

Specifies 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/v1

-ApiKey

Specifies 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: Named

-Organization

Specifies Organization ID which used for an API request.
If not specified, it will try to use $global:OPENAI_ORGANIZATION or $env:OPENAI_ORGANIZATION

Type: string
Aliases: OrgId
Required: False
Position: Named

INPUTS

OUTPUTS

[string]

NOTES

RELATED LINKS

https://platform.openai.com/docs/guides/speech-to-text/speech-to-text

https://platform.openai.com/docs/api-reference/audio/create