.. _voss-wingman:

VOSS Wingman
-------------

.. _24.1|VOSS-1365:

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.

The interface is enabled by default, but can be disabled and managed by ``sysadmin`` users
and administrators who have access to ``data/Settings``. For details, see:

.. raw:: latex

   the Enable Wingman Chat topic in the Advanced Configuration Guide.

.. raw:: html

   <a href="reference-enable-wingman-chat.html">Enable Wingman Chat</a>.

.. note::

   * A user role should also be associated with an **Access Profile**
     that has **Copilot 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.
   
   * Wingman requires internet access (to Microsoft Azure) and does not currently 
     support connecting via a proxy. Automate Application Nodes will therefore require
     direct outbound internet access to Microsoft Azure in order to function.
     An outbound connection via a Web Proxy will be supported in a future release of Automate.

For details on Access Profiles and the required administrator level to manage these settings, see:

.. raw:: html

   <a href="concepts-access-profile-operations.html">Access Profile Permissions and Operations</a>

.. 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


  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