| 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.
Enable two Five Providers
In the Azure subscription settings, ensure that the two five 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.
Microsoft.CognitiveServices: Required for adding the Azure OpenAI
Admin User Prerequisites
The user that is to carries out the Ayfie Personal Assistant install process must have these roles and permissions:
...
Select the subscription from the dropdown (Ayfie Development in the example above)
Create a new resource group (recommended for simple ) or select an existing one. The name rg-ayfie-pa-storage is recommended.
Select one of the regions from the dropdown menu.
The region of storage component determines what laws and regulation that will govern the data being stored.
The region of the application component determines which language models that are available. Not all language models are available in all regions.
Even though it is possible to have the two components spread across two different regions, that is not recommended.
Customers from EU countries should for legal reasons select one of the two EU regions.
These are the best performing GPT-4 LLM by region at the time of this writing:
France Central (GPT-4 1106-Preview)
Sweden Central (GPT-4o)
UK South (GPT-4 1106-Preview)
Canada East (GPT-4 1106-Preview)
Check the checkbox to verify you have been granted access to Azure OpenAI with selected subscription (circled in yellow above)
Click the white Next or the blue Review + create button. This will take one to the Review + create page.
...
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 Advanced 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? Allows one to modify the deployment type and/or token quota (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 Advanced 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 defaultDeploy OpenAI models
Decide whether OpenAI models should be deployed alongside the application. By default, this option is selected. If you choose to skip deploying the models, you will need to deploy them manually and configure them within the application. You can do this by following the instructions in this article.
Model Deployment Type
Choose between Standard and Data Zone Standard deployment types during installation. Data Zone Standard routes traffic within a Microsoft-specified data zone, ensuring data processing remains local, such as within EU geographies for resources located there. For more details, visit the Azure OpenAI Deployment Data Processing Locations.
| Note |
|---|
The Data Zone Standard deployment type offers larger quotas for GPT-4o and GPT-4o-mini models, but it does not include any image generation models. If you select this option, you will need to configure the image generation model manually; otherwise, the image generation functionality will not be operational. |
Select Model Deployment Region
Select the region where the Azure OpenAI models will be deployed. This region can differ from the application deployment region chosen in the first step.
The Review + Create Tab
Review the summary of one’s choices from the previous two tabs and go back and correct anything found to be wrong.
Click the Create button at the bottom of the page when ready to deploy Ayfie Personal Assistant
...
Please see the following guide on how to assign these permissions to one or more users: How to Ayfie Personal Assistant - Assign Personal Assistant Admin RoleRoles
Uninstalling Ayfie Personal Assistant
...
The following graphic shows how to start the operation of uninstalling Ayfie Personal Assistant Application:
...
The next graphic shows how one can check the status of the delete operation by clicking the notification icon up in the right corner of the browser window:
...
The uninstallation process may take anywhere from 3 to 20 minutes.will take about 10-15 minutes for each of the applications
Upgrading to a Newer Version of Ayfie Personal Assistant
...