Azure ChatGPT

The Azure ChatGPT connector lets you generate the content via chat responses and prompt responses using the Azure cloud network. You can also translate the entry data using the Translate an Entry action.

Enterprises and businesses can deploy their ChatGPT versions on the Azure cloud and use the Azure ChatGPT connector to generate responses by integrating their Azure account within the Azure ChatGPT connector.

Prerequisites

To use the Azure ChatGPT connector, you first need to connect your Azure ChatGPT account with Automate using the following steps:

1. Log in to your Contentstack account and click the Automate icon from the left navigation panel.
2. Select your project and then the automation.
3. Click Configure Action Step from the left navigation panel and then Action Step to configure third-party services.
4. Within the Choose Connector, click the Azure ChatGPT connector.
   
5. Under Choose an Action, select the Chat action.
6. In the Configure Action section, click + Add New Account to add your Azure ChatGPT account.
7. In the Authorize modal, enter the Title, Resource Name, API Key, Deployment Name/ID, and API Version retrieved from the Azure platform.
   1. Log in to the Azure Platform.
   2. You must create a resource (if not created already). Click + Create Resource.
   3. Click the resource created. Click to manage the keys or create one in the Manage Keys section.
   4. In the Model Deployments section, click Manage Deployments -> Authorize your account. You will see a list of all the deployments created in the Azure platform. Click + Create new deployment to create a new deployment.

      Note: Refer to the Azure OpenAI Service REST API Reference document for more information on API Version.

8. Click the Authorize button.
   

This sets up your Azure ChatGPT account for the Azure ChatGPT connector.

Set up the Azure ChatGPT

Perform the following steps to set up the Azure ChatGPT action connector:

1. Click Configure Action Step from the left navigation panel.
2. Click Action Step to configure third-party services.
3. Within the Configure Action Step, click the Azure ChatGPT connector.
   
4. You will see two actions under the Choose an Action tab: Chat, Prompt, and Translate an Entry.
   

   Let’s look at each of them in detail.

Chat Action

1. Under Choose an Action tab, select the Chat action.
2. On the Chat Configure Action page, enter the details given below:
   1. Click the + Add New Account button to add your Azure ChatGPT account.
      
   2. In the Prompt Text field, provide your query to generate the chat response(s).
   3. Select the Role from the dropdown options to send to the API model request. By default, the role is set to the user.

      Additional Resource: There are three types of roles provided by the OpenAI platform. The system role sets the response context, the assistant role provides the response content, and the user role asks the prompt.
      

      
   4. Enable the Show optional fields toggle button to display the Number of Tokens, Randomness of Responses, Number of Chat Responses, User Identifier, Frequency of Repeated Words, Presence of Repeated Responses, and Additional Prompt Text fields.
   5. Enter the Number of Tokens to generate the content. This must be within the range of 1 to 2048.
   6. Enter a value for the Randomness of Responses of the generated content. 0 being the most precise and 2 being the most random content predictions. This must be within the range of 0 to 2.
   7. Enter the Number of Chat Responses you want to be generated in the automation response. This must be within the range of 1 to 3.
      
   8. Provide the User Identifier name, which helps the OpenAI platform to monitor and detect abuse.
   9. Provide the value to set the Frequency of Repeated Words. The most positive value is likely to avoid the use of repeated words. This must be within the range of -2 to 2.
   10. Provide the value to set the Presence of Repeated Responses. The most positive value is likely to generate a new response. This must be within the range of -2 to 2.
       
   11. With the Additional Prompt Text field, you can add multiple queries based on the Role. The output generates a combined response provided in the Prompt Text field and adds the response(s) for your queries afterwards.
   12. You can mark the Sanitize text checkbox to remove special characters or spaces from the chat response. By enabling this checkbox, any special characters or spaces in the chat response will be eliminated, resulting in a clean and compatible text.
       
3. Click Proceed.
4. To test the configured action, click the Test Action button.
5. You will get the response(s). Once set, click the Save and Exit button.
   

Prompt Action

1. Under Choose an Action tab, select the Prompt action.//ss
2. On the Prompt Configure Action page, enter the details given below:
   1. Click + Add New Account button to connect your Azure ChatGPT account as shown in the Prerequisites step.
   2. Provide the Prompt Text to generate response(s).
      
   3. Enable the Show optional fields toggle button to display the Number of Tokens, Randomness of Responses, Number of Prompt Responses, User Identifier, Frequency of Repeated Words, and Presence of Repeated Responses fields.
   4. Enter the Number of Tokens to generate the content. This must be within the range of 1 to 2048.
   5. Enter a value for the Randomness of Responses of the generated content. 0 being the most precise and 2 being the most random content predictions. This must be within the range of 0 to 2.
   6. Enter the Number of Prompt Responses you want to be generated in the automation response. This must be within the range of 1 to 3.
   7. Provide the User Identifier name which helps the OpenAI platform to monitor and detect abuse.
   8. Provide the value to set the Frequency of Repeated Words. The most positive value is likely to avoid the use of repeated words. This must be within the range of -2 to 2.
   9. Provide the value to set the Presence of Repeated Responses. The most positive value is likely to generate a new response. This must be within the range of -2 to 2.
   10. You can mark the Sanitize text checkbox to remove special characters or spaces from the chat response. By enabling this checkbox, any special characters or spaces in the chat response will be eliminated, resulting in a clean and compatible text.
       
3. Click Proceed.
4. To test the configured action, click the Test Action button.
5. You will get the response(s). Once set, click the Save and Exit button.
   

Translate an Entry

The Translate an Entry action returns the translated entry data in the response. To use this action, follow the steps below:

1. Under Choose an Action tab, select the Translate an Entry action.
2. On the Translate an Entry Configure Action page, enter the details given below:
   1. Click + Add New Account button to connect your Azure ChatGPT account as shown in the Prerequisites step.
   2. In the Entry Data field, enter the entry data to translate.
   3. In the Content Type Schema field, enter the content type schema for translating the entry data.

      You can fetch the Entry Data and Content Type Schema from the previous step using the Get a Single Content Type and Get a Single Entry actions.

      
   4. In the Select Language drop-down, select the language in which you want to translate the entry data.
   5. Click the Show Optional Fields toggle button to use these optional fields:
      1. Provide the Prompt Text to generate the response. This offers additional capabilities to customize the translated entry data.
      2. Enter the Number of Tokens to generate the content. By default, the token limit is 2000.
         
   6. Click Proceed.
   7. Check if the details are correct. If yes, then click Test Action button.
   8. You will get the response(s). Once set, click Save and Exit.
      

This sets the Azure ChatGPT connector.