.. _profile:

An AI profile is a specification that includes the AI provider to use and other
details regarding metadata and database objects required for generating
responses to natural language prompts.

An AI profile object can be created using ``select_ai.Profile()``

********************
Profile Object Model
********************

.. _profilefig:
.. figure:: /image/profile_provider.png
   :alt: Select AI Profile and Providers

.. latex:clearpage::

*******************************
Base ``Profile`` API
*******************************
.. autoclass:: select_ai.BaseProfile
   :members:

.. latex:clearpage::

*******************************
``Profile`` API
*******************************

.. autoclass:: select_ai.Profile
   :members:

.. latex:clearpage::

**************************
Create Profile
**************************

.. literalinclude:: ../../../samples/profile_create.py
   :language: python
   :lines: 14-

output::

    Created profile  oci_ai_profile
    Profile attributes are:  {'annotations': None,
     'case_sensitive_values': None,
     'comments': None,
     'constraints': None,
     'conversation': None,
     'credential_name': 'my_oci_ai_profile_key',
     'enable_source_offsets': None,
     'enable_sources': None,
     'enforce_object_list': None,
     'max_tokens': '1024',
     'object_list': '[{"owner":"SH"}]',
     'object_list_mode': None,
     'provider': OCIGenAIProvider(embedding_model=None,
                                  model=None,
                                  provider_name='oci',
                                  provider_endpoint=None,
                                  region='us-chicago-1',
                                  oci_apiformat='GENERIC',
                                  oci_compartment_id=None,
                                  oci_endpoint_id=None,
                                  oci_runtimetype=None),
     'seed': None,
     'stop_tokens': None,
     'streaming': None,
     'temperature': None,
     'vector_index_name': None}


.. latex:clearpage::

**************************
Narrate
**************************

.. literalinclude:: ../../../samples/profile_narrate.py
   :language: python
   :lines: 14-

output::

    There are 503 promotions in the database.


.. latex:clearpage::

**************************
Show SQL
**************************

.. literalinclude:: ../../../samples/profile_show_sql.py
   :language: python
   :lines: 14-

output::

    SELECT
    COUNT("p"."PROMO_ID") AS "Number of Promotions"
    FROM "SH"."PROMOTIONS" "p"

.. latex:clearpage::

**************************
Run SQL
**************************

.. literalinclude:: ../../../samples/profile_run_sql.py
   :language: python
   :lines: 14-

output::

    Index(['Number of Promotions'], dtype='object')
        Number of Promotions
    0                    503


.. latex:clearpage::

**************************
Chat
**************************

.. literalinclude:: ../../../samples/profile_chat.py
   :language: python
   :lines: 14-

output::

    OCI stands for Oracle Cloud Infrastructure. It is a comprehensive cloud computing platform provided by Oracle Corporation that offers a wide range of services for computing, storage, networking, database, and more.
    ...
    ...
    OCI competes with other major cloud providers, including Amazon Web Services (AWS), Microsoft Azure, Google Cloud Platform (GCP), and IBM Cloud.

.. latex:clearpage::

**************************
Summarize
**************************

.. literalinclude:: ../../../samples/profile_summarize_content.py
   :language: python
   :lines: 14-

output::

    A gas cloud in the Sagittarius B2 galaxy contains a large amount of alcohol,
    while some stars are cool enough to touch without being burned. The exoplanet
    55 Cancri e has a unique form of "hot ice" where water remains solid despite
    high temperatures due to high pressure. Ancient stars in the Milky Way's halo
    are older than the Sun, providing insights into the early universe and its composition,
    offering clues about the universe's formation and evolution.

.. latex:clearpage::


.. literalinclude:: ../../../samples/profile_summarize_uri.py
   :language: python
   :lines: 14-

output::

    Astronomy is a natural science that studies celestial objects and phenomena,
    using mathematics, physics, and chemistry to explain their origin and evolution.
    The field has a long history, with early civilizations making methodical
    observations of the night sky, and has since split into observational and
    theoretical branches. Observational astronomy focuses on acquiring data
    from observations, while theoretical astronomy develops computer or
    analytical models to describe astronomical objects and phenomena. The study
    of astronomy has led to numerous discoveries, including the existence of
    galaxies, the expansion of the universe, and the detection of gravitational
    waves. Astronomers use various methods, such as radio, infrared, optical,
    ultraviolet, X-ray, and gamma-ray astronomy, to study objects and events in
    the universe. The field has also led to the development of new technologies and
    has inspired new areas of research, such as astrobiology and the search for
    extraterrestrial life. Overall, astronomy is a dynamic and constantly evolving
    field that seeks to understand the universe and its many mysteries.

.. latex:clearpage::

**************************
List profiles
**************************

.. literalinclude:: ../../../samples/profiles_list.py
   :language: python
   :lines: 14-


output::

    ASYNC_OCI_AI_PROFILE
    OCI_VECTOR_AI_PROFILE
    ASYNC_OCI_VECTOR_AI_PROFILE
    OCI_AI_PROFILE

.. latex:clearpage::

*************
Async Profile
*************

.. toctree::
    :numbered:
    :maxdepth: 3

    async_profile.rst