Skip to Content

Azure OpenAI Request Image activity

Introduction

An Azure OpenAI Request Image activity, using its Azure OpenAI connection, generates an image based on a specified prompt in Azure OpenAI and is intended to be used as a target to consume data in an operation.

Note

After generating an image using the Request Image activity, use the Download image activity to retrieve the URL for the image.

Create an Azure OpenAI Request Image activity

An instance of an Azure OpenAI Request Image activity is created from an Azure OpenAI connection using its Request Image activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing Azure OpenAI Request Image activity can be edited from these locations:

Configure an Azure OpenAI Request Image activity

Follow these steps to configure an Azure OpenAI Request Image activity:

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and specify the prompt text and optional settings. Each user interface element of this step is described below.

Azure OpenAI Request Image activity configuration step 1

  • Name: Enter a name to identify the activity. The name must be unique for each Azure OpenAI Request Image activity and must not contain forward slashes / or colons :.

  • Prompt Text: Enter a description of the image to be generated. The maximum length is 1000 characters.

  • Optional Settings: Click to expand additional optional settings:

    • Size: Use the menu to select the dimensions of the image in pixels, one of 1024x1024, 256x256, or 512x512. The default selection is 1024x1024.

    • Total Number of Image: Enter the number of images to be generated. The default value is 1 and the maximum value allowed is 5.

    • Supported Versions: The version 2023-06-01-preview is the only supported version and is selected by default.

  • Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

Azure OpenAI Request Image activity configuration step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    Note

    Data supplied in a transformation takes precedence over the activity configuration.

    Information

    You can use the id in the Request Image activity's response to use as input for the Download image activity's request.

    The Azure OpenAI connector uses the Azure OpenAI Service REST API. Refer to the API documentation for information on the schema nodes and fields.

  • Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Azure OpenAI endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Edit: Click the edit icon above each data schema to enter the editor for that data schema. The editor allows you to add, delete, and reorganize nodes and fields and change their data types. All newly added nodes and fields are set to [0, 1] cardinality. Changes made to the data schemas must be acceptable to the endpoint and should be made only after consulting any available documentation for the endpoint. After making schema edits, a last-edited date is displayed along the top of the applicable schema to indicate the schema has had manual edits. Refreshing the schemas will reset the schemas to their default structures.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring an Azure OpenAI Request Image activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

Azure OpenAI Request Image activities can be used as a target with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.