Method
setNaturalLanguageExplanation POST
Copy POST

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

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes shortExplanation str succinct explanation of the artifact with given ID
Yes longExplanation str verbose explanation of the artifact with given ID
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

Exceptions:

TYPE WHEN
DataNotFoundError

featureGroupId is not found.

DataNotFoundError

modelId is not found.

Language: