Azure OpenAI Download Image activity¶
Introduction¶
An Azure OpenAI Download Image activity, using its Azure OpenAI connection, retrieves the URL of a previously generated image from Azure OpenAI and is intended to be used as a source to provide data in an operation.
Note
To use the Download Image activity, you must have the id
of a previously generated image. The id
must be provided in the Download Image activity's ID field in step 1 of the activity configuration or as the id
in the request. If the image was generated using the Request image activity, you can use the id
returned in the activity's response.
Create an Azure OpenAI Download Image activity¶
An instance of an Azure OpenAI Download Image activity is created from an Azure OpenAI connection using its Download 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 Download Image activity can be edited from these locations:
- The design canvas (see Component actions menu in Design canvas).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
Configure an Azure OpenAI Download Image activity¶
Follow these steps to configure an Azure OpenAI Download Image activity:
-
Step 1: Enter a name and specify settings
Provide a name for the activity and specify the image ID and optional settings. -
Step 2: Review the data schemas
Any request or response schemas are displayed.
Step 1: Enter a name and specify settings¶
In this step, provide a name for the activity and specify the image ID and optional settings. Each user interface element of this step is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Name: Enter a name to identify the activity. The name must be unique for each Azure OpenAI Download Image activity and must not contain forward slashes
/
or colons:
. -
ID: Enter the image ID (obtained in the response of a Request image activity).
-
Optional Settings: Click to expand additional optional settings:
- 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.
-
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
obtained from the Request image activity's response as input for theid
field in 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. -
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 Download 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 Download Image activities can be used as a source with these operation patterns:
- Transformation pattern
- Two-target archive pattern (as the first source only)
- Two-target HTTP archive pattern (as the first source only)
- Two-transformation pattern (as the first or second source)
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.