:py:mod:`abacusai.api_class.document_retriever`
===============================================

.. py:module:: abacusai.api_class.document_retriever


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   abacusai.api_class.document_retriever.VectorStoreConfig
   abacusai.api_class.document_retriever.DocumentRetrieverConfig




.. py:class:: VectorStoreConfig


   Bases: :py:obj:`abacusai.api_class.abstract.ApiClass`

   Configs for vector store indexing.

   :param chunk_size: The size of text chunks in the vector store.
   :type chunk_size: int
   :param chunk_overlap_fraction: The fraction of overlap between chunks.
   :type chunk_overlap_fraction: float
   :param text_encoder: Encoder used to index texts from the documents.
   :type text_encoder: VectorStoreTextEncoder
   :param chunk_size_factors: Chunking data with multiple sizes. The specified list of factors are used to calculate more sizes, in addition to `chunk_size`.
   :type chunk_size_factors: list

   .. py:attribute:: chunk_size
      :type: int

      

   .. py:attribute:: chunk_overlap_fraction
      :type: float

      

   .. py:attribute:: text_encoder
      :type: abacusai.api_class.enums.VectorStoreTextEncoder

      

   .. py:attribute:: chunk_size_factors
      :type: list

      


.. py:class:: DocumentRetrieverConfig


   Bases: :py:obj:`VectorStoreConfig`

   Configs for document retriever.


