abacusai.natural_language_explanation — AbacusAI documentation

# abacusai.natural_language_explanation

## Classes

`AbstractApiClass` |
`NaturalLanguageExplanation` | Natural language explanation of an artifact/object

## Module Contents

class abacusai.natural_language_explanation.AbstractApiClass(client, id)
  __eq__(other)

    Return self==value.

  _get_attribute_as_dict(attribute)

class abacusai.natural_language_explanation.NaturalLanguageExplanation(client, shortExplanation=None, longExplanation=None, isOutdated=None, htmlExplanation=None)

  Bases: `abacusai.return_class.AbstractApiClass`

  Natural language explanation of an artifact/object

  Parameters:

    - client (ApiClient) – An authenticated API Client instance

    - shortExplanation (str) – succinct explanation of the artifact

    - longExplanation (str) – Longer and verbose explanation of the artifact

    - isOutdated (bool) – Flag indicating whether the explanation is outdated due to a change in the underlying artifact

    - htmlExplanation (str) – HTML formatted explanation of the artifact

  __repr__()

    Return repr(self).

  to_dict()

    Get a dict representation of the parameters in this class

    Returns:

      The dict value representation of the class parameters

    Return type:

      dict