| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Obtain an Azure Subscription
An active Azure subscription is required. To register a new subscription, go to the Azure website.
At times, Microsoft may impose subscription type specific limitations on their OpenAI services, particularly concerning the amount of data (referred to as the token quota) that can be exchanged during chat interactions. Please see this Microsoft documentation on token quotas for details on which subscription types that may have such restrictions.
If one has a contract directly with Ayfie (a.k.a. private plan) please send the Subscription ID to your Ayfie contact.
Get Azure OpenAI Approval
The Azure subscription needs to be approved for Azure Open AI. How to do that is described in Ayfie Personal Assistant - How to Request Access to the Azure OpenAI Service.
Enable two Providers
In the Azure subscription settings, ensure that the two providers below are enabled. How to do that is described in Ayfie Personal Assistant - How to Add Providers to an Azure Subscription.
Microsoft.App: Required for deploying applications within Azure.
Microsoft.ContainerService: Required for managing container-based services within Azure.
...
Microsoft.ContainerInstance: Required for runningcontainerized applications without needing to manage the underlying infrastructure.
Microsoft.OperationalInsights: Required for monitoring, diagnostics, and log management.
Admin User Prerequisites
The user that is to carries out the Ayfie Personal Assistant install process must have these roles and permissions:
Azure Subscription Management Owner and Key Vault Administrator
Permission to Create and Manage Entra ID Enterprise Applications
Permission to Alter DNS Configuration
The user must have permissions to alter public DNS records for custom domain setup (only required if the auto generated URL used by users to access the application is to be changed to something more readable and user friendly).
...
If in doubt, one should consult Private Plan or Public Offering? on how to find out what one has. Most of the steps are the same for the two alternatives. The difference is in step 2 and 5 below (indicated with bold font) and with green markings in the screenshot below where one follow the red arrows all the way for the public offering and swap to green for the private plan.
...
Go to the Microsoft Azure Portal at https://portal.azure.com
In the search box enter Marketplace and select it from the search results
If you have a private plan select Private plans in in the left side menu (circled in green), otherwise use the search box to look up the “Ayfie Personal Assistant” applications
Select the Ayfie Personal Assistant Application box
If you have a private plan, select the plan from the dropdown (see green arrow below), otherwise select the number of users you want to license (red arrow). Then click the Create button.
...
Custom Domain - Allows one to configure a Custom Domain that is to be used instead of a randomly generated URL when accessing the Personal Assistant (red box)
Data Retention Policy - Allows one to configure for how long time uploaded documents are to be stored after having been accessed the last time (green box)
Model Configuration - Set the philosophy for how to determine what AI-model to be used as the default for when starting new chat sessions or going back to stored chat sessions. Price, performance or a mix? (blue box)
These settings are not possible to change post deployment. That would require one to uninstall and install as explained in section Upgrading to a Newer Version of Ayfie Personal Assistant.
...
Custom Domain (red box)
When deploying Ayfie Personal Assistant one is always given an URL which users can use to access the frontend. This URL will adhere to the format: https://chat-ui.random-part.region-name.azurecontainerapps.io.
...
Check the “Configure custom domain”
Check the “Verify if you have access to DNS record for you domain”
Add the custom domain, e.g. “pa.my-domain.com” to the input field
Note: This has to be made as a public DNS
Click the white Next or the blue Review + create button. This will take one to the Review + create page.
Data Retention Policy (green box)
To reduce storage expenses, adhere to data storage guidelines, or keep the Personal Assistant interface uncluttered, you can turn on the Data Retention Policy. This will automatically remove any uploaded documents that haven't been used in chats for the duration (from 7 to 100 days) set by the adjustable sliding scale.
Check the “Enable data retention policy”
Enter the number of days before files are deleted due to inactivity
Model Configuration (blue box)
For each region there will be a set of models that will be made available to the users. One of those models will be the default one and the one to be returned to each time one starts a new chat or when one return to a stored chat. While it is not possible to select a specific model to instead be used as the default, one can set the “philosophy” for how to determine the default. The three “philosophies” to chose chose from are Economy, Premium, Standard. That is, price, performance, and mix of the two, respectability. Economy is the default.
...
Go to the Microsoft Azure Portal at https://portal.azure.com
In the search box enter Resource Groups and select it from the search results
Search for and select resource group rg-ayfie-pa-application (or whatever other name that it was given)
Click the managed application AyfiePersonalAssistant (or whatever other name that it was given)
Click the managed resource group link mrg-ayfie_personal_assistan-<timestamp> (or whatever other name that it was given) up to the right
Within this group, find and click on the 'chat-ui' resource to access its settings.
In the 'chat-ui' resource, look for the 'Custom Domain' section in the navigation pane on the left side of the screen.
Click on the 'Add custom domain' button to start the domain setup process.
When prompted, choose 'Managed certificate' as your first option (circled in purple) to ensure your domain is secured with an SSL certificate managed by Azure.
In the 'Domain' field (circled in green), type in the exact domain name you specified during the deployment of the Ayfie Personal Assistant Application.
For the record type, leave it set to “CNAME”
Add the two records provided in the 'Domain validation' section (circled in orange) to your domain's DNS settings. These records are crucial for proving ownership of the domain and for the SSL certificate to be issued. Please note the following when setting up the public DNS record:
CNAME Record:
Host: Enter your domain name (e.g.,
ayfie.company.com).Value: Use the URL ending with
...containerapps.ioprovided by Azure.
TXT Record:
Host: Enter
asuid.followed by your domain name (e.g.,asuid.ayfie.company.com).Value: Use the value provided by Azure.
Once you've updated your domain's DNS settings, click the 'Validate' button in Azure to check if the records are correctly configured.
If the validation is successful, the domain status should eventually update from “No binding” to 'Secured', indicating that your custom domain is now properly set up and protected with an SSL certificate.
...