Pipelines reference
===================

Models
------

Tables
^^^^^^

- :ref:`aidb.model_providers <aidb.model_providers>` 

- :ref:`aidb.models <aidb.models>` 

Model functions
^^^^^^^^^^^^^^^

- :ref:`aidb.create_model <aidb.create_model>` 

- :ref:`aidb.get_model <aidb.get_model>` 

- :ref:`aidb.delete_model <aidb.delete_model>` 

- :ref:`aidb.list_hcp_models <aidb.list_hcp_models>` 

- :ref:`aidb.create_hcp_model <aidb.create_hcp_model>` 

- :ref:`aidb.sync_hcp_models <aidb.sync_hcp_models>` 

- :ref:`aidb.encode_text <aidb.encode_text>` 

- :ref:`aidb.encode_text_batch <aidb.encode_text_batch>` 

- :ref:`aidb.decode_text <aidb.decode_text>` 

- :ref:`aidb.decode_text_batch <aidb.decode_text_batch>` 

- :ref:`aidb.encode_image <aidb.encode_image>` 

- :ref:`aidb.rerank_text <aidb.rerank_text>` 

Preparers
---------

Preparer views
^^^^^^^^^^^^^^

- :ref:`aidb.preps <Pipelines reference - Preparers>` 

- :ref:`aidb.preparers <aidb.preparers>` 

Preparer types
^^^^^^^^^^^^^^

- :ref:`aidb.DataPreparationOperation <aidb.DataPreparationOperation>` 

Preparer functions
^^^^^^^^^^^^^^^^^^

- :ref:`aidb.create_table_preparer <aidb.create_table_preparer>` 

- :ref:``aidb.create_preparer_for_table`  (deprecated) <`aidb.create_preparer_for_table`  (deprecated)>`  (deprecated)

- :ref:`aidb.create_volume_preparer <aidb.create_volume_preparer>` 

- :ref:``aidb.create_preparer_for_volume`  (deprecated) <`aidb.create_preparer_for_volume`  (deprecated)>`  (deprecated)

- :ref:`aidb.bulk_data_preparation <aidb.bulk_data_preparation>` 

- :ref:`aidb.set_auto_preparer <aidb.set_auto_preparer>` 

- :ref:``aidb.set_preparer_auto_processing`  (deprecated) <`aidb.set_preparer_auto_processing`  (deprecated)>`  (deprecated)

- :ref:`aidb.delete_preparer <aidb.delete_preparer>` 

Knowledge bases
---------------

Knowledge base tables
^^^^^^^^^^^^^^^^^^^^^

- :ref:`aidb.kbs <Pipelines knowledge bases reference>` 

- :ref:`aidb.knowledge_bases <aidb.knowledge_bases>` 

Knowledge base functions
^^^^^^^^^^^^^^^^^^^^^^^^

- :ref:`aidb.create_table_knowledge_base <aidb.create_table_knowledge_base>` 

- :ref:`aidb.create_volume_knowledge_base <aidb.create_volume_knowledge_base>` 

- :ref:`aidb.set_auto_knowledge_base <aidb.set_auto_knowledge_base>` 

- :ref:`aidb.bulk_embedding <aidb.bulk_embedding>` 

- :ref:`aidb.retrieve_key <aidb.retrieve_key>` 

- :ref:`aidb.retrieve_text <aidb.retrieve_text>` 

- :ref:``aidb.delete_knowledge_base` <`aidb.delete_knowledge_base`>` 

- :ref:`aidb.create_volume_knowledge_base <aidb.create_volume_knowledge_base>` 

- :ref:`aidb.delete_volume <aidb.delete_volume>` 

PGFS
----

PGFS functions
^^^^^^^^^^^^^^

- :ref:`pgfs.create_foreign_table <pgfs.create_foreign_table>` 

- :ref:`pgfs.create_storage_location <pgfs.create_storage_location>` 

- :ref:`pgfs.create_storage_location_with_foreign_table <pgfs.create_storage_location_with_foreign_table>` 

- :ref:`pgfs.delete_storage_location <pgfs.delete_storage_location>` 

- :ref:`pgfs.list_storage_locations <pgfs.list_storage_locations>` 

- :ref:`pgfs.get_storage_location <pgfs.get_storage_location>` 

- :ref:`pgfs.update_storage_location <pgfs.update_storage_location>` 

- :ref:`pgfs.set_default_storage_location <pgfs.set_default_storage_location>` 

- :ref:`pgfs.get_default_storage_location <pgfs.get_default_storage_location>` 

Retrievers (deprecated)
-----------------------

Retrievers functions (deprecated)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- :ref:``aidb.create_retriever_for_table`  (deprecated) <`aidb.create_retriever_for_table`  (deprecated)>`  (deprecated)

- :ref:``aidb.create_retriever_for_volume`  (deprecated) <`aidb.create_retriever_for_volume`  (deprecated)>`  (deprecated)

- :ref:``aidb.set_retriever_auto_processing`  (deprecated) <`aidb.set_retriever_auto_processing`  (deprecated)>`  (deprecated)

- :ref:``aidb.delete_retriever`  (deprecated) <`aidb.delete_retriever`  (deprecated)>`  (deprecated)

.. toctree::
  :maxdepth: 3

  Usage--pipeline--Reference--models
  Usage--pipeline--Reference--preparers
  Usage--pipeline--Reference--knowledge_bases
  Usage--pipeline--Reference--pgfs
  Usage--pipeline--Reference--retrievers