ISpeechToTextClient Interface

Definition

public interface class ISpeechToTextClient : IDisposable

[System.Diagnostics.CodeAnalysis.Experimental("MEAI001")]
public interface ISpeechToTextClient : IDisposable

public interface ISpeechToTextClient : IDisposable

[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001")>]
type ISpeechToTextClient = interface
    interface IDisposable

type ISpeechToTextClient = interface
    interface IDisposable

Public Interface ISpeechToTextClient
Implements IDisposable

Derived

Microsoft.Extensions.AI.DelegatingSpeechToTextClient

Attributes

ExperimentalAttribute

Implements

IDisposable

Remarks

Unless otherwise specified, all members of ISpeechToTextClient are thread-safe for concurrent use. It is expected that all implementations of ISpeechToTextClient support being used by multiple requests concurrently.

However, implementations of ISpeechToTextClient might mutate the arguments supplied to GetTextAsync(Stream, SpeechToTextOptions, CancellationToken) and GetStreamingTextAsync(Stream, SpeechToTextOptions, CancellationToken), such as by configuring the options instance. Thus, consumers of the interface either should avoid using shared instances of these arguments for concurrent invocations or should otherwise ensure by construction that no ISpeechToTextClient instances are used which might employ such mutation. For example, the ConfigureOptions method be provided with a callback that could mutate the supplied options argument, and that should be avoided if using a singleton options instance. The audio speech stream passed to these methods will not be closed or disposed by the implementation.