# Key-Values

> Key-Values

This Markdown file sits beside the HTML page at the same path (with a `.md` suffix). It summarizes the topic and lists links for tools and LLM context.

Companion generated at `2026-07-27T18:44:30.553589+00:00` (UTC).

## Primary page

- [Key-Values](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md): Full documentation for this topic (Markdown sidecar).

## Sections on this page

- [KeyValue](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.models.key_values.KeyValue): In-page section heading.
- [get()](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.models.key_values.KeyValue.get): In-page section heading.
- [list()](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.models.key_values.KeyValue.list): In-page section heading.
- [find()](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.models.key_values.KeyValue.find): In-page section heading.
- [create()](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.models.key_values.KeyValue.create): In-page section heading.
- [update()](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.models.key_values.KeyValue.update): In-page section heading.
- [refresh()](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.models.key_values.KeyValue.refresh): In-page section heading.
- [delete()](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.models.key_values.KeyValue.delete): In-page section heading.
- [get_value()](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.models.key_values.KeyValue.get_value): In-page section heading.
- [KeyValueCategory](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.enums.KeyValueCategory): In-page section heading.
- [KeyValueEntityType](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.enums.KeyValueEntityType): In-page section heading.
- [KeyValueType](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.enums.KeyValueType): In-page section heading.

## Documentation content

### KeyValue

A DataRobot Key-Value.

Added in version v3.4.

Variables

| Attribute | Type | Description |
| --- | --- | --- |
| 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 |

#### get()

Get Key-Value by id.

Added in version v3.4.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| key_value_id | str | ID of the Key-Value |

Returns

| Returns | Description |
| --- | --- |
| retrieved Key-Value |  |

Return type: [KeyValue](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.models.key_values.KeyValue)

Raises

| Exception | Description |
| --- | --- |
| datarobot.errors.ClientError | if the server responded with 4xx status. |
| datarobot.errors.ServerError | if the server responded with 5xx status. |

#### list()

List Key-Values.

Added in version v3.4.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| entity_id | str | ID of the related Entity |
| entity_type | KeyValueEntityType | type of the related Entity |

Returns

| Returns | Description |
| --- | --- |
| a list of Key-Values |  |

Return type: `List[KeyValue]`

Raises

| Exception | Description |
| --- | --- |
| datarobot.errors.ClientError | if the server responded with 4xx status |
| datarobot.errors.ServerError | if the server responded with 5xx status |

#### find()

Find Key-Value by name.

Added in version v3.4.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| entity_id | str | ID of the related Entity |
| entity_type | KeyValueEntityType | type of the related Entity |
| name | str | name of the Key-Value |

Returns

| Returns | Description |
| --- | --- |
| a list of Key-Values |  |

Return type: `List[KeyValue]`

Raises

| Exception | Description |
| --- | --- |
| datarobot.errors.ClientError | if the server responded with 4xx status |
| datarobot.errors.ServerError | if the server responded with 5xx status |

#### create()

Create a Key-Value.

Added in version v3.4.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| 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

| Returns | Description |
| --- | --- |
| created Key-Value |  |

Return type: [KeyValue](https://docs.datarobot.com/ja/docs/api/reference/sdk/key_values.html.md#datarobot.models.key_values.KeyValue)

Raises

| Exception | Description |
| --- | --- |
| datarobot.errors.ClientError | if the server responded with 4xx status. |
| datarobot.errors.ServerError | if the server responded with 5xx status. |

#### update()

Update Key-Value.

Added in version v3.4.

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| 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

| Exception | Description |
| --- | --- |
| datarobot.errors.ClientError | if the server responded with 4xx status. |
| datarobot.errors.ServerError | if the server responded with 5xx status. |

Return type: `None`

#### refresh()

Update Key-Value with the latest data from server.

Added in version v3.4.

Raises

| Exception | Description |
| --- | --- |
| datarobot.errors.ClientError | if the server responded with 4xx status |
| datarobot.errors.ServerError | if the server responded with 5xx status |

Return type: `None`

#### delete()

Delete Key-Value.

Added in version v3.4.

Raises

| Exception | Description |
| --- | --- |
| datarobot.errors.ClientError | If the server responded with 4xx status. |
| datarobot.errors.ServerError | If the server responded with 5xx status. |

Return type: `None`

#### get_value()

Get a value of Key-Value.

Added in version v3.4.

Returns

| Returns | Description |
| --- | --- |
| value depending on the value type |  |

Return type: `Union[str`, `float`, `boolean]`

### KeyValueCategory

Key-Value category

### KeyValueEntityType

Key-Value entity type

### KeyValueType

Key-Value type