Skip to Content

Azure OpenAI Prompt activity

Introduction

An Azure OpenAI Prompt activity, using its Azure OpenAI connection, creates a text completion for the provided prompt in Azure OpenAI and is intended to be used as a target to consume data in an operation.

Create an Azure OpenAI Prompt activity

An instance of an Azure OpenAI Prompt activity is created from an Azure OpenAI connection using its Prompt 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 Create an activity instance in Component reuse.

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

Configure an Azure OpenAI Prompt activity

Follow these steps to configure an Azure OpenAI Prompt 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 Prompt activity configuration step 1

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

  • Prompt Text: Enter the prompt to be used for the completion.

  • Model ID: Use the menu to select the model to be used. The Next button is disabled until a Model ID is selected.

  • Refresh: Click the refresh icon or the word Refresh to reset the Model ID to the previously saved Model ID.

  • Optional Settings: Click to expand additional optional settings:

    • Temperature: Enter the sampling temperature. The value must be a decimal between 0 and 2. It is not recommended to use this setting with Top Probability.

    • Max Tokens: Enter the maximum number of tokens to be used to generate the completion. The default value is 16.

    • Top Probability: Enter the top probability. It is not recommended to use this setting with Temperature.

  • 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 Prompt 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.

    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 Prompt 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 Prompt 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.