.. _autoai_rag_parameters:

AutoAI RAG Parameter Scheme
===========================

Below, you can find enums and dataclasses that are useful for specifying more complex parameters.

For each dataclass you can call the following methods:

- ``get_sample_params()``

Example:

.. code-block:: python

    AutoAIRAGModelParams.get_sample_params()
    # {
    #     "decoding_method": "sample",
    #     "min_new_tokens": 5,
    #     "max_new_tokens": 300,
    #     "max_sequence_length": 4096,
    # }

- ``show()``

Example:

.. code-block:: python

    AutoAIRAGModelParams.show()
    # +---------------------+--------------------------------------+-----------------+
    # | PARAMETER           | TYPE                                 | EXAMPLE VALUE   |
    # +=====================+======================================+=================+
    # | decoding_method     | str, TextGenDecodingMethod, NoneType | sample          |
    # +---------------------+--------------------------------------+-----------------+
    # | min_new_tokens      | int, NoneType                        | 5               |
    # +---------------------+--------------------------------------+-----------------+
    # | max_new_tokens      | int, NoneType                        | 300             |
    # +---------------------+--------------------------------------+-----------------+
    # | max_sequence_length | int, NoneType                        | 4096            |
    # +---------------------+--------------------------------------+-----------------+

AutoAIRAGModelParams
--------------------

.. autoclass:: ibm_watsonx_ai.foundation_models.schema.AutoAIRAGModelParams
   :members:
   :exclude-members: get_sample_params
   :undoc-members:
   :show-inheritance:

AutoAIRAGModelConfig
--------------------

.. autoclass:: ibm_watsonx_ai.foundation_models.schema.AutoAIRAGModelConfig
   :members:
   :exclude-members: get_sample_params
   :undoc-members:
   :show-inheritance:

AutoAIRAGCustomModelConfig
--------------------------

.. autoclass:: ibm_watsonx_ai.foundation_models.schema.AutoAIRAGCustomModelConfig
   :members:
   :exclude-members: get_sample_params
   :undoc-members:
   :show-inheritance:

HybridRankerStrategy
--------------------

.. autoclass:: ibm_watsonx_ai.foundation_models.schema.HybridRankerStrategy
   :members:
   :exclude-members: get_sample_params
   :undoc-members:
   :show-inheritance:

AutoAIRAGHybridRankerParams
---------------------------

.. autoclass:: ibm_watsonx_ai.foundation_models.schema.AutoAIRAGHybridRankerParams
   :members:
   :exclude-members: get_sample_params
   :undoc-members:
   :show-inheritance:

AutoAIRAGRetrievalConfig
------------------------

.. autoclass:: ibm_watsonx_ai.foundation_models.schema.AutoAIRAGRetrievalConfig
   :members:
   :exclude-members: get_sample_params
   :undoc-members:
   :show-inheritance:

AutoAIRAGLanguageConfig
-----------------------

.. autoclass:: ibm_watsonx_ai.foundation_models.schema.AutoAIRAGLanguageConfig
   :members:
   :exclude-members: get_sample_params
   :undoc-members:
   :show-inheritance:

AutoAIRAGGenerationConfig
-------------------------

.. autoclass:: ibm_watsonx_ai.foundation_models.schema.AutoAIRAGGenerationConfig
   :members:
   :exclude-members: get_sample_params
   :undoc-members:
   :show-inheritance:

AutoAIRAGChatTemplateMessagesConfig
-----------------------------------

.. autoclass:: ibm_watsonx_ai.foundation_models.schema.AutoAIRAGChatTemplateMessagesConfig
   :members:
   :exclude-members: get_sample_params
   :undoc-members:
   :show-inheritance: