Skip to Content

Turn your connections into holiday cash with our new Customer Referral Program! Learn more

✕

Azure OpenAI Register Tools activity

Introduction

An Azure OpenAI Register Tools activity, using its Azure OpenAI connection, adds tools to a chatbot assistant in Azure OpenAI and is intended to be used as a target to consume data in an operation.

Currently these tools are supported:

Create an Azure OpenAI Register Tools activity

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

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

Configure an Azure OpenAI Register Tools activity

Follow these steps to configure an Azure OpenAI Register Tools activity:

Step 1: Enter a name and specify settings

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

Azure OpenAI Register Tools activity configuration step 1

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

  • Chat ID: Enter the chatId. If using a Prompt activity to create a chatbot assistant, you can write the chatId returned in its response to a variable to be referenced here. If you don't provide a chatId, one will be automatically generated, but the tool will not be associated with any existing assistants or previous conversations with the Azure AI.

  • Model ID: Use the menu to select the model to be used. Use the Microsoft documentation to help you pick a model based on your region. The Next button is disabled until a Model ID is selected.

  • 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 Register Tools 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.

  • 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 Register Tools activity, complete the configuration of the operation by adding and configuring other activities or tools 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 Register Tools 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.