Encoders
========

.. autoclass:: flexrag.models.EncoderBase
    :members:
    :inherited-members:

.. autoclass:: flexrag.models.EncoderConfig
    :members:
    :inherited-members:


Local Encoders
--------------

.. Huggingface Encoders
.. autoclass:: flexrag.models.HFEncoderConfig
    :members:
    :inherited-members:

.. autoclass:: flexrag.models.HFEncoder
    :members:
    :show-inheritance:
    :exclude-members: async_encode, encode


.. Huggingface Clip Encoders
.. autoclass:: flexrag.models.HFClipEncoderConfig
    :members:
    :inherited-members:

.. autoclass:: flexrag.models.HFClipEncoder
    :members:
    :show-inheritance:
    :exclude-members: async_encode, encode


.. Ollama Encoders
.. autoclass:: flexrag.models.OllamaEncoderConfig
    :members:
    :inherited-members:

.. autoclass:: flexrag.models.OllamaEncoder
    :members:
    :show-inheritance:
    :exclude-members: async_encode, encode


.. Sentence Transformers Encoders
.. autoclass:: flexrag.models.SentenceTransformerEncoderConfig
    :members:
    :inherited-members:

.. autoclass:: flexrag.models.SentenceTransformerEncoder
    :members:
    :show-inheritance:
    :exclude-members: async_encode, encode


Oneline Encoders
----------------

.. Coherence Encoders
.. autoclass:: flexrag.models.CohereEncoderConfig
    :members:
    :inherited-members:

.. autoclass:: flexrag.models.CohereEncoder
    :members:
    :show-inheritance:
    :exclude-members: async_encode, encode


.. JinaAI Encoders
.. autoclass:: flexrag.models.JinaEncoderConfig
    :members:
    :inherited-members:

.. autoclass:: flexrag.models.JinaEncoder
    :members:
    :show-inheritance:
    :exclude-members: async_encode, encode


.. OpenAI Encoders
.. autoclass:: flexrag.models.OpenAIEncoderConfig
    :members:
    :show-inheritance:
    :inherited-members:

.. autoclass:: flexrag.models.OpenAIEncoder
    :members:
    :show-inheritance:
    :exclude-members: async_encode, encode
