Method
getNaturalLanguageExplanation GET
Copy GET

Returns the saved natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model

Arguments:

REQUIRED KEY TYPE DESCRIPTION
No featureGroupId str A unique string identifier associated with the Feature Group.
No featureGroupVersion str A unique string identifier associated with the Feature Group Version.
No modelId str A unique string identifier associated with the Model.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result NaturalLanguageExplanation
KEY TYPE Description
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

Exceptions:

TYPE WHEN
DataNotFoundError

featureGroupId is not found.
DataNotFoundError

modelId is not found.
Language:

© Copyright