Embeddings
==========

Embeddings
----------
.. autoclass:: ibm_watsonx_ai.foundation_models.embeddings.Embeddings
    :members:
    :exclude-members:
    :undoc-members:
    :show-inheritance:

BaseEmbeddings
--------------

.. autoclass:: ibm_watsonx_ai.foundation_models.embeddings.base_embeddings.BaseEmbeddings
    :members:
    :exclude-members:
    :undoc-members:
    :show-inheritance:

Enums
-----

.. autoclass:: metanames.EmbedTextParamsMetaNames
    :members:

.. class:: EmbeddingModels

    Bases: ``StrEnum``

    This represents a dynamically generated Enum for Embedding Models.

    **Example of getting EmbeddingModels**

    .. code-block:: python

        # GET EmbeddingModels ENUM
        client.foundation_models.EmbeddingModels

        # PRINT dict of Enums
        client.foundation_models.EmbeddingModels.show()


    **Example Output:**

    .. code-block::

        {'SLATE_125M_ENGLISH_RTRVR': 'ibm/slate-125m-english-rtrvr',
        ...
        'SLATE_30M_ENGLISH_RTRVR': 'ibm/slate-30m-english-rtrvr'}

    **Example of initialising Embeddings with EmbeddingModels Enum:**

    .. code-block:: python

        from ibm_watsonx_ai.foundation_models import Embeddings

        embeddings = Embeddings(
            model_id=client.foundation_models.EmbeddingModels.SLATE_30M_ENGLISH_RTRVR,
            credentials=Credentials(...),
            project_id=project_id,
        )

.. autoclass:: ibm_watsonx_ai.foundation_models.utils.enums.EmbeddingTypes
    :members:
    :show-inheritance: