Microsoft Azure OpenAI

Prev Next

This article describes how to connect to a deployed Microsoft Azure OpenAI model.

After you create an AI connection, you can add AI Generated Insights to Distribution Job messages. For more information, see AI Generated Insights.

Before you Begin:

  1. In the Microsoft Azure Portal, create an Azure Open AI Service resource.

  2. Use the Azure OpenAI Studio to deploy and configure an AI model of your choice.
    Make note of the Deployment Name you assigned and the API Key and Endpoint URL required for accessing your deployment.

To add and configure an Azure OpenAI connection:

  1. In the ReportWORQ Administration interface, select the add icon beside the AI Connections heading.


    The New AI Connection dialog appears:



  2. Select Azure OpenAI.



    The Azure OpenAI Settings appear. The following example shows configured settings.



  3. Configure the following settings as required:

    • Name: A name for the connection.
      Job creators will see this name when they create an AI Insight. It may also appear in messages to report recipients.

    • Endpoint: The URL required for accessing your deployed AI model.

    • Deployment Name: The name assigned to your model deployment in the Azure AI Portal.

    • API Key: The secret token required for authenticating to your deployed model.

    • Default Temperature: A value between 0 and 2 that controls how random the generated AI responses may be:

      • A lower temperature makes the results more deterministic, which is ideal when factual accuracy, consistency, and predicatability are desired.

      • A higher temperature makes the results more random, which is ideal when creativity, variety, and originality are desired.
        The default value is 0.7.

    • Default Max Tokens: The default maximum number of AI tokens consumed per AI prompt. The default value is 1024.
      Job creators can override this value when configuring individual AI Generated Insight prompts.
      Tip: An AI token is a small chunk of data, such as a word or part of a word, that the AI model processes to understand an AI prompt. AI services typically charge fees based on the number of AI tokens consumed.

  4. To confirm that the settings are properly configured, select Test Connection.
    If the test fails, edit the settings as required and then test again.

  5. Select the Enable provider checkbox.

  6. Select the Save icon to save and apply the settings.