6 implementations of IImageGenerator
Microsoft.Extensions.AI.Abstractions (1)
Image\DelegatingImageGenerator.cs (1)
21public class DelegatingImageGenerator : IImageGenerator
Microsoft.Extensions.AI.Abstractions.Tests (1)
TestImageGenerator.cs (1)
10public sealed class TestImageGenerator : IImageGenerator
Microsoft.Extensions.AI.Integration.Tests (2)
ImageGeneratingChatClientIntegrationTests.cs (1)
405protected sealed class CapturingImageGenerator : IImageGenerator
test\Libraries\Microsoft.Extensions.AI.Abstractions.Tests\TestImageGenerator.cs (1)
10public sealed class TestImageGenerator : IImageGenerator
Microsoft.Extensions.AI.OpenAI (1)
OpenAIImageGenerator.cs (1)
24internal sealed class OpenAIImageGenerator : IImageGenerator
Microsoft.Extensions.AI.Tests (1)
test\Libraries\Microsoft.Extensions.AI.Abstractions.Tests\TestImageGenerator.cs (1)
10public sealed class TestImageGenerator : IImageGenerator
145 references to IImageGenerator
Microsoft.Extensions.AI (50)
ChatCompletion\ImageGeneratingChatClient.cs (6)
21/// <see cref="IImageGenerator"/> employed is also thread-safe for concurrent use. 54private readonly IImageGenerator _imageGenerator; 59/// <param name="imageGenerator">An <see cref="IImageGenerator"/> instance that will be used for image generation operations.</param> 63public ImageGeneratingChatClient(IChatClient innerClient, IImageGenerator imageGenerator, DataContentHandling dataContentHandling = DataContentHandling.AllImages) 144private readonly IImageGenerator _imageGenerator; 151public RequestState(IImageGenerator imageGenerator, DataContentHandling dataContentHandling)
ChatCompletion\ImageGeneratingChatClientBuilderExtensions.cs (3)
19/// An optional <see cref="IImageGenerator"/> used for image generation operations. 33IImageGenerator? imageGenerator = null, 40imageGenerator ??= services.GetRequiredService<IImageGenerator>();
ChatCompletion\OpenTelemetryImageGenerator.cs (2)
41/// <param name="innerGenerator">The underlying <see cref="IImageGenerator"/>.</param> 45public OpenTelemetryImageGenerator(IImageGenerator innerGenerator, ILogger? logger = null, string? sourceName = null)
Image\ConfigureOptionsImageGenerator.cs (1)
32public ConfigureOptionsImageGenerator(IImageGenerator innerGenerator, Action<ImageGenerationOptions> configure)
Image\ImageGeneratorBuilder.cs (18)
12/// <summary>A builder for creating pipelines of <see cref="IImageGenerator"/>.</summary> 16private readonly Func<IServiceProvider, IImageGenerator> _innerGeneratorFactory; 19private List<Func<IImageGenerator, IServiceProvider, IImageGenerator>>? _generatorFactories; 22/// <param name="innerGenerator">The inner <see cref="IImageGenerator"/> that represents the underlying backend.</param> 24public ImageGeneratorBuilder(IImageGenerator innerGenerator) 31/// <param name="innerGeneratorFactory">A callback that produces the inner <see cref="IImageGenerator"/> that represents the underlying backend.</param> 33public ImageGeneratorBuilder(Func<IServiceProvider, IImageGenerator> innerGeneratorFactory) 38/// <summary>Builds an <see cref="IImageGenerator"/> that represents the entire pipeline. Calls to this instance will pass through each of the pipeline stages in turn.</summary> 40/// The <see cref="IServiceProvider"/> that should provide services to the <see cref="IImageGenerator"/> instances. 43/// <returns>An instance of <see cref="IImageGenerator"/> that represents the entire pipeline.</returns> 44public IImageGenerator Build(IServiceProvider? services = null) 47var imageGenerator = _innerGeneratorFactory(services); 57$"Ensure that the callbacks passed to {nameof(Use)} return non-null {nameof(IImageGenerator)} instances."); 68public ImageGeneratorBuilder Use(Func<IImageGenerator, IImageGenerator> generatorFactory) 79public ImageGeneratorBuilder Use(Func<IImageGenerator, IServiceProvider, IImageGenerator> generatorFactory)
Image\ImageGeneratorBuilderImageGeneratorExtensions.cs (2)
11/// <summary>Provides extension methods for working with <see cref="IImageGenerator"/> in the context of <see cref="ImageGeneratorBuilder"/>.</summary> 23public static ImageGeneratorBuilder AsBuilder(this IImageGenerator innerGenerator)
Image\ImageGeneratorBuilderServiceCollectionExtensions.cs (15)
12/// <summary>Provides extension methods for registering <see cref="IImageGenerator"/> with a <see cref="IServiceCollection"/>.</summary> 16/// <summary>Registers a singleton <see cref="IImageGenerator"/> in the <see cref="IServiceCollection"/>.</summary> 18/// <param name="innerGenerator">The inner <see cref="IImageGenerator"/> that represents the underlying backend.</param> 25IImageGenerator innerGenerator, 29/// <summary>Registers a singleton <see cref="IImageGenerator"/> in the <see cref="IServiceCollection"/>.</summary> 31/// <param name="innerGeneratorFactory">A callback that produces the inner <see cref="IImageGenerator"/> that represents the underlying backend.</param> 38Func<IServiceProvider, IImageGenerator> innerGeneratorFactory, 45serviceCollection.Add(new ServiceDescriptor(typeof(IImageGenerator), builder.Build, lifetime)); 49/// <summary>Registers a keyed singleton <see cref="IImageGenerator"/> in the <see cref="IServiceCollection"/>.</summary> 52/// <param name="innerGenerator">The inner <see cref="IImageGenerator"/> that represents the underlying backend.</param> 60IImageGenerator innerGenerator, 64/// <summary>Registers a keyed singleton <see cref="IImageGenerator"/> in the <see cref="IServiceCollection"/>.</summary> 67/// <param name="innerGeneratorFactory">A callback that produces the inner <see cref="IImageGenerator"/> that represents the underlying backend.</param> 75Func<IServiceProvider, IImageGenerator> innerGeneratorFactory, 82serviceCollection.Add(new ServiceDescriptor(typeof(IImageGenerator), serviceKey, factory: (services, serviceKey) => builder.Build(services), lifetime));
Image\LoggingImageGenerator.cs (3)
19/// The provided implementation of <see cref="IImageGenerator"/> is thread-safe for concurrent use so long as the 39/// <param name="innerGenerator">The underlying <see cref="IImageGenerator"/>.</param> 42public LoggingImageGenerator(IImageGenerator innerGenerator, ILogger logger)
Microsoft.Extensions.AI.Abstractions (28)
Image\DelegatingImageGenerator.cs (5)
14/// Provides an optional base class for an <see cref="IImageGenerator"/> that passes through calls to another instance. 17/// This is recommended as a base type when building generators that can be chained in any order around an underlying <see cref="IImageGenerator"/>. 28protected DelegatingImageGenerator(IImageGenerator innerGenerator) 40/// <summary>Gets the inner <see cref="IImageGenerator" />.</summary> 41protected IImageGenerator InnerGenerator { get; }
Image\IImageGenerator.cs (2)
28/// <summary>Asks the <see cref="IImageGenerator"/> for an object of the specified type <paramref name="serviceType"/>.</summary> 34/// The purpose of this method is to allow for the retrieval of strongly typed services that might be provided by the <see cref="IImageGenerator"/>,
Image\ImageGenerationOptions.cs (5)
65/// The underlying <see cref="IImageGenerator" /> implementation can have its own representation of options. 66/// When <see cref="IImageGenerator.GenerateAsync" /> is invoked with an <see cref="ImageGenerationOptions" />, 68/// the operation. For situations where a consumer knows which concrete <see cref="IImageGenerator" /> is being used 70/// callback for the <see cref="IImageGenerator" /> implementation to use instead of creating a new instance. 78public Func<IImageGenerator, object?>? RawRepresentationFactory { get; set; }
Image\ImageGeneratorExtensions.cs (14)
15/// <summary>Provides extension methods for <see cref="IImageGenerator"/>.</summary> 31/// <summary>Asks the <see cref="IImageGenerator"/> for an object of type <typeparamref name="TService"/>.</summary> 38/// The purpose of this method is to allow for the retrieval of strongly typed services that may be provided by the <see cref="IImageGenerator"/>, 41public static TService? GetService<TService>(this IImageGenerator generator, object? serviceKey = null) 49/// Asks the <see cref="IImageGenerator"/> for an object of the specified type <paramref name="serviceType"/> 60/// The purpose of this method is to allow for the retrieval of services that are required to be provided by the <see cref="IImageGenerator"/>, 63public static object GetRequiredService(this IImageGenerator generator, Type serviceType, object? serviceKey = null) 74/// Asks the <see cref="IImageGenerator"/> for an object of type <typeparamref name="TService"/> 84/// The purpose of this method is to allow for the retrieval of strongly typed services that are required to be provided by the <see cref="IImageGenerator"/>, 87public static TService GetRequiredService<TService>(this IImageGenerator generator, object? serviceKey = null) 109this IImageGenerator generator, 131this IImageGenerator generator, 155this IImageGenerator generator, 182this IImageGenerator generator,
Image\ImageGeneratorMetadata.cs (2)
10/// <summary>Provides metadata about an <see cref="IImageGenerator"/>.</summary> 40/// This value can be <see langword="null"/> if no default model is set on the corresponding <see cref="IImageGenerator"/>.
Microsoft.Extensions.AI.Abstractions.Tests (4)
Image\DelegatingImageGeneratorTests.cs (3)
86var generator = delegating.GetService<IImageGenerator>(expectedKey); 140private sealed class NoOpDelegatingImageGenerator(IImageGenerator innerGenerator)
Image\ImageGenerationOptionsTests.cs (1)
38Func<IImageGenerator, object?> factory = generator => new { Representation = "raw data" };
Microsoft.Extensions.AI.Integration.Tests (2)
ImageGeneratorIntegrationTests.cs (2)
17private readonly IImageGenerator? _generator; 30protected abstract IImageGenerator? CreateGenerator();
Microsoft.Extensions.AI.OpenAI (4)
OpenAIClientExtensions.cs (3)
159/// <summary>Gets an <see cref="IImageGenerator"/> for use with this <see cref="ImageClient"/>.</summary> 161/// <returns>An <see cref="IImageGenerator"/> that can be used to generate images via the <see cref="ImageClient"/>.</returns> 164public static IImageGenerator AsIImageGenerator(this ImageClient imageClient) =>
OpenAIImageGenerator.cs (1)
23/// <summary>Represents an <see cref="IImageGenerator"/> for an OpenAI <see cref="OpenAIClient"/> or <see cref="ImageClient"/>.</summary>
Microsoft.Extensions.AI.OpenAI.Tests (4)
OpenAIImageGeneratorIntegrationTests.cs (1)
8protected override IImageGenerator? CreateGenerator()
OpenAIImageGeneratorTests.cs (3)
28IImageGenerator imageClient = client.GetImageClient(model).AsIImageGenerator(); 38IImageGenerator imageClient = client.GetImageClient("dall-e-3").AsIImageGenerator(); 40Assert.Same(imageClient, imageClient.GetService<IImageGenerator>());
Microsoft.Extensions.AI.Tests (53)
ChatCompletion\ImageGeneratingChatClientTests.cs (1)
155services.AddSingleton<IImageGenerator, TestImageGenerator>();
Image\ConfigureOptionsImageGeneratorTests.cs (2)
38using IImageGenerator innerGenerator = new TestImageGenerator 49using var generator = innerGenerator
Image\ImageGeneratorBuilderTests.cs (5)
61Assert.Throws<ArgumentNullException>("innerGenerator", () => new ImageGeneratorBuilder((IImageGenerator)null!)); 62Assert.Throws<ArgumentNullException>("innerGenerator", () => ((IImageGenerator)null!).AsBuilder()); 68Assert.Throws<ArgumentNullException>("innerGeneratorFactory", () => new ImageGeneratorBuilder((Func<IServiceProvider, IImageGenerator>)null!)); 99private sealed class InnerGeneratorCapturingImageGenerator(string name, IImageGenerator innerGenerator) : DelegatingImageGenerator(innerGenerator) 104public new IImageGenerator InnerGenerator => base.InnerGenerator;
Image\ImageGeneratorDependencyInjectionPatterns.cs (31)
26var instance1 = scope1.ServiceProvider.GetRequiredService<IImageGenerator>(); 27var instance1Copy = scope1.ServiceProvider.GetRequiredService<IImageGenerator>(); 28var instance2 = scope2.ServiceProvider.GetRequiredService<IImageGenerator>(); 50var instance1 = scope1.ServiceProvider.GetRequiredService<IImageGenerator>(); 51var instance1Copy = scope1.ServiceProvider.GetRequiredService<IImageGenerator>(); 52var instance2 = scope2.ServiceProvider.GetRequiredService<IImageGenerator>(); 73Assert.Null(services.GetService<IImageGenerator>()); 75var instance1 = scope1.ServiceProvider.GetRequiredKeyedService<IImageGenerator>("mykey"); 76var instance1Copy = scope1.ServiceProvider.GetRequiredKeyedService<IImageGenerator>("mykey"); 77var instance2 = scope2.ServiceProvider.GetRequiredKeyedService<IImageGenerator>("mykey"); 99Assert.Null(services.GetService<IImageGenerator>()); 101var instance1 = scope1.ServiceProvider.GetRequiredKeyedService<IImageGenerator>("mykey"); 102var instance1Copy = scope1.ServiceProvider.GetRequiredKeyedService<IImageGenerator>("mykey"); 103var instance2 = scope2.ServiceProvider.GetRequiredKeyedService<IImageGenerator>("mykey"); 126Assert.Equal(typeof(IImageGenerator), sd.ServiceType); 148Assert.Equal(typeof(IImageGenerator), sd.ServiceType); 164Assert.Equal(typeof(IImageGenerator), sd.ServiceType); 173public class SingletonMiddleware(IImageGenerator inner, IServiceProvider services) : DelegatingImageGenerator(inner) 175public new IImageGenerator InnerGenerator => base.InnerGenerator;
Image\LoggingImageGeneratorTests.cs (13)
30Assert.Same(innerGenerator, innerGenerator.AsBuilder().UseLogging(NullLoggerFactory.Instance).Build().GetService(typeof(IImageGenerator))); 55using IImageGenerator innerGenerator = new TestImageGenerator 63using IImageGenerator generator = innerGenerator 77entry.Message.Contains($"{nameof(IImageGenerator.GenerateAsync)} invoked:") && 80entry => Assert.Contains($"{nameof(IImageGenerator.GenerateAsync)} completed:", entry.Message)); 85entry => Assert.True(entry.Message.Contains($"{nameof(IImageGenerator.GenerateAsync)} invoked.") && !entry.Message.Contains("A beautiful sunset")), 86entry => Assert.True(entry.Message.Contains($"{nameof(IImageGenerator.GenerateAsync)} completed.") && !entry.Message.Contains("dall-e-3"))); 103using IImageGenerator innerGenerator = new TestImageGenerator 111using IImageGenerator generator = innerGenerator 126entry.Message.Contains($"{nameof(IImageGenerator.GenerateAsync)} invoked:") && 129entry => Assert.Contains($"{nameof(IImageGenerator.GenerateAsync)} completed", entry.Message)); 134entry => Assert.True(entry.Message.Contains($"{nameof(IImageGenerator.GenerateAsync)} invoked.") && !entry.Message.Contains("Make it more colorful")), 135entry => Assert.True(entry.Message.Contains($"{nameof(IImageGenerator.GenerateAsync)} completed.") && !entry.Message.Contains("dall-e-3")));
Image\OpenTelemetryImageGeneratorTests.cs (1)
63using var g = innerGenerator