Manage AI Usecase Asset

create_ai_usecase(self, catalog_id: str = None, name: str = None, description: str = None, status: str = None, risk: str = None, tags: list = None) → AIUsecaseUtilities

Returns AI usecase

Parameters:

• catalog_id (str) – Catalog ID where this model usecase needs to create.

• name (str) – Name of model usecase

• description (str) – (Optional) Model usecase description

• status (str) – (Optional) AI Usecase status.Available options are in Status

• risk (str) – (Optional) AI Usecase risk.Available options are in Risk

• tags (list) – (Optional) AI usecase tags. Provide list of tags, for example [“usecase for prod”,”model for prod”]

Return type:

AIUsecaseUtilities

Returns:

AI usecase asset

Example:

>>> client.assets.create_ai_usecase(catalog_id=<catalog_id>,name=<AI usecase name>,description=<AI usecase description>)

get_ai_usecase(self, ai_usecase_id: str, catalog_id: str = None) → AIUsecaseUtilities

Get AI usecase asset.

Parameters:

• ai_usecase_id (str) – Id of the ai usecase.

• catalog_id (str) – Id of the catalog where ai usecase is saved.

Return type:

AIUsecaseUtilities

The way to use me is:

>>> client.assets.get_ai_usecase(ai_usecase_id=<ai usecase id>, catalog_id=<catalog id>)

get_ai_usecases(self, catalog_id: str = None) → list

Returns AI usecase assets

Parameters:

catalog_id (str) – (Optional) Catalog ID where AI usecase are registered. if not provided, dafault shows all AI usecases in all catalogs across all accounts to which the user has access.

Return type:

list(AIUsecaseUtilities)

Returns:

All AI usecase assets for a catalog

Example:

>>> client.assets.get_ai_usecases(catalog_id=<catalog_id>)
>>> client.assets.get_ai_usecases()

create_model_usecase(self, catalog_id: str = None, name: str = None, description: str = None) → ModelUsecaseUtilities

Warning

ibm_aigov_facts_client.factsheet.assets.Assets.create_model_usecase is deprecated. This method will be removed in a future release.It is due to new generalized method available to cover models and prompts. Use client.assets.create_ai_usecase() instead.

Returns WKC Model usecase

Parameters:

• catalog_id (str) – Catalog ID where this model usecase needs to create.

• name (str) – Name of model usecase

• description (str) – (Optional) Model usecase description

Return type:

ModelUsecaseUtilities

Returns:

WKC Model usecase asset

Example:

>>> client.assets.create_model_usecase(catalog_id=<catalog_id>,name=<model usecase name>,description=<model usecase description>)

get_model_usecase(self, model_usecase_id: str, catalog_id: str = None) → ModelUsecaseUtilities

Warning

ibm_aigov_facts_client.factsheet.assets.Assets.get_model_usecase is deprecated. This method will be removed in a future release.It is due to new generalized method available to cover models and prompts. Use client.assets.get_ai_usecase() instead.

Get model usecase asset.

Parameters:

• model_usecase_id (str) – Id of the model usecase.

• catalog_id (str) – Id of the catalog where model usecase is saved.

Return type:

ModelUsecaseUtilities

The way to use me is:

>>> client.assets.get_model_usecase(model_usecase_id=<model usecase id>, catalog_id=<catalog id>)

get_model_usecases(self, catalog_id: str = None) → list

Warning

ibm_aigov_facts_client.factsheet.assets.Assets.get_model_usecases is deprecated. This method will be removed in a future release.It is due to new generalized method available to cover models and prompts. Use client.assets.get_ai_usecases() instead.

Returns WKC Model usecase assets

Parameters:

catalog_id (str) – (Optional) Catalog ID where model usecase are registered. if not provided, dafault shows all model usecases in all catalogs across all accounts to which the user has access.

Return type:

list(ModelUsecaseUtilities)

Returns:

All WKC Model usecase assets for a catalog

Example:

>>> client.assets.get_model_usecases(catalog_id=<catalog_id>)
>>> client.assets.get_model_usecases()

list_model_usecases(self, catalog_id: str = None) → list

Warning

ibm_aigov_facts_client.factsheet.assets.Assets.list_model_usecases is deprecated. This method will be removed in a future release.Use client.assets.get_model_usecases() instead.

Returns WKC Model usecase assets

Parameters:

catalog_id (str) – Catalog ID where registered model usecase. if not provided, dafault shows all model usecases in all catalogs across all accounts to which the user has access.

Returns:

All WKC Model usecase assets for a catalog

Return type:

list

Example:

>>> client.assets.list_model_usecases(catalog_id=<catalog_id>)
>>> client.assets.list_model_usecases()