> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Update an ML Model

> Update ML model properties using JSON Patch

# Update an ML Model

Update an ML model's properties using JSON Merge Patch. You can update by ID or by fully qualified name.

## Update by ID

<ParamField path="id" type="string" required>
  UUID of the ML model to update.
</ParamField>

## Update by Name

Use `PATCH /v1/mlmodels/name/{fqn}` to update by fully qualified name.

<ParamField path="fqn" type="string" required>
  Fully qualified name of the ML model (e.g., `mlflow_svc.customer_segmentation`).
</ParamField>

## Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.

<ParamField body="description" type="string">
  Updated description in Markdown format.
</ParamField>

<ParamField body="displayName" type="string">
  Updated display name.
</ParamField>

<ParamField body="algorithm" type="string">
  Updated algorithm name.
</ParamField>

<ParamField body="mlFeatures" type="array">
  Updated list of ML features.

  <Expandable title="properties">
    <ParamField body="name" type="string">
      Name of the feature.
    </ParamField>

    <ParamField body="dataType" type="string">
      Data type of the feature (e.g., `numerical`, `categorical`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="mlHyperParameters" type="array">
  Updated list of hyperparameters.

  <Expandable title="properties">
    <ParamField body="name" type="string">
      Name of the hyperparameter.
    </ParamField>

    <ParamField body="value" type="string">
      Value of the hyperparameter.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="target" type="string">
  Updated target variable.
</ParamField>

<ParamField body="owners" type="array">
  Updated list of owner references.

  <Expandable title="properties">
    <ParamField body="id" type="string">
      UUID of the owner entity.
    </ParamField>

    <ParamField body="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="tags" type="array">
  Updated classification tags.

  <Expandable title="properties">
    <ParamField body="tagFQN" type="string" required>
      Fully qualified name of the tag.
    </ParamField>

    <ParamField body="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ParamField>

    <ParamField body="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="domain" type="string">
  Updated domain FQN.
</ParamField>

<ParamField body="extension" type="object">
  Updated custom property values.
</ParamField>

<RequestExample dropdown>
  ```python PATCH /v1/mlmodels/{id} theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import MLModels

  configure(
      host="https://your-company.open-metadata.org/api",
      jwt_token="your-jwt-token"
  )

  # Retrieve, modify, and update
  model = MLModels.retrieve("6b04e1d8-b66d-4f78-ab21-beb5be2cf4f2")
  model.description = "Updated: Customer segmentation using KMeans with 5 clusters"
  model.mlHyperParameters = [
      {"name": "n_clusters", "value": "7"},
      {"name": "max_iter", "value": "500"}
  ]
  updated = MLModels.update(model)

  print(f"Updated to version {updated.version}")
  ```

  ```java PATCH /v1/mlmodels/{id} theme={null}
  import static org.openmetadata.sdk.fluent.MlModels.*;

  // Retrieve, modify, and update
  var model = MlModels.retrieve("6b04e1d8-b66d-4f78-ab21-beb5be2cf4f2");
  model.setDescription("Updated: Customer segmentation using KMeans with 5 clusters");
  var updated = MlModels.update(model);
  ```

  ```bash PATCH /v1/mlmodels/{id} theme={null}
  # Update by ID
  curl -X PATCH "{base_url}/api/v1/mlmodels/6b04e1d8-b66d-4f78-ab21-beb5be2cf4f2" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json-patch+json" \
    -d '[
      {"op": "replace", "path": "/description", "value": "Updated: Customer segmentation using KMeans with 5 clusters"}
    ]'

  # Update by name
  curl -X PATCH "{base_url}/api/v1/mlmodels/name/mlflow_svc.customer_segmentation" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json-patch+json" \
    -d '[
      {"op": "replace", "path": "/description", "value": "Updated: Customer segmentation using KMeans with 5 clusters"}
    ]'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "6b04e1d8-b66d-4f78-ab21-beb5be2cf4f2",
    "name": "customer_segmentation",
    "fullyQualifiedName": "mlflow_svc.customer_segmentation",
    "displayName": "Customer Segmentation Model",
    "description": "Updated: Customer segmentation using KMeans with 5 clusters",
    "algorithm": "KMeans",
    "version": 0.2,
    "updatedAt": 1769982669247,
    "updatedBy": "admin",
    "service": {
      "id": "ca22d46e-81b9-4e48-85b5-0adc44980da9",
      "type": "mlmodelService",
      "name": "mlflow_svc",
      "fullyQualifiedName": "mlflow_svc",
      "deleted": false
    },
    "serviceType": "Mlflow",
    "href": "http://localhost:8585/api/v1/mlmodels/6b04e1d8-b66d-4f78-ab21-beb5be2cf4f2",
    "deleted": false,
    "owners": [],
    "tags": [],
    "followers": [],
    "votes": {
      "upVotes": 0,
      "downVotes": 0
    },
    "domains": []
  }
  ```
</ResponseExample>

***

## Returns

Returns the updated ML model object with the new version number.

## Response

<ResponseField name="id" type="string">
  Unique identifier for the ML model (UUID format).
</ResponseField>

<ResponseField name="name" type="string">
  ML model name.
</ResponseField>

<ResponseField name="fullyQualifiedName" type="string">
  Fully qualified name in format `service.modelName`.
</ResponseField>

<ResponseField name="description" type="string">
  Updated description.
</ResponseField>

<ResponseField name="version" type="number">
  Incremented version number.
</ResponseField>

***

## Error Handling

| Code  | Error Type     | Description                                   |
| ----- | -------------- | --------------------------------------------- |
| `400` | `BAD_REQUEST`  | Invalid JSON patch or malformed request       |
| `401` | `UNAUTHORIZED` | Invalid or missing authentication token       |
| `403` | `FORBIDDEN`    | User lacks permission to update this ML model |
| `404` | `NOT_FOUND`    | ML model with given ID or FQN does not exist  |
| `409` | `CONFLICT`     | Concurrent modification detected              |