class PendingTranscriptionGeneration

Traits

Properties

protected array<string, string>|SerializableClosure $headers from  ResolvesProviderOptions
protected array<string, mixed>|SerializableClosure $providerOptions from  ResolvesProviderOptions
protected string|null $language
protected bool $diarize
protected int $timeout

Methods

mixed
when(mixed $value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

mixed
unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

withHeaders(array|Closure $headers)

Specify HTTP headers for the request. Closures may only capture serializable values.

withProviderOptions(array|Closure $options)

Specify provider-specific options for the request.

array
resolveProviderOptionsAndHeaders(Provider $provider)

Resolve the request body options and HTTP headers for the given provider.

array
queuedProviderOptions()

Get the serializable provider options recorded by queued fakes.

__construct(TranscribableAudio $audio)

Create a pending transcription generation.

language(string $language)

Specify the language (ISO-639-1) of the audio being transcribed.

diarize(bool $diarize = true)

Indicate that the transcript should be diarized.

timeout(int $seconds = 30)

Specify the timeout (in seconds) for the transcription generation.

generate(Provider|Lab|array|string|null $provider = null, string|null $model = null)

Generate the transcription.

queue(Provider|Lab|array|string|null $provider = null, string|null $model = null)

Queue the generation of the transcription.

Details

in Conditionable at line 23
mixed when(mixed $value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

mixed $value
callable|null $callback
callable|null $default

Return Value

mixed

in Conditionable at line 56
mixed unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

mixed $value
callable|null $callback
callable|null $default

Return Value

mixed

ResolvesProviderOptions withHeaders(array|Closure $headers)

Specify HTTP headers for the request. Closures may only capture serializable values.

Parameters

array|Closure $headers

Return Value

ResolvesProviderOptions

ResolvesProviderOptions withProviderOptions(array|Closure $options)

Specify provider-specific options for the request.

Parameters

array|Closure $options

Return Value

ResolvesProviderOptions

protected array resolveProviderOptionsAndHeaders(Provider $provider)

Resolve the request body options and HTTP headers for the given provider.

Unlike upstream, accept the contract so custom provider implementations need not extend the base class.

Parameters

Provider $provider

Return Value

array

protected array queuedProviderOptions()

Get the serializable provider options recorded by queued fakes.

Return Value

array

at line 39
__construct(TranscribableAudio $audio)

Create a pending transcription generation.

Parameters

TranscribableAudio $audio

at line 47
PendingTranscriptionGeneration language(string $language)

Specify the language (ISO-639-1) of the audio being transcribed.

Parameters

string $language

Return Value

PendingTranscriptionGeneration

at line 57
PendingTranscriptionGeneration diarize(bool $diarize = true)

Indicate that the transcript should be diarized.

Parameters

bool $diarize

Return Value

PendingTranscriptionGeneration

at line 67
PendingTranscriptionGeneration timeout(int $seconds = 30)

Specify the timeout (in seconds) for the transcription generation.

Parameters

int $seconds

Return Value

PendingTranscriptionGeneration

at line 79
TranscriptionResponse generate(Provider|Lab|array|string|null $provider = null, string|null $model = null)

Generate the transcription.

Parameters

Provider|Lab|array|string|null $provider
string|null $model

Return Value

TranscriptionResponse

Exceptions

FailoverableException

at line 118
QueuedTranscriptionResponse queue(Provider|Lab|array|string|null $provider = null, string|null $model = null)

Queue the generation of the transcription.

Parameters

Provider|Lab|array|string|null $provider
string|null $model

Return Value

QueuedTranscriptionResponse

Exceptions

LogicException