# Custom scoring metrics

> Custom scoring metrics - Update the name, description, or tags of this metric.

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-01T19:55:38.863665+00:00` (UTC).

## Primary page

- [Custom scoring metrics](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md): Full documentation for this topic (Markdown sidecar).

## Sections on this page

- [classdatarobot.models.custom_scoring_metrics.CustomScoringMetric](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetric): In-page section heading.
- [classmethodlist(offset=0, limit=20, target_type=None, search=None, is_archived=False, tags=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetric.list): In-page section heading.
- [classmethodcreate(name, target_type, description=None, tags=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetric.create): In-page section heading.
- [classmethodget(metric_id)](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetric.get): In-page section heading.
- [update(name=None, description=None, tags=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetric.update): In-page section heading.
- [delete()](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetric.delete): In-page section heading.
- [classdatarobot.models.custom_scoring_metrics.CustomScoringMetricVersion](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetricVersion): In-page section heading.
- [classmethodlist(metric_id, offset=0, limit=20)](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetricVersion.list): In-page section heading.
- [classmethodcreate(metric_id, metadata_file_path, code_file_path, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetricVersion.create): In-page section heading.
- [classmethodget(metric_id, version_id)](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetricVersion.get): In-page section heading.
- [delete()](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetricVersion.delete): In-page section heading.
- [classmethodget_file_contents(registry_id, registry_version_id)](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetricVersion.get_file_contents): In-page section heading.
- [get_files()](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetricVersion.get_files): In-page section heading.
- [classdatarobot.models.custom_scoring_metrics.CustomScoringMetricVersionFileContents](https://docs.datarobot.com/en/docs/api/reference/sdk/custom_scoring_metrics.html.md#datarobot.models.custom_scoring_metrics.CustomScoringMetricVersionFileContents): In-page section heading.

## Related documentation

- [Developer documentation](https://docs.datarobot.com/en/docs/api/index.html.md): Linked from this page.
- [API reference](https://docs.datarobot.com/en/docs/api/reference/index.html.md): Linked from this page.

## Documentation content

### class datarobot.models.custom_scoring_metrics.CustomScoringMetric

A versioned custom scoring metric container.

- Variables:

#### classmethod list(offset=0, limit=20, target_type=None, search=None, is_archived=False, tags=None)

List custom scoring metrics.

- Parameters:
- Return type: list[CustomScoringMetric]

#### classmethod create(name, target_type, description=None, tags=None)

Create a new custom scoring metric container.

- Parameters:
- Return type: CustomScoringMetric

#### classmethod get(metric_id)

Retrieve a custom scoring metric by ID.

- Parameters: metric_id ( str ) – The ID of the metric to retrieve.
- Return type: CustomScoringMetric

#### update(name=None, description=None, tags=None)

Update the name, description, or tags of this metric.

- Parameters:
- Returns: This instance, updated in place.
- Return type: CustomScoringMetric

#### delete()

Archive (soft-delete) this metric.

- Return type: None

### class datarobot.models.custom_scoring_metrics.CustomScoringMetricVersion

A single version of a custom scoring metric.

Versions are created by uploading a `metadata.yml` and `custom_metrics.py` file pair. Each new version receives the next sequential version number.

- Variables:

#### classmethod list(metric_id, offset=0, limit=20)

List all versions for a given custom scoring metric.

- Parameters:
- Return type: list[CustomScoringMetricVersion]

#### classmethod create(metric_id, metadata_file_path, code_file_path, description=None)

Upload a new version of a custom scoring metric.

Sends `metadata.yml` and `custom_metrics.py` as multipart form data.

- Parameters:
- Return type: CustomScoringMetricVersion

#### classmethod get(metric_id, version_id)

Retrieve a specific version of a custom scoring metric.

- Parameters:
- Return type: CustomScoringMetricVersion

#### delete()

Delete this version.

- Return type: None

#### classmethod get_file_contents(registry_id, registry_version_id)

Retrieve the raw metadata and code file contents for a version.

- Parameters:
- Return type: CustomScoringMetricVersionFileContents

#### get_files()

Retrieve the raw metadata and code file contents for this version.

- Return type: CustomScoringMetricVersionFileContents

### class datarobot.models.custom_scoring_metrics.CustomScoringMetricVersionFileContents

Raw file contents (metadata + code) backing a custom scoring metric version.

- Variables: