Method create

Статья создана

HTTP request
Path parameters
Body parameters
Response

Creates a machine learning model in the specified cluster.

HTTP request

POST https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/mlModels

Path parameters

Parameter	Description
clusterId	Required. ID of the cluster to create a model in. To get a cluster ID make a list request. The maximum string length in characters is 50.

Body parameters

{
  "mlModelName": "string",
  "type": "string",
  "uri": "string"
}

Field Description

mlModelName

Field	Description
mlModelName	string Required. Model name. The model name is one of the arguments of the modelEvaluate() function, which is used to call the model in ClickHouse. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.
type	string Required. Type of the model. ML_MODEL_TYPE_CATBOOST: CatBoost model.
uri	string Required. Model file URL. You can only use models stored in Yandex Object Storage.

string

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

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

type

string

Required. Type of the model.

ML_MODEL_TYPE_CATBOOST: CatBoost model.

uri

string

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

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // 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.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format.
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format.
done	boolean (boolean) 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	object 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	object The error result of the operation in case of failure or cancellation. includes only one of the fields `error`, `response` The error result of the operation in case of failure or cancellation.
error. code	integer (int32) Error code. An enum value of google.rpc.Code.
error. message	string An error message.
error. details[]	object A list of messages that carry the error details.
response	object includes only one of the fields `error`, `response` 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.