ImageGenerationData interface

  • Reference
Package:
@azure/openai

A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image may be retrieved.

Properties

base64Data

The complete data for an image, represented as a base64-encoded string.
contentFilterResults

Information about the content filtering results.
promptFilterResults

Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.
revisedPrompt

The final prompt used by the model to generate the image. Only provided with dall-3-models and only when revisions were made to the prompt.
url

The URL that provides temporary access to download the generated image.

Property Details

base64Data

The complete data for an image, represented as a base64-encoded string.

base64Data?: string

Property Value

string

contentFilterResults

Information about the content filtering results.

contentFilterResults?: ImageGenerationContentFilterResults

Property Value

ImageGenerationContentFilterResults

promptFilterResults

Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.

promptFilterResults?: ImageGenerationPromptFilterResults

Property Value

ImageGenerationPromptFilterResults

revisedPrompt

The final prompt used by the model to generate the image. Only provided with dall-3-models and only when revisions were made to the prompt.

revisedPrompt?: string

Property Value

string

url

The URL that provides temporary access to download the generated image.

url?: string

Property Value

string