| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| minLevel | 1 | maxLevel | ||||||||||
| Table of Contents | ||||||||||||
|
...
Ayfie Personal Assistant consists of two components, of which one, the part that includes the UI, is referred to as the Ayfie Personal Assistant Application. Since Azure Marketplace refers to both components as applications.A, this can lead to some confusion. It is thus important to understand that Ayfie Personal Assistant: is made up of these two components:
...
Technically, there is no problem installing and configuring Ayfie Personal Assistant as a public offering even if one purchased it via a private plan. However, that would significantly increase the monthly cost without any added benefit.
Resource Groups
Resource group is the mechanism A resource groups is what is used to group and administrate customer resources in Azure. The two Ayfie components Ayfie Personal Assistant Storage and Ayfie Personal Assistant Application could be placed in one resource group together with other non-Ayfie resources, or in a resource group just by themselves, or split across two different resource groups. Further, these resource groups could be given any name one see fit. However, it is recommended that each of them are given a dedicated resource group and that they are not mixed with other resources. It is also our recommendation these resource groups are named rg-ayfie-pa-storage and rg-ayfie-pa-application as the use of standardized names will make any later support request much easier to follow up on.
Prerequisites
The prerequisites come in two groups:
...
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.
...
One can use a Service Principal that already exists or create a new one.
Note:If an upgrade make sure to use the exact same Enterprise Application in previous version, else it may cause issues with files and chat history
Depending on which of the two options one chose, clicking the Make selection link will either bring up a search pane with existing Service Principals to choose from, or a form to register a new Service Principal. The screenshot above shows the case of creating a new one.
Give the Service Principal (the Entra ID application) a name, for instance AyfiePersonalAssistantApp as in the graphics above.
Select the single tenant option (this would cover the case of all users being employees of the customer)
Click the Register button. This will take one away from the page. After having completed the registration, just redo the first few steps to get back to this place. ← or is there some other way?Verify that one has created or
Verify that one has created or selected a Service Principal by checking of the check box
Click Next (circled in red) to get to the Authentication page
...
These settings are not possible to change post deployment. That would require one to uninstall and install as explained in chapter “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
Click the white Next or the blue Review + create button. This will take one to the Review + create page.
Data Retention Policy (green box)
If one want to reduce the storage cost, be compliant with internal policies for data storage or if one want to avoid a potential long list of files in the user interface of Personal Assistant, one can enable Data Retention Policy. This can be set to an integer between 7 and 100. This feature will then remove all files permanently from Personal Assistant if the file is older and haven’t been used in any chat for the past number of days specified.
...
Under the Security part of the vertical menu to the left, Select Permissions
Click on Grant admin consent for [Your Organization].
A new web browser window is shown, click Accept.
Limit User Access for Personal Assistant
See following chapters in the guide https://learn.microsoft.com/en-us/entra/identity-platform/howto-restrict-your-app-to-a-set-of-users
Update the app to require user assignment
Assign the app to users and groups to restrict access
Custom Domain Configuration
If a custom domain was configured earlier, then that has to be followed up with a corresponding DNS configuration as shown here:
...
Uninstalling Ayfie Personal Assistant
The following graphic shows how to start the operation of uninstalling Ayfie Personal Assistant:
...
The next graphic shows how one Personal Assistant consists of two components:
Ayfie Personal Assistant Application
Ayfie Personal Assistant Storage
There are two different uninstall scenarios:
One wants to uninstall Personal Assistant completely for not using it any longer
Uninstall both components
One wants to uninstall Personal Assistant as part of an upgrade to a newer version of Personal Assistant
Only uninstall the application component, leave the storage component with all the uploaded documents in place
The following graphic shows how to start the operation of uninstalling Ayfie Personal Assistant:
...
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:
...
However, Ayfie Personal Assistant Storage ensures that data is preserved during upgrades. Therefore, it is crucial to only uninstall and reinstall the Managed Application “Ayfie Ayfie Personal Assistant Application. ” The Managed Application “Ayfie Ayfie Personal Assistant Storage” Storage must remain in place as-is.
| Note |
|---|
Do NOT uninstall the application Ayfie Personal Assistant Storage |
Here are the 3 steps to “upgrade” to a later version:
Retrieve the Client ID /Name from the Deployment Output
Open the Managed Application app.of the application:
Go to the Microsoft Azure Portal at https://portal.azure.com
In the search box enter Managed Applications and select it from the search results
At the Managed Applications page, click AyfiePersonalAssistant (or whatever other name one chose to give the application in a previous section above)
Under Settings, Click Parameters and Outputs in the left vertical menu
Navigate to Settings and select Parameters and outputs
Copy the Client ID
, it will be needed in step 4 below
Uninstall the current version as described in chapter Uninstalling the Ayfie Personal Assistant
Force an immediate deletion of any resources that are marked for deletion but that have still not been deleted as shown in the screenshot below.
...
Install from scratch as described in chapter Installing Ayfie Personal Assistant.
If opting to re-use the existing "Service Principal" and you don’t use a custom domain name, ensure to update the 'callback_url' within Set the Entra ID application up with the Callback URL
(Note: If you are upgrading for a version prior 2.14 of Personal Assistant you would also need to follow
...
the instruction in linked)
If Custom Domain is configured with the same value as in past versions, one is required to follow the steps within Custom Domain Configuration
Troubleshooting
Deploying Ayfie Personal Assistant may encounter issues, and this section provides guidance on identifying and resolving common errors.
...