Skip to main content

Create

Creates a machine learning model in the specified cluster.

import {
cloudApi,
decodeMessage,
serviceClients,
Session,
waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const CreateMlModelRequest =
cloudApi.mdb.clickhouse_ml_model_service.CreateMlModelRequest;
const MlModel = cloudApi.mdb.clickhouse_ml_model.MlModel;
const MlModelType = cloudApi.mdb.clickhouse_ml_model.MlModelType;

(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.MlModelServiceClient);

const operation = await client.create(
CreateMlModelRequest.fromPartial({
clusterId: "clusterId",
mlModelName: "mlModelName",
type: MlModelType.ML_MODEL_TYPE_CATBOOST,
uri: "uri",
})
);
const finishedOp = await waitForOperation(operation, session);

if (finishedOp.response) {
const result = decodeMessage<typeof MlModel>(finishedOp.response);
console.log(result);
}
})();

CreateMlModelRequest

clusterId : string

ID of the cluster to create a model in.

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

mlModelName : string

Model name. The model name is one of the arguments of the modelEvaluate() function, which is used to call the model in ClickHouse.

type : MlModelType

Type of the model.

uri : string

Model file URL. You can only use models stored in Object Storage.

Operation

An Operation resource. For more information, see Operation.

id : string

ID of the operation.

description : string

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp

Creation timestamp.

createdBy : string

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

modifiedAt : 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 : google.protobuf.Any

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.

One of result

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.

  • error : google.rpc.Status

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

  • response : google.protobuf.Any
    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.