Key-Values

class datarobot.models.key_values.KeyValue

Bases: APIObject

A DataRobot Key-Value.

Added in version v3.4.

Variables:

  • id (str) – ID of the Key-Value

  • created_at (str) – creation time of the Key-Value

  • entity_id (str) – ID of the related Entity

  • entity_type (KeyValueEntityType) – type of the related Entity

  • name (str) – Key-Value name

  • value (str) – Key-Value value

  • numeric_value (float) – Key-Value numeric value

  • boolean_value (bool) – Key-Value boolean value

  • value_type (KeyValueType) – Key-Value type

  • description (str) – Key-Value description

  • creator_id (str) – ID of the user who created the Key-Value

  • creator_name (str) – ID of the user who created the Key-Value

  • category (KeyValueCategory) – Key-Value category

  • artifact_size (int) – size in bytes of associated image, if applicable

  • original_file_name (str) – name of uploaded original image or dataset file

  • is_editable (bool) – true if a user with permissions can edit or delete

  • is_dataset_missing (bool) – true if the key-value type is “dataset” and its dataset is not visible to the user

  • error_message (str) – additional information if “isDataSetMissing” is true. Blank if there are no errors

classmethod get(key_value_id)

Get Key-Value by id.

Added in version v3.4.

Parameters:

key_value_id (str) – ID of the Key-Value

Returns:

retrieved Key-Value

Return type:

KeyValue

Raises:
classmethod list(entity_id, entity_type)

List Key-Values.

Added in version v3.4.

Parameters:

  • entity_id (str) – ID of the related Entity

  • entity_type (KeyValueEntityType) – type of the related Entity

Returns:

a list of Key-Values

Return type:

List[KeyValue]

Raises:
classmethod find(entity_id, entity_type, name)

Find Key-Value by name.

Added in version v3.4.

Parameters:

  • entity_id (str) – ID of the related Entity

  • entity_type (KeyValueEntityType) – type of the related Entity

  • name (str) – name of the Key-Value

Returns:

a list of Key-Values

Return type:

List[KeyValue]

Raises:
classmethod create(entity_id, entity_type, name, category, value_type, value=None, description=None)

Create a Key-Value.

Added in version v3.4.

Parameters:

  • entity_id (str) – ID of the associated resource

  • entity_type (KeyValueEntityType) – type of the associated resource

  • name (str) – name of the Key-Value. Cannot contain: { } ; |

  • category (KeyValueCategory) – category of the Key-Value

  • value_type (KeyValueType) – type of the Key-Value value

  • value (Optional[Union[str, float, bool]]) – value of Key-Value

  • description (Optional[str]) – description of the Key-Value

Returns:

created Key-Value

Return type:

KeyValue

Raises:
update(entity_id=None, entity_type=None, name=None, category=None, value_type=None, value=None, description=None, comment=None)

Update Key-Value.

Added in version v3.4.

Parameters:

  • entity_id (Optional[str]) – ID of the associated resource

  • entity_type (Optional[KeyValueEntityType]) – type of the associated resource

  • name (Optional[str]) – name of the Key-Value. Cannot contain: { } ; |

  • category (Optional[KeyValueCategory]) – category of the Key-Value

  • value_type (Optional[KeyValueType]) – type of the Key-Value value

  • value (Optional[[Union[str, float, bool]]) – value of Key-Value

  • description (Optional[str]) – description of the Key-Value

  • comment (Optional[str]) – user comment explaining the change

Raises:
Return type:

None

refresh()

Update Key-Value with the latest data from server. :rtype: None

Added in version v3.4.

Raises:
delete()

Delete Key-Value. :rtype: None

Added in version v3.4.

Raises:
get_value()

Get a value of Key-Value.

Added in version v3.4.

Returns:

value depending on the value type

Return type:

Union[str, float, boolean]

class datarobot.enums.KeyValueCategory

Bases: Enum

Key-Value category

TRAINING_PARAMETER = 'trainingParameter'
METRIC = 'metric'
TAG = 'tag'
ARTIFACT = 'artifact'
RUNTIME_PARAMETER = 'runtimeParameter'
class datarobot.enums.KeyValueEntityType

Bases: Enum

Key-Value entity type

DEPLOYMENT = 'deployment'
MODEL_PACKAGE = 'modelPackage'
REGISTERED_MODEL = 'registeredModel'
CUSTOM_JOB = 'customJob'
CUSTOM_JOB_RUN = 'customJobRun'
class datarobot.enums.KeyValueType

Bases: Enum

Key-Value type

BINARY = 'binary'
BOOLEAN = 'boolean'
CREDENTIAL = 'credential'
DEPLOYMENT_ID = 'deploymentId'
DATASET = 'dataset'
IMAGE = 'image'
JSON = 'json'
MODEL_VERSION = 'modelVersion'
NUMERIC = 'numeric'
PICKLE = 'pickle'
STRING = 'string'
URL = 'url'
YAML = 'yaml'