Put model monitorv2apimodel
curl --request PUT \
--url https://mycluster.domino.tech/model-monitor/v2/api/model \
--header 'Content-Type: application/json' \
--header 'X-Domino-Api-Key: <api-key>' \
--data '
{
"datasetDetails": {
"name": "<string>",
"datasetType": "file",
"datasetConfig": {
"path": "<string>"
},
"datasourceName": "<string>",
"featureSetId": "<string>",
"featureSetVersionId": "<string>"
},
"modelMetadata": {
"name": "<string>",
"version": "<string>",
"description": "<string>",
"author": "<string>",
"dateCreated": 123
},
"variables": [
{
"name": "<string>",
"binsCategories": [
"<string>"
],
"binsEdges": [
123
],
"binsNum": 123,
"featureImportance": 123,
"precomputedBinCounts": [
123
],
"predictionProbabilityLabels": [
"<string>"
],
"forPredictionOutput": "<string>"
}
],
"run_cohort_analysis": true
}
'import requests
url = "https://mycluster.domino.tech/model-monitor/v2/api/model"
payload = {
"datasetDetails": {
"name": "<string>",
"datasetType": "file",
"datasetConfig": { "path": "<string>" },
"datasourceName": "<string>",
"featureSetId": "<string>",
"featureSetVersionId": "<string>"
},
"modelMetadata": {
"name": "<string>",
"version": "<string>",
"description": "<string>",
"author": "<string>",
"dateCreated": 123
},
"variables": [
{
"name": "<string>",
"binsCategories": ["<string>"],
"binsEdges": [123],
"binsNum": 123,
"featureImportance": 123,
"precomputedBinCounts": [123],
"predictionProbabilityLabels": ["<string>"],
"forPredictionOutput": "<string>"
}
],
"run_cohort_analysis": True
}
headers = {
"X-Domino-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Domino-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
datasetDetails: {
name: '<string>',
datasetType: 'file',
datasetConfig: {path: '<string>'},
datasourceName: '<string>',
featureSetId: '<string>',
featureSetVersionId: '<string>'
},
modelMetadata: {
name: '<string>',
version: '<string>',
description: '<string>',
author: '<string>',
dateCreated: 123
},
variables: [
{
name: '<string>',
binsCategories: ['<string>'],
binsEdges: [123],
binsNum: 123,
featureImportance: 123,
precomputedBinCounts: [123],
predictionProbabilityLabels: ['<string>'],
forPredictionOutput: '<string>'
}
],
run_cohort_analysis: true
})
};
fetch('https://mycluster.domino.tech/model-monitor/v2/api/model', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mycluster.domino.tech/model-monitor/v2/api/model",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'datasetDetails' => [
'name' => '<string>',
'datasetType' => 'file',
'datasetConfig' => [
'path' => '<string>'
],
'datasourceName' => '<string>',
'featureSetId' => '<string>',
'featureSetVersionId' => '<string>'
],
'modelMetadata' => [
'name' => '<string>',
'version' => '<string>',
'description' => '<string>',
'author' => '<string>',
'dateCreated' => 123
],
'variables' => [
[
'name' => '<string>',
'binsCategories' => [
'<string>'
],
'binsEdges' => [
123
],
'binsNum' => 123,
'featureImportance' => 123,
'precomputedBinCounts' => [
123
],
'predictionProbabilityLabels' => [
'<string>'
],
'forPredictionOutput' => '<string>'
]
],
'run_cohort_analysis' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Domino-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mycluster.domino.tech/model-monitor/v2/api/model"
payload := strings.NewReader("{\n \"datasetDetails\": {\n \"name\": \"<string>\",\n \"datasetType\": \"file\",\n \"datasetConfig\": {\n \"path\": \"<string>\"\n },\n \"datasourceName\": \"<string>\",\n \"featureSetId\": \"<string>\",\n \"featureSetVersionId\": \"<string>\"\n },\n \"modelMetadata\": {\n \"name\": \"<string>\",\n \"version\": \"<string>\",\n \"description\": \"<string>\",\n \"author\": \"<string>\",\n \"dateCreated\": 123\n },\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"binsCategories\": [\n \"<string>\"\n ],\n \"binsEdges\": [\n 123\n ],\n \"binsNum\": 123,\n \"featureImportance\": 123,\n \"precomputedBinCounts\": [\n 123\n ],\n \"predictionProbabilityLabels\": [\n \"<string>\"\n ],\n \"forPredictionOutput\": \"<string>\"\n }\n ],\n \"run_cohort_analysis\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Domino-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://mycluster.domino.tech/model-monitor/v2/api/model")
.header("X-Domino-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"datasetDetails\": {\n \"name\": \"<string>\",\n \"datasetType\": \"file\",\n \"datasetConfig\": {\n \"path\": \"<string>\"\n },\n \"datasourceName\": \"<string>\",\n \"featureSetId\": \"<string>\",\n \"featureSetVersionId\": \"<string>\"\n },\n \"modelMetadata\": {\n \"name\": \"<string>\",\n \"version\": \"<string>\",\n \"description\": \"<string>\",\n \"author\": \"<string>\",\n \"dateCreated\": 123\n },\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"binsCategories\": [\n \"<string>\"\n ],\n \"binsEdges\": [\n 123\n ],\n \"binsNum\": 123,\n \"featureImportance\": 123,\n \"precomputedBinCounts\": [\n 123\n ],\n \"predictionProbabilityLabels\": [\n \"<string>\"\n ],\n \"forPredictionOutput\": \"<string>\"\n }\n ],\n \"run_cohort_analysis\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/model-monitor/v2/api/model")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"datasetDetails\": {\n \"name\": \"<string>\",\n \"datasetType\": \"file\",\n \"datasetConfig\": {\n \"path\": \"<string>\"\n },\n \"datasourceName\": \"<string>\",\n \"featureSetId\": \"<string>\",\n \"featureSetVersionId\": \"<string>\"\n },\n \"modelMetadata\": {\n \"name\": \"<string>\",\n \"version\": \"<string>\",\n \"description\": \"<string>\",\n \"author\": \"<string>\",\n \"dateCreated\": 123\n },\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"binsCategories\": [\n \"<string>\"\n ],\n \"binsEdges\": [\n 123\n ],\n \"binsNum\": 123,\n \"featureImportance\": 123,\n \"precomputedBinCounts\": [\n 123\n ],\n \"predictionProbabilityLabels\": [\n \"<string>\"\n ],\n \"forPredictionOutput\": \"<string>\"\n }\n ],\n \"run_cohort_analysis\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"modelType": "classification",
"version": "<string>",
"id": "<string>",
"createdAt": 123,
"updatedAt": 123,
"userId": "<string>",
"ingestionStatus": "created",
"registrationStatus": "draft",
"isDeleted": true,
"description": "<string>",
"author": "<string>",
"dateCreated": 123,
"sourceType": "domino_workbench",
"sourceDetails": {
"workbenchModelId": "<string>",
"workbenchModelVersionId": "<string>"
},
"ownerUsername": "<string>",
"ownerEmail": "<string>",
"ownerName": "<string>",
"tags": [
{
"id": "<string>",
"tagName": "<string>"
}
],
"visibility": "public",
"collaborators": [
{
"userId": "<string>",
"collaboratorLevel": "editor"
}
],
"permissions": {
"canRegisterDataset": true,
"canUpdateMonitoringSettings": true,
"canEditPermissions": true
}
}Authorizations
Body
Config to be used to register a model with DMM.
Config for the dataset to be registered with the model.
Show child attributes
Show child attributes
Model Config to be used to register a model with DMM.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Successfully registered the Model.
Model Config to be used to register a model with DMM.
Name of the Model.
Type of the Model.
classification, regression Version of the Model.
Model Identifier.
Creation timestamp of the Model.
Last update timestamp for the Model.
Id of the model owner, who created the model.
Dataset Ingestion status for a model.
created, training, prediction, ground_truth Registration status of a model.
draft, created, deleted Whether the model is deleted or not.
Description for the Model.
Author of the Model.
The creation date of the model.
Source for the model registration.
domino_workbench, standalone Model details associated with a Domino workbench model.
Show child attributes
Show child attributes
username of the model owner, who created the model.
email of the model owner, who created the model.
name of the model owner, who created the model.
List of tags associated with the model
Show child attributes
Show child attributes
Model visibility
public, private Show child attributes
Show child attributes
Permission metadata required for a model response
Show child attributes
Show child attributes
Related topics
Put model monitorv2apimodel visibilityPut model monitorv2apimodel collaboratorsPut model monitorv2apimodel register datasetGet model monitorv2apimodelWas this page helpful?
curl --request PUT \
--url https://mycluster.domino.tech/model-monitor/v2/api/model \
--header 'Content-Type: application/json' \
--header 'X-Domino-Api-Key: <api-key>' \
--data '
{
"datasetDetails": {
"name": "<string>",
"datasetType": "file",
"datasetConfig": {
"path": "<string>"
},
"datasourceName": "<string>",
"featureSetId": "<string>",
"featureSetVersionId": "<string>"
},
"modelMetadata": {
"name": "<string>",
"version": "<string>",
"description": "<string>",
"author": "<string>",
"dateCreated": 123
},
"variables": [
{
"name": "<string>",
"binsCategories": [
"<string>"
],
"binsEdges": [
123
],
"binsNum": 123,
"featureImportance": 123,
"precomputedBinCounts": [
123
],
"predictionProbabilityLabels": [
"<string>"
],
"forPredictionOutput": "<string>"
}
],
"run_cohort_analysis": true
}
'import requests
url = "https://mycluster.domino.tech/model-monitor/v2/api/model"
payload = {
"datasetDetails": {
"name": "<string>",
"datasetType": "file",
"datasetConfig": { "path": "<string>" },
"datasourceName": "<string>",
"featureSetId": "<string>",
"featureSetVersionId": "<string>"
},
"modelMetadata": {
"name": "<string>",
"version": "<string>",
"description": "<string>",
"author": "<string>",
"dateCreated": 123
},
"variables": [
{
"name": "<string>",
"binsCategories": ["<string>"],
"binsEdges": [123],
"binsNum": 123,
"featureImportance": 123,
"precomputedBinCounts": [123],
"predictionProbabilityLabels": ["<string>"],
"forPredictionOutput": "<string>"
}
],
"run_cohort_analysis": True
}
headers = {
"X-Domino-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Domino-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
datasetDetails: {
name: '<string>',
datasetType: 'file',
datasetConfig: {path: '<string>'},
datasourceName: '<string>',
featureSetId: '<string>',
featureSetVersionId: '<string>'
},
modelMetadata: {
name: '<string>',
version: '<string>',
description: '<string>',
author: '<string>',
dateCreated: 123
},
variables: [
{
name: '<string>',
binsCategories: ['<string>'],
binsEdges: [123],
binsNum: 123,
featureImportance: 123,
precomputedBinCounts: [123],
predictionProbabilityLabels: ['<string>'],
forPredictionOutput: '<string>'
}
],
run_cohort_analysis: true
})
};
fetch('https://mycluster.domino.tech/model-monitor/v2/api/model', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mycluster.domino.tech/model-monitor/v2/api/model",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'datasetDetails' => [
'name' => '<string>',
'datasetType' => 'file',
'datasetConfig' => [
'path' => '<string>'
],
'datasourceName' => '<string>',
'featureSetId' => '<string>',
'featureSetVersionId' => '<string>'
],
'modelMetadata' => [
'name' => '<string>',
'version' => '<string>',
'description' => '<string>',
'author' => '<string>',
'dateCreated' => 123
],
'variables' => [
[
'name' => '<string>',
'binsCategories' => [
'<string>'
],
'binsEdges' => [
123
],
'binsNum' => 123,
'featureImportance' => 123,
'precomputedBinCounts' => [
123
],
'predictionProbabilityLabels' => [
'<string>'
],
'forPredictionOutput' => '<string>'
]
],
'run_cohort_analysis' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Domino-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mycluster.domino.tech/model-monitor/v2/api/model"
payload := strings.NewReader("{\n \"datasetDetails\": {\n \"name\": \"<string>\",\n \"datasetType\": \"file\",\n \"datasetConfig\": {\n \"path\": \"<string>\"\n },\n \"datasourceName\": \"<string>\",\n \"featureSetId\": \"<string>\",\n \"featureSetVersionId\": \"<string>\"\n },\n \"modelMetadata\": {\n \"name\": \"<string>\",\n \"version\": \"<string>\",\n \"description\": \"<string>\",\n \"author\": \"<string>\",\n \"dateCreated\": 123\n },\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"binsCategories\": [\n \"<string>\"\n ],\n \"binsEdges\": [\n 123\n ],\n \"binsNum\": 123,\n \"featureImportance\": 123,\n \"precomputedBinCounts\": [\n 123\n ],\n \"predictionProbabilityLabels\": [\n \"<string>\"\n ],\n \"forPredictionOutput\": \"<string>\"\n }\n ],\n \"run_cohort_analysis\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Domino-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://mycluster.domino.tech/model-monitor/v2/api/model")
.header("X-Domino-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"datasetDetails\": {\n \"name\": \"<string>\",\n \"datasetType\": \"file\",\n \"datasetConfig\": {\n \"path\": \"<string>\"\n },\n \"datasourceName\": \"<string>\",\n \"featureSetId\": \"<string>\",\n \"featureSetVersionId\": \"<string>\"\n },\n \"modelMetadata\": {\n \"name\": \"<string>\",\n \"version\": \"<string>\",\n \"description\": \"<string>\",\n \"author\": \"<string>\",\n \"dateCreated\": 123\n },\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"binsCategories\": [\n \"<string>\"\n ],\n \"binsEdges\": [\n 123\n ],\n \"binsNum\": 123,\n \"featureImportance\": 123,\n \"precomputedBinCounts\": [\n 123\n ],\n \"predictionProbabilityLabels\": [\n \"<string>\"\n ],\n \"forPredictionOutput\": \"<string>\"\n }\n ],\n \"run_cohort_analysis\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/model-monitor/v2/api/model")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"datasetDetails\": {\n \"name\": \"<string>\",\n \"datasetType\": \"file\",\n \"datasetConfig\": {\n \"path\": \"<string>\"\n },\n \"datasourceName\": \"<string>\",\n \"featureSetId\": \"<string>\",\n \"featureSetVersionId\": \"<string>\"\n },\n \"modelMetadata\": {\n \"name\": \"<string>\",\n \"version\": \"<string>\",\n \"description\": \"<string>\",\n \"author\": \"<string>\",\n \"dateCreated\": 123\n },\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"binsCategories\": [\n \"<string>\"\n ],\n \"binsEdges\": [\n 123\n ],\n \"binsNum\": 123,\n \"featureImportance\": 123,\n \"precomputedBinCounts\": [\n 123\n ],\n \"predictionProbabilityLabels\": [\n \"<string>\"\n ],\n \"forPredictionOutput\": \"<string>\"\n }\n ],\n \"run_cohort_analysis\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"modelType": "classification",
"version": "<string>",
"id": "<string>",
"createdAt": 123,
"updatedAt": 123,
"userId": "<string>",
"ingestionStatus": "created",
"registrationStatus": "draft",
"isDeleted": true,
"description": "<string>",
"author": "<string>",
"dateCreated": 123,
"sourceType": "domino_workbench",
"sourceDetails": {
"workbenchModelId": "<string>",
"workbenchModelVersionId": "<string>"
},
"ownerUsername": "<string>",
"ownerEmail": "<string>",
"ownerName": "<string>",
"tags": [
{
"id": "<string>",
"tagName": "<string>"
}
],
"visibility": "public",
"collaborators": [
{
"userId": "<string>",
"collaboratorLevel": "editor"
}
],
"permissions": {
"canRegisterDataset": true,
"canUpdateMonitoringSettings": true,
"canEditPermissions": true
}
}