5 implementations of ISpeechToTextClient
Microsoft.Extensions.AI.Abstractions (1)
SpeechToText\DelegatingSpeechToTextClient.cs (1)
23public class DelegatingSpeechToTextClient : ISpeechToTextClient
Microsoft.Extensions.AI.Abstractions.Tests (1)
TestSpeechToTextClient.cs (1)
12public sealed class TestSpeechToTextClient : ISpeechToTextClient
Microsoft.Extensions.AI.Integration.Tests (1)
parent\Microsoft.Extensions.AI.Abstractions.Tests\TestSpeechToTextClient.cs (1)
12public sealed class TestSpeechToTextClient : ISpeechToTextClient
Microsoft.Extensions.AI.OpenAI (1)
OpenAISpeechToTextClient.cs (1)
25internal sealed class OpenAISpeechToTextClient : ISpeechToTextClient
Microsoft.Extensions.AI.Tests (1)
parent\Microsoft.Extensions.AI.Abstractions.Tests\TestSpeechToTextClient.cs (1)
12public sealed class TestSpeechToTextClient : ISpeechToTextClient
149 references to ISpeechToTextClient
Microsoft.Extensions.AI (41)
SpeechToText\ConfigureOptionsSpeechToTextClient.cs (1)
34public ConfigureOptionsSpeechToTextClient(ISpeechToTextClient innerClient, Action<SpeechToTextOptions> configure)
SpeechToText\LoggingSpeechToTextClient.cs (3)
21/// The provided implementation of <see cref="ISpeechToTextClient"/> is thread-safe for concurrent use so long as the 41/// <param name="innerClient">The underlying <see cref="ISpeechToTextClient"/>.</param> 43public LoggingSpeechToTextClient(ISpeechToTextClient innerClient, ILogger logger)
SpeechToText\OpenTelemetrySpeechToTextClient.cs (2)
45/// <param name="innerClient">The underlying <see cref="ISpeechToTextClient"/>.</param> 48public OpenTelemetrySpeechToTextClient(ISpeechToTextClient innerClient, ILogger? logger = null, string? sourceName = null)
SpeechToText\SpeechToTextClientBuilder.cs (18)
12/// <summary>A builder for creating pipelines of <see cref="ISpeechToTextClient"/>.</summary> 16private readonly Func<IServiceProvider, ISpeechToTextClient> _innerClientFactory; 19private List<Func<ISpeechToTextClient, IServiceProvider, ISpeechToTextClient>>? _clientFactories; 22/// <param name="innerClient">The inner <see cref="ISpeechToTextClient"/> that represents the underlying backend.</param> 23public SpeechToTextClientBuilder(ISpeechToTextClient innerClient) 30/// <param name="innerClientFactory">A callback that produces the inner <see cref="ISpeechToTextClient"/> that represents the underlying backend.</param> 31public SpeechToTextClientBuilder(Func<IServiceProvider, ISpeechToTextClient> innerClientFactory) 36/// <summary>Builds an <see cref="ISpeechToTextClient"/> that represents the entire pipeline. Calls to this instance will pass through each of the pipeline stages in turn.</summary> 38/// The <see cref="IServiceProvider"/> that should provide services to the <see cref="ISpeechToTextClient"/> instances. 41/// <returns>An instance of <see cref="ISpeechToTextClient"/> that represents the entire pipeline.</returns> 42public ISpeechToTextClient Build(IServiceProvider? services = null) 45var audioClient = _innerClientFactory(services); 55$"Ensure that the callbacks passed to {nameof(Use)} return non-null {nameof(ISpeechToTextClient)} instances."); 65public SpeechToTextClientBuilder Use(Func<ISpeechToTextClient, ISpeechToTextClient> clientFactory) 75public SpeechToTextClientBuilder Use(Func<ISpeechToTextClient, IServiceProvider, ISpeechToTextClient> clientFactory)
SpeechToText\SpeechToTextClientBuilderServiceCollectionExtensions.cs (15)
12/// <summary>Provides extension methods for registering <see cref="ISpeechToTextClient"/> with a <see cref="IServiceCollection"/>.</summary> 16/// <summary>Registers a singleton <see cref="ISpeechToTextClient"/> in the <see cref="IServiceCollection"/>.</summary> 18/// <param name="innerClient">The inner <see cref="ISpeechToTextClient"/> that represents the underlying backend.</param> 24ISpeechToTextClient innerClient, 28/// <summary>Registers a singleton <see cref="ISpeechToTextClient"/> in the <see cref="IServiceCollection"/>.</summary> 30/// <param name="innerClientFactory">A callback that produces the inner <see cref="ISpeechToTextClient"/> that represents the underlying backend.</param> 36Func<IServiceProvider, ISpeechToTextClient> innerClientFactory, 43serviceCollection.Add(new ServiceDescriptor(typeof(ISpeechToTextClient), builder.Build, lifetime)); 47/// <summary>Registers a keyed singleton <see cref="ISpeechToTextClient"/> in the <see cref="IServiceCollection"/>.</summary> 50/// <param name="innerClient">The inner <see cref="ISpeechToTextClient"/> that represents the underlying backend.</param> 57ISpeechToTextClient innerClient, 61/// <summary>Registers a keyed singleton <see cref="ISpeechToTextClient"/> in the <see cref="IServiceCollection"/>.</summary> 64/// <param name="innerClientFactory">A callback that produces the inner <see cref="ISpeechToTextClient"/> that represents the underlying backend.</param> 71Func<IServiceProvider, ISpeechToTextClient> innerClientFactory, 78serviceCollection.Add(new ServiceDescriptor(typeof(ISpeechToTextClient), serviceKey, factory: (services, serviceKey) => builder.Build(services), lifetime));
SpeechToText\SpeechToTextClientBuilderSpeechToTextClientExtensions.cs (2)
10/// <summary>Provides extension methods for working with <see cref="ISpeechToTextClient"/> in the context of <see cref="SpeechToTextClientBuilder"/>.</summary> 21public static SpeechToTextClientBuilder AsBuilder(this ISpeechToTextClient innerClient)
Microsoft.Extensions.AI.Abstractions (25)
SpeechToText\DelegatingSpeechToTextClient.cs (5)
16/// Provides an optional base class for an <see cref="ISpeechToTextClient"/> that passes through calls to another instance. 19/// This is recommended as a base type when building clients that can be chained in any order around an underlying <see cref="ISpeechToTextClient"/>. 29protected DelegatingSpeechToTextClient(ISpeechToTextClient innerClient) 41/// <summary>Gets the inner <see cref="ISpeechToTextClient" />.</summary> 42protected ISpeechToTextClient InnerClient { get; }
SpeechToText\ISpeechToTextClient.cs (6)
17/// Unless otherwise specified, all members of <see cref="ISpeechToTextClient"/> are thread-safe for concurrent use. 18/// It is expected that all implementations of <see cref="ISpeechToTextClient"/> support being used by multiple requests concurrently. 21/// However, implementations of <see cref="ISpeechToTextClient"/> might mutate the arguments supplied to <see cref="GetTextAsync"/> and 24/// <see cref="ISpeechToTextClient"/> instances are used which might employ such mutation. For example, the ConfigureOptions method be 52/// <summary>Asks the <see cref="ISpeechToTextClient"/> for an object of the specified type <paramref name="serviceType"/>.</summary> 58/// The purpose of this method is to allow for the retrieval of strongly typed services that might be provided by the <see cref="ISpeechToTextClient"/>,
SpeechToText\SpeechToTextClientExtensions.cs (6)
15/// <summary>Extensions for <see cref="ISpeechToTextClient"/>.</summary> 19/// <summary>Asks the <see cref="ISpeechToTextClient"/> for an object of type <typeparamref name="TService"/>.</summary> 25/// The purpose of this method is to allow for the retrieval of strongly typed services that may be provided by the <see cref="ISpeechToTextClient"/>, 28public static TService? GetService<TService>(this ISpeechToTextClient client, object? serviceKey = null) 42this ISpeechToTextClient client, 64this ISpeechToTextClient client,
SpeechToText\SpeechToTextClientMetadata.cs (1)
10/// <summary>Provides metadata about an <see cref="ISpeechToTextClient"/>.</summary>
SpeechToText\SpeechToTextOptions.cs (6)
55/// The underlying <see cref="ISpeechToTextClient" /> implementation may have its own representation of options. 56/// When <see cref="ISpeechToTextClient.GetTextAsync" /> or <see cref="ISpeechToTextClient.GetStreamingTextAsync"/> 59/// which concrete <see cref="ISpeechToTextClient" /> is being used and how it represents options, a new instance of that 60/// implementation-specific options type may be returned by this callback, for the <see cref="ISpeechToTextClient" /> 68public Func<ISpeechToTextClient, object?>? RawRepresentationFactory { get; set; }
SpeechToText\SpeechToTextResponseUpdate.cs (1)
14/// Represents a single streaming response chunk from an <see cref="ISpeechToTextClient"/>.
Microsoft.Extensions.AI.Abstractions.Tests (6)
SpeechToText\DelegatingSpeechToTextClientTests.cs (3)
127var client = delegating.GetService<ISpeechToTextClient>(expectedKey); 164private sealed class NoOpDelegatingSpeechToTextClient(ISpeechToTextClient innerClient)
SpeechToText\SpeechToTextClientExtensionsTests.cs (2)
27ISpeechToTextClient? client = null; 41ISpeechToTextClient? client = null;
SpeechToText\SpeechToTextOptionsTests.cs (1)
38Func<ISpeechToTextClient?, object?> rawRepresentationFactory = (c) => null;
Microsoft.Extensions.AI.Integration.Tests (2)
SpeechToTextClientIntegrationTests.cs (2)
17private readonly ISpeechToTextClient? _client; 30protected abstract ISpeechToTextClient? CreateClient();
Microsoft.Extensions.AI.OpenAI (4)
OpenAIClientExtensions.cs (3)
163/// <summary>Gets an <see cref="ISpeechToTextClient"/> for use with this <see cref="AudioClient"/>.</summary> 165/// <returns>An <see cref="ISpeechToTextClient"/> that can be used to transcribe audio via the <see cref="AudioClient"/>.</returns> 168public static ISpeechToTextClient AsISpeechToTextClient(this AudioClient audioClient) =>
OpenAISpeechToTextClient.cs (1)
23/// <summary>Represents an <see cref="ISpeechToTextClient"/> for an OpenAI <see cref="OpenAIClient"/> or <see cref="OpenAI.Audio.AudioClient"/>.</summary>
Microsoft.Extensions.AI.OpenAI.Tests (19)
OpenAISpeechToTextClientIntegrationTests.cs (1)
8protected override ISpeechToTextClient? CreateClient()
OpenAISpeechToTextClientTests.cs (18)
39ISpeechToTextClient speechToTextClient = client.GetAudioClient(model).AsISpeechToTextClient(); 50ISpeechToTextClient speechToTextClient = audioClient.AsISpeechToTextClient(); 51Assert.Same(speechToTextClient, speechToTextClient.GetService<ISpeechToTextClient>()); 54using ISpeechToTextClient pipeline = speechToTextClient 62Assert.IsType<LoggingSpeechToTextClient>(pipeline.GetService<ISpeechToTextClient>()); 87using ISpeechToTextClient client = CreateSpeechToTextClient(httpClient, "gpt-4o-transcribe"); 108using ISpeechToTextClient client = CreateSpeechToTextClient(httpClient, "gpt-4o-transcribe"); 122using ISpeechToTextClient client = CreateSpeechToTextClient(httpClient, "gpt-4o-transcribe"); 162using ISpeechToTextClient client = CreateSpeechToTextClient(httpClient, "gpt-4o-transcribe"); 197using ISpeechToTextClient client = CreateSpeechToTextClient(httpClient, "gpt-4o-transcribe"); 234using ISpeechToTextClient client = CreateSpeechToTextClient(httpClient, "gpt-4o-transcribe"); 271using ISpeechToTextClient client = CreateSpeechToTextClient(httpClient, "gpt-4o-transcribe"); 313using ISpeechToTextClient client = CreateSpeechToTextClient(httpClient, "gpt-4o-mini-transcribe"); 351private static ISpeechToTextClient CreateSpeechToTextClient(HttpClient httpClient, string modelId) => 400using ISpeechToTextClient client = CreateSpeechToTextClient(httpClient, "gpt-4o-transcribe"); 431using ISpeechToTextClient client = CreateSpeechToTextClient(httpClient, "gpt-4o-transcribe"); 464using ISpeechToTextClient client = CreateSpeechToTextClient(httpClient, "gpt-4o-transcribe"); 497using ISpeechToTextClient client = CreateSpeechToTextClient(httpClient, "gpt-4o-transcribe");
Microsoft.Extensions.AI.Tests (52)
SpeechToText\ConfigureOptionsSpeechToTextClientTests.cs (2)
42using ISpeechToTextClient innerClient = new TestSpeechToTextClient 59using var client = innerClient
SpeechToText\LoggingSpeechToTextClientTests.cs (17)
32Assert.Same(innerClient, innerClient.AsBuilder().UseLogging(NullLoggerFactory.Instance).Build().GetService(typeof(ISpeechToTextClient))); 57using ISpeechToTextClient innerClient = new TestSpeechToTextClient 65using ISpeechToTextClient client = innerClient 79entry => Assert.True(entry.Message.Contains($"{nameof(ISpeechToTextClient.GetTextAsync)} invoked:") && entry.Message.Contains("\"speechLanguage\": \"pt\"")), 80entry => Assert.True(entry.Message.Contains($"{nameof(ISpeechToTextClient.GetTextAsync)} completed:") && entry.Message.Contains("blue whale"))); 85entry => Assert.True(entry.Message.Contains($"{nameof(ISpeechToTextClient.GetTextAsync)} invoked.") && !entry.Message.Contains("\"speechLanguage\": \"pt\"")), 86entry => Assert.True(entry.Message.Contains($"{nameof(ISpeechToTextClient.GetTextAsync)} completed.") && !entry.Message.Contains("blue whale"))); 103using ISpeechToTextClient innerClient = new TestSpeechToTextClient 115using ISpeechToTextClient client = innerClient 132entry => Assert.True(entry.Message.Contains($"{nameof(ISpeechToTextClient.GetStreamingTextAsync)} invoked:") && entry.Message.Contains("\"speechLanguage\": \"pt\"")), 133entry => Assert.True(entry.Message.Contains($"{nameof(ISpeechToTextClient.GetStreamingTextAsync)} received update:") && entry.Message.Contains("blue")), 134entry => Assert.True(entry.Message.Contains($"{nameof(ISpeechToTextClient.GetStreamingTextAsync)} received update:") && entry.Message.Contains("whale")), 135entry => Assert.Contains($"{nameof(ISpeechToTextClient.GetStreamingTextAsync)} completed.", entry.Message)); 140entry => Assert.True(entry.Message.Contains($"{nameof(ISpeechToTextClient.GetStreamingTextAsync)} invoked.") && !entry.Message.Contains("speechLanguage")), 141entry => Assert.True(entry.Message.Contains($"{nameof(ISpeechToTextClient.GetStreamingTextAsync)} received update.") && !entry.Message.Contains("blue")), 142entry => Assert.True(entry.Message.Contains($"{nameof(ISpeechToTextClient.GetStreamingTextAsync)} received update.") && !entry.Message.Contains("whale")), 143entry => Assert.Contains($"{nameof(ISpeechToTextClient.GetStreamingTextAsync)} completed.", entry.Message));
SpeechToText\OpenTelemetrySpeechToTextClientTests.cs (2)
86using var client = innerClient 179using var client = innerClient
SpeechToText\SpeechToTextClientDependencyInjectionPatterns.cs (31)
26var instance1 = scope1.ServiceProvider.GetRequiredService<ISpeechToTextClient>(); 27var instance1Copy = scope1.ServiceProvider.GetRequiredService<ISpeechToTextClient>(); 28var instance2 = scope2.ServiceProvider.GetRequiredService<ISpeechToTextClient>(); 50var instance1 = scope1.ServiceProvider.GetRequiredService<ISpeechToTextClient>(); 51var instance1Copy = scope1.ServiceProvider.GetRequiredService<ISpeechToTextClient>(); 52var instance2 = scope2.ServiceProvider.GetRequiredService<ISpeechToTextClient>(); 73Assert.Null(services.GetService<ISpeechToTextClient>()); 75var instance1 = scope1.ServiceProvider.GetRequiredKeyedService<ISpeechToTextClient>("mykey"); 76var instance1Copy = scope1.ServiceProvider.GetRequiredKeyedService<ISpeechToTextClient>("mykey"); 77var instance2 = scope2.ServiceProvider.GetRequiredKeyedService<ISpeechToTextClient>("mykey"); 99Assert.Null(services.GetService<ISpeechToTextClient>()); 101var instance1 = scope1.ServiceProvider.GetRequiredKeyedService<ISpeechToTextClient>("mykey"); 102var instance1Copy = scope1.ServiceProvider.GetRequiredKeyedService<ISpeechToTextClient>("mykey"); 103var instance2 = scope2.ServiceProvider.GetRequiredKeyedService<ISpeechToTextClient>("mykey"); 126Assert.Equal(typeof(ISpeechToTextClient), sd.ServiceType); 148Assert.Equal(typeof(ISpeechToTextClient), sd.ServiceType); 164Assert.Equal(typeof(ISpeechToTextClient), sd.ServiceType); 173public class SingletonMiddleware(ISpeechToTextClient inner, IServiceProvider services) : DelegatingSpeechToTextClient(inner) 175public new ISpeechToTextClient InnerClient => base.InnerClient;