Catalog Collections¶

For usage information and examples, see Catalog Collections

class dataikuapi.dss.data_collection.DSSDataCollection(client, id)¶

A handle to interact with a Catalog Collection on the DSS instance.

This class is also exposed as DSSCatalogCollection.

Do not create this class directly instead use dataikuapi.DSSClient.get_collection(), or DSSDataCollectionListItem.to_collection().

get_settings()¶

Gets the settings of this Catalog Collection.

Returns:: a handle to read, modify and save the settings
Return type:: DSSCatalogCollectionSettings

list_objects(as_type='objects', filter_type=None)¶

List the objects in this Catalog Collection

Parameters:

as_type (str) – How to return the list. Supported values are “objects” and “dict” (defaults to objects).
filter_type (str) – Which elements to return in the list. Supported values are “DATASET”, “SAVED_MODEL”, “AGENT”, “FINE_TUNED_MODEL”, “AGENT_TOOL”, “SEMANTIC_MODEL”. If set to None or unset, no filtering is applied (defaults to None).

Returns:

The list of objects

Return type:

list of DSSCatalogCollectionItem if as_type is “objects”, list of dict if as_type is “dict”

add_object(obj)¶

Add an object to this Catalog Collection.

Parameters:: obj (DSSDataset, DSSDataCollectionItem or dict) – object to add to the Catalog Collection.

delete()¶

Delete this Catalog Collection

This call requires Administrator rights on the Catalog Collection.

class dataikuapi.dss.data_collection.DSSDataCollectionListItem(client, data)¶

An item in a list of Catalog Collections.

This class is also exposed as DSSCatalogCollectionListItem.

Do not instantiate this class, use dataikuapi.DSSClient.list_collections().

get_raw()¶

Get the raw representation of this DSSDataCollectionListItem

Return type:: dict

property id¶

property display_name¶

property description¶

property color¶

property tags¶

property item_count¶

property last_modified_on¶

to_data_collection()¶

Gets the DSSCatalogCollection corresponding to this list item.

Returns:: handle of the Catalog Collection
Return type:: DSSCatalogCollection

to_collection()¶

Gets the DSSCatalogCollection corresponding to this list item.

This is an alias for to_data_collection().

Returns:: handle of the Catalog Collection
Return type:: DSSCatalogCollection

class dataikuapi.dss.data_collection.DSSDataCollectionSettings(data_collection, settings)¶

A handle on the settings of a Catalog Collection

This class is also exposed as DSSCatalogCollectionSettings.

Do not create this class directly, instead use DSSDataCollection.get_settings()

get_raw()¶

Get the raw settings of the Catalog Collection. This returns a reference to the raw settings, not a copy, so changes made to the returned object will be reflected when saving.

Returns:: the Catalog Collection raw settings
Return type:: dict

property id¶

The Catalog Collection id (read-only)

Return type:: str

property display_name¶

Get or set the name of the Catalog Collection

Return type:: str

property color¶

Get or set the background color of the Catalog Collection (using #RRGGBB syntax)

Return type:: str

property description¶

Get or set the description of the Catalog Collection

Return type:: str

property tags¶

Get or set the tags of the Catalog Collection

Return type:: list of str

property permissions¶

Get or set the permissions controlling who is a reader, contributor or admin of the Catalog Collection.

If the user is not an admin of the data collection, the permissions property will be redacted as None.

Returns:: a list of the Catalog Collection permissions
Return type:: list of dict or None

save()¶

Save the changes made on the settings

This call requires Administrator rights on the Catalog Collection.

class dataikuapi.dss.data_collection.DSSDataCollectionPermissionItem¶

Helper constructors for Catalog Collection permission entries.

This class is also exposed as DSSCatalogCollectionPermissionItem.

classmethod admin_group(group)¶: Creates a dict representing an admin authorization for a group

classmethod contributor_group(group)¶: Creates a dict representing an contributor authorization for a group

classmethod reader_group(group)¶: Creates a dict representing an reader authorization for a group

classmethod admin_user(user)¶: Creates a dict representing an admin authorization for a user

classmethod contributor_user(user)¶: Creates a dict representing an contributor authorization for a user

classmethod reader_user(user)¶: Creates a dict representing an reader authorization for a user

class dataikuapi.dss.data_collection.DSSDataCollectionItem(data_collection, data)¶

A handle on an object inside a Catalog Collection

This class is also exposed as DSSCatalogCollectionItem.

Do not create this class directly, instead use DSSDataCollection.list_objects()

get_raw()¶

Get the raw description of the Catalog Collection item. This returns a reference to the raw data, not a copy.

Returns:: the Catalog Collection item raw description
Return type:: dict

get_as_dataset()¶

Gets a handle on the corresponding dataset.

Attention

The usability of this handle might be limited by the current user’s authorizations, as seeing a dataset in a collection doesn’t necessarily imply a lot of rights.

Returns:: a handle on a dataset
Return type:: dataikuapi.dss.dataset.DSSDataset

get_as_saved_model()¶

Gets a handle on the corresponding saved model or fine-tuned model.

Attention

The usability of this handle might be limited by the current user’s authorizations, as seeing a saved model in a collection doesn’t necessarily imply a lot of rights.

Returns:: a handle on a saved model
Return type:: dataikuapi.dss.savedmodel.DSSSavedModel

get_as_agent()¶

Gets a handle on the corresponding agent.

Attention

The usability of this handle might be limited by the current user’s authorizations, as seeing an agent in a collection doesn’t necessarily imply a lot of rights.

Returns:: a handle on an agent
Return type:: dataikuapi.dss.agent.DSSAgent

get_as_agent_tool()¶

Gets a handle on the corresponding agent tool.

Attention

The usability of this handle might be limited by the current user’s authorizations, as seeing an agent tool in a collection doesn’t necessarily imply a lot of rights.

Returns:: a handle on an agent tool
Return type:: dataikuapi.dss.agent_tool.DSSAgentTool

get_as_semantic_model()¶

Gets a handle on the corresponding semantic model.

Attention

The usability of this handle might be limited by the current user’s authorizations, as seeing a semantic model in a collection doesn’t necessarily imply a lot of rights.

Returns:: a handle on an agent tool
Return type:: dataikuapi.dss.semantic_model.DSSSemanticModel

remove()¶

Remove this object from the Catalog Collection

This call requires Contributor rights on the Catalog Collection.