Open AI
=======

Open AI offers an API to access GPT Large Language Models.
This documents explain how to set up the API key.

Get a key
---------

To use the API, you need to buy credits. You can do this on the `Open AI website`_.

* First, you need to create an account.
* Then, in the **API Keys** section, you can **Create a new secret key**. You will need this key to use the application.
* At last, you can buy credits in the **usage** section to use the API.


.. _Open AI website: https://platform.openai.com/api-keys

Setting Up Geoscience Analyst
-----------------------------

Once the key is obtained, it should be saved in Geoscience Analyst to enable the use of the applications. This step is only required the first time. To do so, as illustrated in the :ref:`figure below <setting-up-open-ai>`, you must:

#. Open the ``File`` menu.
#. Click on ``Preferences``.
#. Navigate to the ``Pro Geology`` tab.
#. Paste the key into the ``Open AI`` - ``API token`` field.

.. image:: ../images/Open_ai_key.png
   :name: setting-up-open-ai
   :align: center

Once these steps are completed, the application is ready for use.

How the data are used?
----------------------

According to the `OpenAI documentation`_ (as of July 5, 2024), OpenAI does not use data sent to the API for training the models unless you explicitly opt in. Data is stored for 30 days to detect potential abuses and is deleted after this period.


.. _OpenAi documentation: https://platform.openai.com/docs/models/how-we-use-your-data