Associate Workspaces

Associate workspaces is employed to associate AI use cases with the appropriate workspaces, ensuring they are organized around the same business problem. This involves setting up workspaces that will be used throughout the development process to tackle the business problem or implement the use case smoothly.

add_workspaces_associations(self, workspace_id: str = None, workspace_type: str = None, phase_name: str = None)

Associate a workspace to a particular AI usecase under a specified phase.

Parameters:

workspace_id (str) – Project ID or space ID which needs to be associated with the selected usecase.
workspace_type (str) – Should be “project” when passing a project ID as workspace_id. If a space ID is passed for workspace_id, the workspace_type will be “space”.
phase_name (str) – Phase name, should be one of ‘develop’, ‘validate’, or ‘operate’. Available options are in Phases.

Returns:

None

Example:

client.assets.ai_usecase.add_workspaces_associations(workspace_id='<project or space id>', workspace_type='<"project" or "space">', phase_name='<valid phase name>')

list_all_associated_workspaces(self) → None

Lists all associated workspaces for a given AI usecase in tabular format. The method will display the associated workspaces for all the phases.

Returns:: None

Example:

client.assets.ai_usecase.list_all_associated_workspaces()

list_associated_workspaces_by_phase(self, phase_name: Phases = None) → None

Lists all associated workspaces for a given AI usecase in tabular format. The method will display the filtered associated workspaces, filtered by the phase name passed.

Parameters:: phase_name (str) – Phase name. Available options are in Phases
Returns:: None

Example:

client.assets.ai_usecase.list_associated_workspaces_by_phase(phase_name='<valid phase name>')

remove_workspace_associations(self, workspace_ids: list = None) → None

Removes association of one or more workspaces at once from a particular AI usecase, irrespective of the phase they are in. The disassociation works only if there are no tracked assets in the workspace(s) to be removed. User should have edit access to the usecase.

Parameters:: workspace_ids (list) – List of workspace IDs to be disassociated. For example: workspace_ids=[project_id_1, space_id_1].
Returns:: None

Example:

client.assets.model_usecase.remove_workspace_associations(workspace_ids=[<project id>, <space id>])