Summarize Text
==============

The application, as depicted in the :ref:`Figure below <Summary Application Principle>`,
efficiently summarizes text linked to a Data within `Geoscience ANALYST`_.
It operates by aggregating all associated text into a comprehensive document.
This unified text is then processed to create a concise summary.
The resulting summary is conveniently provided as a text file in `Geoscience ANALYST`_,
directly linked to the corresponding data object.

.. image:: ../images/summary_principle.png
    :name: Summary Application Principle
    :align: center

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

Interface
---------

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

.. image:: ../images/summary_uijson.png
    :name: Summary Interface
    :align: center

The interface contains the following parameters:

* **Drillhole Data** : The drillhole group and the associated text data to summarize.
* **Object**: The object containing the text data to summarize.
* **Data**: The text data to summarize.
* **Summary Length**: The length of the summary in number of words. There are three options:

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

* **LL Model**: The language model to use for summarization. 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 summarization process.
Upon completion, the summary is made available as a ``.txt`` file within the `Geoscience ANALYST`_ project.

Results
-------

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

.. image:: ../images/result_summary.png
    :name: Summary Result
    :align: center