Ask Question
============

This application, as depicted in the :ref:`Figure below <Ask Application Principle>`,
answers a question based on the text associated with Data within `Geoscience ANALYST`_.
The user simply needs to submit a question to the application.
Subsequently, the application performs a `summary`_ of these points, considering the question,
and formulates a response based on this summary.
The resulting answer is conveniently provided as a text file in `Geoscience ANALYST`_,
directly linked to the corresponding data object.

.. image:: ../images/ask_principle.png
    :name: Ask Application Principle
    :align: center


.. _Geoscience ANALYST: https://www.mirageoscience.com/mining-industry-software/geoscience-analyst/
.. _summary: summary.rst

Interface
---------

You can run the application using the interface depicted in :ref:`Figure below <Ask Interface>`.

.. image:: ../images/ask_uijson.png
    :name: Ask Interface
    :align: center

The interface contains the following parameters:

* **Drillhole Data** : The drillhole group and the associated text data to use to answer the question.
* **Object**: The object containing the text data to use to answer the question.
* **Data**: The text data to use to answer the question.
* **Question**: The question to answer.
* **Answer Length**: The length of the answer in number of words. There are three options:

    * **Short**: 50 words
    * **Medium**: 150 words
    * **Long**: 300 words

* **LL Model**: The language model to use to answer the question. The available models are listed in the `Models Available <../index.rst>`_ table.
* **OK**: Clicking "OK" runs the application with the specified parameters.

The application opens a console displaying the progress of the answering process.
Upon completion, the answer is made available as a ``.txt`` file within the `Geoscience ANALYST`_ project.

Results
-------

The answer can be viewed in Geoscience ANALYST, as illustrated in the :ref:`figure below <Ask Result>`. The output is attached to the object selected in the application (**1.** ``DrillholeData`` or ``Object`` in the :ref:`Interface <Ask Interface>`), under the Files section (**2.**). Simply double-click on the file to open it and access the answer (**3.**).

.. image:: ../images/result_ask.png
    :name: Ask Result
    :align: center