openai/openai-dotnet
Publicmirrored from https://github.com/openai/openai-dotnetAvailable
src/Custom/Images/GeneratedImage.cs
38lines · modeblame
9f9f2936Jose Arriaga Maldonado2 years ago | 1 | using System; |
| 2 | | |
| 3 | namespace OpenAI.Images; | |
| 4 | | |
| 5 | /// <summary> | |
| 6 | /// Represents the result data for an image generation request. | |
| 7 | /// </summary> | |
| 8 | [CodeGenModel("Image")] | |
| 9 | public partial class GeneratedImage | |
| 10 | { | |
| 11 | // CUSTOM: | |
| 12 | // - Renamed. | |
| 13 | // - Edited doc comment. | |
| 14 | /// <summary> | |
| 15 | /// The binary image data received from the response, provided when | |
| 16 | /// <see cref="ImageGenerationOptions.ResponseFormat"/> is set to <see cref="GeneratedImageFormat.Bytes"/>. | |
| 17 | /// </summary> | |
| 18 | /// <remarks> | |
| 19 | /// This property is mutually exclusive with <see cref="ImageUri"/> and will be <c>null</c> when the other | |
| 20 | /// is present. | |
| 21 | /// </remarks> | |
| 22 | [CodeGenMember("B64Json")] | |
| 23 | public BinaryData ImageBytes { get; } | |
| 24 | | |
| 25 | // CUSTOM: | |
| 26 | // - Renamed. | |
| 27 | // - Edited doc comment. | |
| 28 | /// <summary> | |
| 29 | /// A temporary internet location for an image, provided by default or when | |
| 30 | /// <see cref="ImageGenerationOptions.ResponseFormat"/> is set to <see cref="GeneratedImageFormat.Uri"/>. | |
| 31 | /// </summary> | |
| 32 | /// <remarks> | |
| 33 | /// This property is mutually exclusive with <see cref="ImageBytes"/> and will be <c>null</c> when the other | |
| 34 | /// is present. | |
| 35 | /// </remarks> | |
| 36 | [CodeGenMember("Url")] | |
| 37 | public Uri ImageUri { get; } | |
| 38 | } |