This is the code sample library for the article at:
This library uses the OpenAI API via REST calls to retrieve image prompts as images and provide a number of support features for downloading and storing image prompts and images for later review and possible re-use.
To run the tests you'll need to provide your OpenAI or Azure Credentials (you only need one).
To do this:
- Make sure you have an account on OpenAI (see article) or Azure
- In the Test project create a file called
__TestConfiguration-NoGit.json - Put the following into the file:
{
"OpenAiApiKey": "<OpenAiKey>",
"AzureOpenAiEndpoint": "<Azure EndPoint>",
"AzureOpenAiApiKey": "<Azure API Key>"
}Azure Open AI doesn't work great with Dall-E and requires use of a preview version of the API. You also have to create a custom Azure AI Deployment and it has to be in a specific Azure Region: Sweden Central. Once you've created an Open AI deployment in this region you can pick up the EndPoint URL and API key to run the Azure test.
All but one of the tests use OpenAI - you can switch those tests by passing in the two parameter constructor that passes both the endpoint url and key.
The library is easy to use:
You can generate images and let the API return a url to the image which you can then use to display the image, or can be used to download the image for local storage and later review.
Note: Images are stored for a short time (a few hours) only, so if you want to reuse the images, you need to download them.
[TestMethod]
public async Task ImageGenerationToUrlTest()
{
var generator = new OpenAiImageGeneration(Configuration.OpenAiApiKey);
// var generator = new OpenAiImageGeneration(
// Configuration.AzureOpenAiEndpointUrl,
// Configuration.AzureOpenAiApiKey);
// create a prompt with input options
var imagePrompt = new ImagePrompt()
{
Prompt = "A bear holding on to a snowy mountain peak, waving a beer glass in the air. Poster style, with a black background in goldenrod line art",
ImageSize = "1024x1024",
ImageQuality = "standard",
ImageStyle = "vivid"
};
// Generate and set properties on `imagePrompt` instance
Assert.IsTrue(await generator.Generate(imagePrompt), generator.ErrorMessage);
// prompt returns an array of images, but for Dall-e-3 it's always one
// so FirstImage returns the first image.
var imageUrl = imagePrompt.FirstImageUrl;
Console.WriteLine(imageUrl);
// Open in default image viewer
ShellUtils.GoUrl(imageUrl);
// Typically the AI **fixes up the prompt**
Console.WriteLine(imagePrompt.RevisedPrompt);
// Optionally you can download the image from the captured URL to a local file
// Default folder is %temp%\openai-images\images or specify `ImageFolderPath`
// or specify: imagePrompt.ImageFolderPath = "c:\\temp\\openai-images\\";
Assert.IsTrue(await imagePrompt.DownloadImageToFile(), "Image saving failed: " + generator.ErrorMessage);
string imageFile = imagePrompt.ImageFilePath;
Console.WriteLine(imageFile);
}Alternately you can also generate the image directly to base64 image data in the image result. The code for this is similar.
[TestMethod]
public async Task ImageGenerationToBase64Test()
{
var generator = new OpenAiImageGeneration(OpenAiApiKey);
var imagePrompt = new ImagePrompt()
{
Prompt = "A bear holding on to a snowy mountain peak, waving a beer glass in the air. Poster style, with a black background in goldenrod line art",
ImageSize = "1024x1024",
ImageQuality = "standard",
ImageStyle = "vivid"
};
// Generate with base64 Output Format specified
bool result = await generator.Generate(imagePrompt,
outputFormat: ImageGenerationOutputFormats.Base64);
// Generate and set properties on `imagePrompt` instance
Assert.IsTrue(result, generator.ErrorMessage);
// prompt returns an array of images, but for Dall-e-3 it's always one
// so FirstImage returns the first image.
byte[] bytes = imagePrompt.GetBytesFromBase64();
Assert.IsNotNull(bytes);
// Optionally save the image to file - default folder here
string file = await imagePrompt.SaveImageFromBase64();
Assert.IsTrue(File.Exists(file));
// show image in OS viewer
Console.WriteLine("File generated: " + file);
ShellUtils.GoUrl(file); // show in image viewer
}