.. _voss-wingman:
VOSS Wingman
-------------
.. _24.1|VOSS-1365:
.. _24.1-PB2|EKB-21090:
.. _24.2|VOSS-1430|EKB-21301:
Overview and Access
...................
VOSS Automate provides a **Wingman Chat** AI assistant in the Admin portal
that can be activated by a user from any form.
This feature is enabled by default, but can be enabled and disabled by ``sysadmin`` users
and admins with access to the ``data/Settings`` model. For details, see :ref:`enable-wingman-chat`:
.. raw:: latex
See **Enable Wingman Chat** in the *Settings* topic in the Advanced Configuration Guide.
.. raw:: html
Enable Wingman Chat.
Wingman requires internet access (to Microsoft Azure) and
supports connecting via a web proxy. This can be configured by ``sysadmin`` users
and admins with access to the ``data/Settings`` model and the **Web Proxy** menu.
For details, see :ref:`wingman-web-proxy` and :ref:`licensing-web-proxy`.
.. note::
* A user role should also be associated with an **Access Profile**
that has **Wingman Chat** enabled under the **Miscellaneous Permissions**.
From release 24.1, default administrator roles have this permission enabled
and an upgrade to 24.1 enables this permission on all existing access profiles.
* In order to first use VOSS Wingman, an initial manual sync step is required -
See: Insights Analytics in the Platform Guide.
For details on Access Profiles and the required administrator level to manage these settings, see:
.. raw:: html
Access Profile Permissions and Operations
.. raw:: latex
the Access Profiles chapter in the Core Feature Guide.
Using VOSS Wingman
....................
.. note::
While we strive to ensure and will continue to improve on chatbot accuracy in future releases,
the correctness, completeness, or reliability of all results and documentation links is
not guaranteed.
Click the **Wingman** icon on the top toolbar of the interface.
.. image:: /src/images/wingman-icon.png
A dialog opens and selecting the help (**?**) icon next to the title
or typing **help** into the message provides guidance on using the Wingman Chat:
.. image:: /src/images/wingman-chat.png
Three types of tasks can be carried out - each selected by using
an appropriate *prefix phrase* in your chat input:
* **Show me/List all/How many**: look up data on the platform.
For "Show me" questions, the reply can be rendered in a chart.
.. image:: /src/images/wingman-num-inv-by-status.png
Date ranges can also be included into questions, for example: "show me transactions for this week".
The list below provides an indication of the calculation of the date range based on the phrase in the question:
* today: from 00:00:00 (UTC) to 23:59:59 (UTC) of the current day.
* yesterday: from 00:00:00 (UTC) to 23:59:59 (UTC) of the previous day, in other words, the full 24 hour period of the previous day.
* last week: from 00:00:00 (UTC) last Monday to Sunday 23:59:59 (UTC).
* last month: from 00:00:00 (UTC) of the first day of the preceding month to 23:59:59 (UTC) of the last day of the preceding month.
* last year: from 00:00:00 (UTC) of the first day of the previous year to 23:59:59 (UTC) of the last day of the previous year.
* this week: from 00:00:00 (UTC) of the first day of the current week to 23:59:59 (UTC) of the last day of the current week.
* this month: from 00:00:00 (UTC) of the first day of the current month to 23:59:59 (UTC) of the last day of the current month.
* this year: from 00:00:00 (UTC) of the first day of the current year to 23:59:59 (UTC) of the last day of the current year.
* since : from 00:00:00 (UTC) of the specified date to 23:59:59 (UTC) of the current day.
* since : Match start date time to the phrase, but end date must be today's date time. Examples:
* since last week: from 00:00:00 (UTC) last Monday to today's date.
* since yesterday: from 00:00:00 (UTC) to 23:59:59 (UTC) of the previous day to today's date.
When queries are made without an explicit date range, the default behaviour is "since last week", for example,
if a query was made on September 6th, 2024 at 12:55 UTC:
.. image:: /src/images/wingman-showme-chart-default-date-range.png
Icons below replies show options to change the chart or output format.
For "How many" questions, Wingman by default responds by showing a bar
chart with the count of the data found.
For "List all" questions, Wingman by default responds by showing
a table with the data found.
.. image:: /src/images/wingman-list-all.png
.. note::
* The Wingman will use the permitted dashboard resources in a
user's access profile as valid data lookup options.
* Data sources are: :ref:`wingman-data-sources`. If a question does not
refer to these sources, Wingman responds with the friendly names of
these sources as available data sources.
* Count results (in tables or charts) are dependent on the *hierarchy*
at which the user is, as well as the user role permissions when using the
Wingman chat interface.
The example below shows responses where an
admin user navigates down to a site level hierarchy and asks:
"List all users with last name Smith" (result: **No Data to display.**)
and then navigates to a provider level and repeats the question (result: table):
.. image:: /src/images/wingman-hierarchy.png
* "How many" and "Show me" questions use the Insights data source
that is available from release 24.1 and is also used to
create dashboard widgets. For details, see: :ref:`automate-dashboards`.
This means that while questions for data can be refined by also specifying
a single provider, reseller or customer or site hierarchy name
in the question, questions do not return data when a question
specifies all hierarchies.
* **I need to**: **Wingman Chat** responds with instructions and with a **Go now** link
to the appropriate form or feature.
.. image:: /src/images/wingman-follow-link.png
The **Go now** links use the following models for the matching tasks:
* Onboard a new multi-vendor user (subscriber)
``view/AddSubscriberFromProfile``
* Onboard a new Microsoft user (subscriber)
``view/MicrosoftSubscriberQas``
* Onboard a new Cisco user (subscriber)
``view/QuickSubscriber``
* Create a new Cisco phone
``view/AddPhone``
* Add a range of numbers to the number inventory
``view/NumberInventoryRangeMgmtVIEW``
* **How do I**: to ask questions about the product and the
Wingman responds with a summarized answer as well as with a set of generated reference
links to the full documentation on the documentation portal that may be relevant.
.. image:: /src/images/wingman-how-do-i.png
Chat History
...............
A user's chat history is available to the user in the **Wingman Chat** form
for the duration of the user session: the time that the user is logged in -
regardless if the user navigates to another form on the portal.
Use the **[UP]** arrow key to see your previous question.
*However*, if **clear** is typed into the message box or the Replay button on the
**Wingman Chat** form is selected, all messages are cleared.
.. _wingman-data-sources:
Wingman Data Sources
....................
The table below show the list of VOSS Automate data sources that are available
to Wingman when **Show me/List all/How many** - type questions are asked.
.. tabularcolumns:: |p{9cm}|p{6cm}|
.. csv-table:: Wingman Data Sources
:file: wingman-data-sources.csv
:class: longtable
:header-rows: 1
:widths: 3 2