Semantic Model

Warning

The functions are not fully tested yet. Use with caution. Please report any issues to the GitHub repository.

semantic_model_create

semantic_model_create(workspace_id: str, display_name: str, semantic_model_path: str, description: str = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Create a semantic model.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to create the semantic model in.	required
display_name	str	The display name of the semantic model.	required
semantic_model_path	str	The path to the semantic model to load content from.	required
description	str | None	The description of the semantic model.	None
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

semantic_model_get

semantic_model_get(workspace_id: str, semantic_model_id: str, preview: bool = True) -> requests.Response

Get a semantic model.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to get the semantic model from.	required
semantic_model_id	str	The id of the semantic model to get.	required
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

semantic_model_list

semantic_model_list(workspace_id: str, continuation_token: str = None, preview: bool = True) -> requests.Response

List semantic models for a workspace.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to list semantic models for.	required
continuation_token	str | None	A token for retrieving the next page of results.	None
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

semantic_model_update

semantic_model_update(workspace_id: str, semantic_model_id: str, display_name: str = None, description: str = None, preview: bool = True) -> requests.Response

Update a semantic model.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update.	required
semantic_model_id	str	The id of the semantic model to update.	required
display_name	str | None	The display name of the semantic model.	None
description	str | None	The description of the semantic model.	None
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

semantic_model_delete

semantic_model_delete(workspace_id: str, semantic_model_id: str, preview: bool = True) -> requests.Response

Delete a semantic model.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to delete.	required
semantic_model_id	str	The id of the semantic model to delete.	required
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

semantic_model_get_definition

semantic_model_get_definition(workspace_id: str, semantic_model_id: str, format: str = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Get the definition of a semantic model.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to get the semantic model definition from.	required
semantic_model_id	str	The id of the semantic model to get the definition from.	required
format	str | None	The format of the semantic model definition. Supported format is "ipynb".	None
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

semantic_model_update_definition

semantic_model_update_definition(workspace_id: str, semantic_model_id: str, semantic_model_path: str, update_metadata: bool = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Update the definition of a semantic model.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update.	required
semantic_model_id	str	The id of the semantic model to update.	required
semantic_model_path	str	The path to the semantic model to load content from.	required
update_metadata	bool | None	When set to true, the item's metadata is updated using the metadata in the .platform file.	None
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.