Связаться с намиПодключиться

Managed Service for ClickHouse API, gRPC: MlModelService.Update

Статья создана
Обновлена 26 ноября 2024 г.

Updates the specified machine learning model.

gRPC request

rpc Update (UpdateMlModelRequest) returns (operation.Operation)

UpdateMlModelRequest

{
  "cluster_id": "string",
  "ml_model_name": "string",
  "update_mask": "google.protobuf.FieldMask",
  "uri": "string"
}

Field

Description

cluster_id

string

Required field. ID of the cluster to update the model in.

To get a cluster ID make a ClusterService.List request.

ml_model_name

string

Required field. Name of the the model to update.

update_mask

google.protobuf.FieldMask

uri

string

The new model file URL. You can only use models stored in Object Storage.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "cluster_id": "string",
    "ml_model_name": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "name": "string",
    "cluster_id": "string",
    "type": "MlModelType",
    "uri": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateMlModelMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

MlModel

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateMlModelMetadata

Field

Description

cluster_id

string

ID of the cluster that contains the model being updated.

ml_model_name

string

Name of the the model that is being updated.

MlModel

Field

Description

name

string

Name of the the model.

cluster_id

string

ID of the ClickHouse cluster that the model belongs to.

type

enum MlModelType

Type of the model.

  • ML_MODEL_TYPE_UNSPECIFIED
  • ML_MODEL_TYPE_CATBOOST: CatBoost model.

uri

string

Model file URL. You can only use models stored in Object Storage.
Предыдущая
Create
Следующая
Delete