abacusai.natural_language_explanation
=====================================

.. py:module:: abacusai.natural_language_explanation


Classes
-------

.. autoapisummary::

   abacusai.natural_language_explanation.NaturalLanguageExplanation


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

.. py:class:: NaturalLanguageExplanation(client, shortExplanation=None, longExplanation=None, isOutdated=None, htmlExplanation=None)

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


   Natural language explanation of an artifact/object

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param shortExplanation: succinct explanation of the artifact
   :type shortExplanation: str
   :param longExplanation: Longer and verbose explanation of the artifact
   :type longExplanation: str
   :param isOutdated: Flag indicating whether the explanation is outdated due to a change in the underlying artifact
   :type isOutdated: bool
   :param htmlExplanation: HTML formatted explanation of the artifact
   :type htmlExplanation: str


   .. py:attribute:: short_explanation
      :value: None



   .. py:attribute:: long_explanation
      :value: None



   .. py:attribute:: is_outdated
      :value: None



   .. py:attribute:: html_explanation
      :value: None



   .. py:attribute:: deprecated_keys


   .. py:method:: __repr__()


   .. 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