:py:mod:`abacusai.vector_store_version`
=======================================

.. py:module:: abacusai.vector_store_version


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

Classes
~~~~~~~

.. autoapisummary::

   abacusai.vector_store_version.VectorStoreVersion




.. py:class:: VectorStoreVersion(client, vectorStoreId=None, vectorStoreVersion=None, createdAt=None, status=None, featureGroupVersion=None)


   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`

   A version of vector store.

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param vectorStoreId: The unique identifier of the vector store.
   :type vectorStoreId: str
   :param vectorStoreVersion: The unique identifier of the vector store version.
   :type vectorStoreVersion: str
   :param createdAt: When the vector store was created.
   :type createdAt: str
   :param status: The status of creating vector store version.
   :type status: str
   :param featureGroupVersion: The unique identifier of the feature group version at which the vector store version is created.
   :type featureGroupVersion: str

   .. py:method:: __repr__()

      Return repr(self).


   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict


   .. py:method:: wait_for_results(timeout=3600)

      A waiting call until vector store version indexing and deployment is complete.

      :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out.
      :type timeout: int, optional


   .. py:method:: wait_until_ready(timeout=3600)

      A waiting call until the vector store version is ready.

      :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out.
      :type timeout: int, optional


   .. py:method:: get_status()

      Gets the status of the vector store version.

      :returns: A string describing the status of a vector store version (pending, complete, etc.).
      :rtype: str



