ML Ops
This page outlines the operations, endpoints, parameters, and example requests and responses for the ML Ops.
GET /api/v2/guardConfigurations/
List resource tags.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag
Maturity
Enabled by default
Description
MODERATION_GUARDRAILS
PUBLIC_PREVIEW
false
Configure and use guardrails for LLM intervention and moderation.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/guardConfigurations/?entityId= string& entityType = customModel \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
offset
query
integer
false
This many results will be skipped.
limit
query
integer
false
At most this many results are returned.
entityId
query
string
true
Filter guard configurations by the given entity ID.
entityType
query
string
true
Entity type of the given entity ID.
Enumerated Values
Parameter
Value
entityType
[customModel
, customModelVersion
, playground
]
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"deploymentId" : "string" ,
"description" : "string" ,
"entityId" : "string" ,
"entityType" : "customModel" ,
"errorMessage" : "string" ,
"id" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : [
{
"defaultValue" : 0 ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : 0
}
],
"stages" : [
"prompt"
],
"type" : "guardModel"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/guardConfigurations/
Create a guard configuration.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag
Maturity
Enabled by default
Description
MODERATION_GUARDRAILS
PUBLIC_PREVIEW
false
Configure and use guardrails for LLM intervention and moderation.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/guardConfigurations/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"customMetric" : {
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"deploymentId" : "string" ,
"description" : "string" ,
"entityId" : "string" ,
"entityType" : "customModel" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : [],
"stages" : [
"prompt"
],
"templateId" : "string"
}
Parameters
Example responses
201 Response
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"deploymentId" : "string" ,
"description" : "string" ,
"entityId" : "string" ,
"entityType" : "customModel" ,
"errorMessage" : "string" ,
"id" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : [
{
"defaultValue" : 0 ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : 0
}
],
"stages" : [
"prompt"
],
"type" : "guardModel"
}
Responses
Status
Meaning
Description
Schema
201
Created
none
GuardConfigurationRetrieveResponse
404
Not Found
Either the resource does not exist or the user does not have permission to create the configuration.
None
409
Conflict
The proposed configuration name is already in use for the same entity.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/guardConfigurations/predictionEnvironmentsInUse/
AShow prediction environments in use for moderation.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag
Maturity
Enabled by default
Description
MODERATION_GUARDRAILS
PUBLIC_PREVIEW
false
Configure and use guardrails for LLM intervention and moderation.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/guardConfigurations/predictionEnvironmentsInUse/?customModelVersionId= string \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
offset
query
integer
false
This many results will be skipped.
limit
query
integer
false
At most this many results are returned.
customModelVersionId
query
string
true
Show prediction environment information for this custom model version.
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"id" : "string" ,
"name" : "string" ,
"usedBy" : [
{
"configurationId" : "string" ,
"deploymentId" : "string" ,
"name" : "string"
}
]
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/guardConfigurations/toNewCustomModelVersion/
Apply moderation configuration to a new custom model version.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag
Maturity
Enabled by default
Description
MODERATION_GUARDRAILS
PUBLIC_PREVIEW
false
Configure and use guardrails for LLM intervention and moderation.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/guardConfigurations/toNewCustomModelVersion/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"customModelId" : "string" ,
"data" : [
{
"customMetric" : {
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"deploymentId" : "string" ,
"description" : "string" ,
"errorMessage" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : [
{
"defaultValue" : 0 ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : 0
}
],
"stages" : [
"prompt"
],
"type" : "guardModel"
}
],
"overallConfig" : {
"timeoutAction" : "block" ,
"timeoutSec" : 2
}
}
Parameters
Example responses
200 Response
{
"customModelVersionId" : "string"
}
Responses
Status
Meaning
Description
Schema
200
OK
none
GuardConfigurationToCustomModelResponse
404
Not Found
Either the resource does not exist or the user does not have permission to create the configuration.
None
409
Conflict
The destination custom model version is frozen. Create a new version to save configuration.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/guardConfigurations/{configId}/
Delete a guard config.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag
Maturity
Enabled by default
Description
MODERATION_GUARDRAILS
PUBLIC_PREVIEW
false
Configure and use guardrails for LLM intervention and moderation.
Code samples
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/guardConfigurations/{ configId} / \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
configId
path
string
true
ID of the configuration.
Responses
Status
Meaning
Description
Schema
204
No Content
none
None
404
Not Found
Either the config does not exist or the user does not have permission to delete it.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/guardConfigurations/{configId}/
Retrieve info about a guard configuration.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag
Maturity
Enabled by default
Description
MODERATION_GUARDRAILS
PUBLIC_PREVIEW
false
Configure and use guardrails for LLM intervention and moderation.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/guardConfigurations/{ configId} / \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
configId
path
string
true
ID of the configuration.
Example responses
200 Response
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"deploymentId" : "string" ,
"description" : "string" ,
"entityId" : "string" ,
"entityType" : "customModel" ,
"errorMessage" : "string" ,
"id" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : [
{
"defaultValue" : 0 ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : 0
}
],
"stages" : [
"prompt"
],
"type" : "guardModel"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/guardConfigurations/{configId}/
Update a guard config.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag
Maturity
Enabled by default
Description
MODERATION_GUARDRAILS
PUBLIC_PREVIEW
false
Configure and use guardrails for LLM intervention and moderation.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/guardConfigurations/{ configId} / \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"customMetric" : {
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"deploymentId" : "string" ,
"description" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : []
}
Parameters
Name
In
Type
Required
Description
configId
path
string
true
ID of the configuration.
body
body
GuardConfigurationUpdate
false
none
Example responses
200 Response
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"deploymentId" : "string" ,
"description" : "string" ,
"entityId" : "string" ,
"entityType" : "customModel" ,
"errorMessage" : "string" ,
"id" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : [
{
"defaultValue" : 0 ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : 0
}
],
"stages" : [
"prompt"
],
"type" : "guardModel"
}
Responses
Status
Meaning
Description
Schema
200
OK
none
GuardConfigurationRetrieveResponse
404
Not Found
Either the resource does not exist or the user does not have permission to create the configuration.
None
409
Conflict
The proposed configuration name is already in use for the same entity.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/guardTemplates/
List guard templates.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag
Maturity
Enabled by default
Description
MODERATION_GUARDRAILS
PUBLIC_PREVIEW
false
Configure and use guardrails for LLM intervention and moderation.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/guardTemplates/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
offset
query
integer
false
This many results will be skipped.
limit
query
integer
false
At most this many results are returned.
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"additionalConfig" : "string" ,
"allowedStages" : [
"prompt"
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"customMetric" : {
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"description" : "string" ,
"errorMessage" : "string" ,
"id" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"modifyMessage" : "string" ,
"sendNotification" : true
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiDeploymentId" : "string" ,
"orgId" : "string" ,
"parameters" : [
{
"defaultValue" : "string" ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : "string"
}
],
"productionOnly" : true ,
"type" : "guardModel"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/guardTemplates/{templateId}/
Retrieve info about a guard template.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag
Maturity
Enabled by default
Description
MODERATION_GUARDRAILS
PUBLIC_PREVIEW
false
Configure and use guardrails for LLM intervention and moderation.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/guardTemplates/{ templateId} / \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
templateId
path
string
true
ID of the template.
Example responses
200 Response
{
"additionalConfig" : "string" ,
"allowedStages" : [
"prompt"
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"customMetric" : {
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"description" : "string" ,
"errorMessage" : "string" ,
"id" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"modifyMessage" : "string" ,
"sendNotification" : true
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiDeploymentId" : "string" ,
"orgId" : "string" ,
"parameters" : [
{
"defaultValue" : "string" ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : "string"
}
],
"productionOnly" : true ,
"type" : "guardModel"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/mlops/portablePredictionServerImage/
Fetches the latest Portable Prediction Server (PPS) Docker image. The resulting image can be docker-loaded. Since the image can be quite large (14GB+) consider querying its metadata to check the image size in advance and content hash to verify the downloaded image afterwards. In some environments it can HTTP redirect to some other service (like S3 or GCP) using pre-signed URLs.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/mlops/portablePredictionServerImage/ \
-H "Authorization: Bearer {access-token}"
Responses
Status
Meaning
Description
Schema
200
OK
Download the latest available Portable Prediction Server (PPS) Docker image
None
302
Found
Redirect to another service for more efficient content download using pre-signed URL
None
404
Not Found
No PPS images found in the system
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Fetches currently active PPS Docker image metadata
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/mlops/portablePredictionServerImage/metadata/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Example responses
200 Response
{
"baseImageId" : "string" ,
"created" : "2019-08-24T14:15:22Z" ,
"datarobotRuntimeImageTag" : "string" ,
"dockerImageId" : "string" ,
"filename" : "string" ,
"hash" : "string" ,
"hashAlgorithm" : "SHA256" ,
"imageSize" : 0 ,
"shortDockerImageId" : "string"
}
Responses
Status
Meaning
Description
Schema
200
OK
Available Portable Prediction Server (PPS) image metadata
PPSImageMetadataResponse
404
Not Found
No PPS images found in the system
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/overallModerationConfiguration/
Get overall moderation configuration for an entity.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag
Maturity
Enabled by default
Description
MODERATION_GUARDRAILS
PUBLIC_PREVIEW
false
Configure and use guardrails for LLM intervention and moderation.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/overallModerationConfiguration/?entityId= string& entityType = customModel \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
entityId
query
string
true
Retrieve overall moderation configuration for the given entity ID.
entityType
query
string
true
Entity type of the given entity ID.
Enumerated Values
Parameter
Value
entityType
[customModel
, customModelVersion
, playground
]
Example responses
200 Response
{
"entityId" : "string" ,
"entityType" : "customModel" ,
"timeoutAction" : "block" ,
"timeoutSec" : 2 ,
"updatedAt" : "2019-08-24T14:15:22Z" ,
"updaterId" : "string"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/overallModerationConfiguration/
Update overall moderation configuration for an entity.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag
Maturity
Enabled by default
Description
MODERATION_GUARDRAILS
PUBLIC_PREVIEW
false
Configure and use guardrails for LLM intervention and moderation.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/overallModerationConfiguration/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"entityId" : "string" ,
"entityType" : "customModel" ,
"timeoutAction" : "block" ,
"timeoutSec" : 0
}
Parameters
Name
In
Type
Required
Description
entityId
path
string
true
Retrieve overall moderation configuration for the given entity ID.
entityType
path
string
true
Entity type of the given entity ID.
body
body
OverallModerationConfigurationUpdate
false
none
Enumerated Values
Parameter
Value
entityType
[customModel
, customModelVersion
, playground
]
Example responses
200 Response
{
"entityId" : "string" ,
"entityType" : "customModel" ,
"timeoutAction" : "block" ,
"timeoutSec" : 2 ,
"updatedAt" : "2019-08-24T14:15:22Z" ,
"updaterId" : "string"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas
DeploymentAndGuardResponse
{
"configurationId" : "string" ,
"deploymentId" : "string" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
configurationId
string
true
ID of guard configuration.
deploymentId
string
true
ID of guard model deployment.
name
string
true
Name of guard configuration.
GuardConditionResponse
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
Condition to trigger intervention
Properties
Name
Type
Required
Restrictions
Description
comparand
any
true
Condition comparand (basis of comparison)
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
[string]
false
maxItems: 10
none
continued
Name
Type
Required
Restrictions
Description
comparator
string
true
Condition comparator (operator)
Enumerated Values
Property
Value
comparator
[greaterThan
, lessThan
, equals
, notEquals
, is
, isNot
, matches
, doesNotMatch
, contains
, doesNotContain
]
GuardConfigurationConditionResponse
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
Condition to trigger intervention
Properties
Name
Type
Required
Restrictions
Description
comparand
any
true
Condition comparand (basis of comparison
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
[string]
false
maxItems: 10
none
continued
Name
Type
Required
Restrictions
Description
comparator
string
true
Condition comparator (operator)
Enumerated Values
Property
Value
comparator
[greaterThan
, lessThan
, equals
, notEquals
, is
, isNot
, matches
, doesNotMatch
, contains
, doesNotContain
]
GuardConfigurationCreate
{
"customMetric" : {
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"deploymentId" : "string" ,
"description" : "string" ,
"entityId" : "string" ,
"entityType" : "customModel" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : [],
"stages" : [
"prompt"
],
"templateId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
customMetric
GuardConfigurationCustomMetricResponse
false
Custom metric configuration for the guard.
deploymentId
string¦null
false
ID of deployed model, for model guards.
description
string
false
maxLength: 4096
Guard configuration description
entityId
string
true
ID of custom model or playground for this guard.
entityType
string
true
Type of associated entity.
intervention
GuardConfigurationInterventionResponse
false
Intervention configuration for the guard.
llmType
string¦null
false
Type of LLM used by this guard
modelInfo
GuardConfigurationPayloadModelInfo
false
Configuration info for guards using deployed models.
name
string
true
maxLength: 255
Guard configuration name
nemoInfo
GuardConfigurationNemoInfoResponse
false
Configuration info for NeMo guards.
openaiApiBase
string¦null
false
maxLength: 255
Azure OpenAI API Base URL
openaiApiKey
string¦null
false
maxLength: 255
Azure OpenAI API Key
openaiCredential
string¦null
false
ID of user credential containing an OpenAI token.
openaiDeploymentId
string¦null
false
maxLength: 255
Open API Deployment ID
parameters
[GuardConfigurationParameterResponse ]
false
maxItems: 1
List of guard runtime parameters. Deprecated.
stages
[string]
true
maxItems: 16
The stages where the guard can run.
templateId
string
true
ID of template this guard is based on.
Enumerated Values
Property
Value
entityType
[customModel
, customModelVersion
, playground
]
llmType
[openAi
, azureOpenAi
]
GuardConfigurationCustomMetricResponse
{
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
Custom metric configuration for the guard.
Properties
Name
Type
Required
Restrictions
Description
baselineValues
[GuardConfigurationMetricBaselineValue ]
true
maxItems: 5
Custom metric baseline values
description
string
true
maxLength: 1000
Custom metric description
directionality
string
true
Custom metric direction
isModelSpecific
boolean
true
Is custom metric specific to a model
name
string
true
maxLength: 255
Custom metric name
timestamp
GuardConfigurationMetricTimestampSpoofingResponse
true
Custom metric timestamp
type
string
true
Custom metric type
units
string
true
maxLength: 255
Custom metric units
value
GuardConfigurationValueFieldResponse
true
Custom metric value
Enumerated Values
Property
Value
directionality
[higherIsBetter
, lowerIsBetter
]
type
[average
, gauge
, sum
]
GuardConfigurationFullPost
{
"customMetric" : {
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"deploymentId" : "string" ,
"description" : "string" ,
"errorMessage" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : [
{
"defaultValue" : 0 ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : 0
}
],
"stages" : [
"prompt"
],
"type" : "guardModel"
}
Complete guard configuration to push
Properties
Name
Type
Required
Restrictions
Description
customMetric
GuardConfigurationCustomMetricResponse
false
Custom metric configuration for the guard.
deploymentId
string¦null
false
ID of deployed model, for model guards.
description
string
true
maxLength: 4096
Guard configuration description
errorMessage
string¦null
false
Error message if the guard configuration is invalid.
intervention
GuardConfigurationInterventionResponse
false
Intervention configuration for the guard.
isValid
boolean
false
Whether the guard is valid or not.
llmType
string¦null
false
Type of LLM used by this guard
modelInfo
GuardConfigurationModelInfoResponse
false
Configuration info for guards using deployed models.
name
string
true
maxLength: 255
Guard configuration name
nemoInfo
GuardConfigurationNemoInfoResponse
false
Configuration info for NeMo guards.
ootbType
string¦null
false
Guard template "Out of the Box" metric type
openaiApiBase
string¦null
false
maxLength: 255
Azure OpenAI API Base URL
openaiApiKey
string¦null
false
maxLength: 255
Azure OpenAI API Key
openaiCredential
string¦null
false
ID of user credential containing an OpenAI token.
openaiDeploymentId
string¦null
false
maxLength: 255
Open API Deployment ID
parameters
[GuardConfigurationParameterResponse ]
true
maxItems: 1
List of guard runtime parameters. Deprecated.
stages
[string]
true
maxItems: 16
The stages where the guard is configured to run.
type
string
true
Guard configuration type
Enumerated Values
Property
Value
llmType
[openAi
, azureOpenAi
]
ootbType
[token_count
, faithfulness
, rouge_1
]
type
[guardModel
, nemo
, ootb
, pii
, userModel
]
GuardConfigurationInterventionResponse
{
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
}
Intervention configuration for the guard.
Properties
Name
Type
Required
Restrictions
Description
action
string
true
Action to take if conditions are met
allowedActions
[string]
false
maxItems: 10
The actions this guard is allowed to take.
conditionLogic
string
false
Action to take if conditions are met
conditions
[GuardConfigurationConditionResponse ]
true
maxItems: 1
List of conditions to trigger intervention
message
string
true
maxLength: 255
Message to use if prompt or response is blocked
sendNotification
boolean
false
Create a notification event if intervention is triggered
Enumerated Values
Property
Value
action
[block
, report
, replace
]
conditionLogic
any
GuardConfigurationListResponse
{
"count" : 0 ,
"data" : [
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"deploymentId" : "string" ,
"description" : "string" ,
"entityId" : "string" ,
"entityType" : "customModel" ,
"errorMessage" : "string" ,
"id" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : [
{
"defaultValue" : 0 ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : 0
}
],
"stages" : [
"prompt"
],
"type" : "guardModel"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
false
Number of items returned on this page.
data
[GuardConfigurationRetrieveResponse ]
true
maxItems: 200
list of guard configurations.
next
string(uri)¦null
true
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
URL pointing to the previous page (if null, there is no previous page).
totalCount
integer
true
The total number of items across all pages.
GuardConfigurationMetricBaselineValue
Properties
Name
Type
Required
Restrictions
Description
value
number
true
Custom metric baseline value
GuardConfigurationMetricTimestampSpoofingResponse
{
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
}
Custom metric timestamp
Properties
Name
Type
Required
Restrictions
Description
columnName
string
false
maxLength: 255
Timestamp column name
timeFormat
string
true
Timestamp format
Enumerated Values
Property
Value
timeFormat
[%m/%d/%Y
, %m/%d/%y
, %d/%m/%y
, %m-%d-%Y
, %m-%d-%y
, %Y/%m/%d
, %Y-%m-%d
, %Y-%m-%d %H:%M:%S
, %Y/%m/%d %H:%M:%S
, %Y.%m.%d %H:%M:%S
, %Y-%m-%d %H:%M
, %Y/%m/%d %H:%M
, %y/%m/%d
, %y-%m-%d
, %y-%m-%d %H:%M:%S
, %y.%m.%d %H:%M:%S
, %y/%m/%d %H:%M:%S
, %y-%m-%d %H:%M
, %y.%m.%d %H:%M
, %y/%m/%d %H:%M
, %m/%d/%Y %H:%M
, %m/%d/%y %H:%M
, %d/%m/%Y %H:%M
, %d/%m/%y %H:%M
, %m-%d-%Y %H:%M
, %m-%d-%y %H:%M
, %d-%m-%Y %H:%M
, %d-%m-%y %H:%M
, %m.%d.%Y %H:%M
, %m/%d.%y %H:%M
, %d.%m.%Y %H:%M
, %d.%m.%y %H:%M
, %m/%d/%Y %H:%M:%S
, %m/%d/%y %H:%M:%S
, %m-%d-%Y %H:%M:%S
, %m-%d-%y %H:%M:%S
, %m.%d.%Y %H:%M:%S
, %m.%d.%y %H:%M:%S
, %d/%m/%Y %H:%M:%S
, %d/%m/%y %H:%M:%S
, %Y-%m-%d %H:%M:%S.%f
, %y-%m-%d %H:%M:%S.%f
, %Y-%m-%dT%H:%M:%S.%fZ
, %y-%m-%dT%H:%M:%S.%fZ
, %Y-%m-%dT%H:%M:%S.%f
, %y-%m-%dT%H:%M:%S.%f
, %Y-%m-%dT%H:%M:%S
, %y-%m-%dT%H:%M:%S
, %Y-%m-%dT%H:%M:%SZ
, %y-%m-%dT%H:%M:%SZ
, %Y.%m.%d %H:%M:%S.%f
, %y.%m.%d %H:%M:%S.%f
, %Y.%m.%dT%H:%M:%S.%fZ
, %y.%m.%dT%H:%M:%S.%fZ
, %Y.%m.%dT%H:%M:%S.%f
, %y.%m.%dT%H:%M:%S.%f
, %Y.%m.%dT%H:%M:%S
, %y.%m.%dT%H:%M:%S
, %Y.%m.%dT%H:%M:%SZ
, %y.%m.%dT%H:%M:%SZ
, %Y%m%d
, %m %d %Y %H %M %S
, %m %d %y %H %M %S
, %H:%M
, %M:%S
, %H:%M:%S
, %Y %m %d %H %M %S
, %y %m %d %H %M %S
, %Y %m %d
, %y %m %d
, %d/%m/%Y
, %Y-%d-%m
, %y-%d-%m
, %Y/%d/%m %H:%M:%S.%f
, %Y/%d/%m %H:%M:%S.%fZ
, %Y/%m/%d %H:%M:%S.%f
, %Y/%m/%d %H:%M:%S.%fZ
, %y/%d/%m %H:%M:%S.%f
, %y/%d/%m %H:%M:%S.%fZ
, %y/%m/%d %H:%M:%S.%f
, %y/%m/%d %H:%M:%S.%fZ
, %m.%d.%Y
, %m.%d.%y
, %d.%m.%y
, %d.%m.%Y
, %Y.%m.%d
, %Y.%d.%m
, %y.%m.%d
, %y.%d.%m
, %Y-%m-%d %I:%M:%S %p
, %Y/%m/%d %I:%M:%S %p
, %Y.%m.%d %I:%M:%S %p
, %Y-%m-%d %I:%M %p
, %Y/%m/%d %I:%M %p
, %y-%m-%d %I:%M:%S %p
, %y.%m.%d %I:%M:%S %p
, %y/%m/%d %I:%M:%S %p
, %y-%m-%d %I:%M %p
, %y.%m.%d %I:%M %p
, %y/%m/%d %I:%M %p
, %m/%d/%Y %I:%M %p
, %m/%d/%y %I:%M %p
, %d/%m/%Y %I:%M %p
, %d/%m/%y %I:%M %p
, %m-%d-%Y %I:%M %p
, %m-%d-%y %I:%M %p
, %d-%m-%Y %I:%M %p
, %d-%m-%y %I:%M %p
, %m.%d.%Y %I:%M %p
, %m/%d.%y %I:%M %p
, %d.%m.%Y %I:%M %p
, %d.%m.%y %I:%M %p
, %m/%d/%Y %I:%M:%S %p
, %m/%d/%y %I:%M:%S %p
, %m-%d-%Y %I:%M:%S %p
, %m-%d-%y %I:%M:%S %p
, %m.%d.%Y %I:%M:%S %p
, %m.%d.%y %I:%M:%S %p
, %d/%m/%Y %I:%M:%S %p
, %d/%m/%y %I:%M:%S %p
, %Y-%m-%d %I:%M:%S.%f %p
, %y-%m-%d %I:%M:%S.%f %p
, %Y-%m-%dT%I:%M:%S.%fZ %p
, %y-%m-%dT%I:%M:%S.%fZ %p
, %Y-%m-%dT%I:%M:%S.%f %p
, %y-%m-%dT%I:%M:%S.%f %p
, %Y-%m-%dT%I:%M:%S %p
, %y-%m-%dT%I:%M:%S %p
, %Y-%m-%dT%I:%M:%SZ %p
, %y-%m-%dT%I:%M:%SZ %p
, %Y.%m.%d %I:%M:%S.%f %p
, %y.%m.%d %I:%M:%S.%f %p
, %Y.%m.%dT%I:%M:%S.%fZ %p
, %y.%m.%dT%I:%M:%S.%fZ %p
, %Y.%m.%dT%I:%M:%S.%f %p
, %y.%m.%dT%I:%M:%S.%f %p
, %Y.%m.%dT%I:%M:%S %p
, %y.%m.%dT%I:%M:%S %p
, %Y.%m.%dT%I:%M:%SZ %p
, %y.%m.%dT%I:%M:%SZ %p
, %m %d %Y %I %M %S %p
, %m %d %y %I %M %S %p
, %I:%M %p
, %I:%M:%S %p
, %Y %m %d %I %M %S %p
, %y %m %d %I %M %S %p
, %Y/%d/%m %I:%M:%S.%f %p
, %Y/%d/%m %I:%M:%S.%fZ %p
, %Y/%m/%d %I:%M:%S.%f %p
, %Y/%m/%d %I:%M:%S.%fZ %p
, %y/%d/%m %I:%M:%S.%f %p
, %y/%d/%m %I:%M:%S.%fZ %p
, %y/%m/%d %I:%M:%S.%f %p
, %y/%m/%d %I:%M:%S.%fZ %p
]
GuardConfigurationModelInfoResponse
{
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
}
Configuration info for guards using deployed models.
Properties
Name
Type
Required
Restrictions
Description
classNames
[string]
false
maxItems: 100
List of class names for multiclass models
inputColumnName
string
true
maxLength: 255
Input column name
modelId
string¦null
false
ID of registered model, for model guards.
modelName
string
false
maxLength: 255
ID of registered model, for .model guards
outputColumnName
string
true
maxLength: 255
Output column name
replacementTextColumnName
string
false
maxLength: 255
Name of the output column with replacement text. Required only if intervention.action is replace
.
targetType
string
true
Target type
Enumerated Values
Property
Value
targetType
[Binary
, Regression
, Multiclass
, TextGeneration
]
GuardConfigurationNemoInfoResponse
{
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
}
Configuration info for NeMo guards.
Properties
Name
Type
Required
Restrictions
Description
actions
string
false
maxLength: 4096
NeMo guardrails actions file
blockedTerms
string
true
maxLength: 4096
NeMo guardrails blocked terms list
credentialId
string¦null
false
NeMo guardrails credential ID (deprecated; use "openai_credential")
llmPrompts
string
false
maxLength: 4096
NeMo guardrails prompts
mainConfig
string
true
maxLength: 4096
Overall NeMo configuration YAML
railsConfig
string
true
maxLength: 4096
NeMo guardrails configuration Colang
GuardConfigurationParameterResponse
{
"defaultValue" : 0 ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : 0
}
Guard runtime parameter
Properties
Name
Type
Required
Restrictions
Description
defaultValue
any
true
Parameter default value
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
string
false
maxLength: 4096
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
continued
Name
Type
Required
Restrictions
Description
description
string
true
maxLength: 255
Parameter description
fieldName
string
true
maxLength: 255
Parameter name
type
string
true
Parameter type
value
any
true
Parameter value
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
string
false
maxLength: 4096
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
Enumerated Values
Property
Value
type
[string
, boolean
, deployment
, numeric
, operator
]
GuardConfigurationPayloadModelInfo
{
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
}
Configuration info for guards using deployed models.
Properties
Name
Type
Required
Restrictions
Description
classNames
[string]
false
maxItems: 100
List of class names for multiclass models
inputColumnName
string
true
maxLength: 255
Input column name
modelId
string¦null
false
ID of registered model, for model guards.
modelName
string
false
maxLength: 255
ID of registered model, for .model guards
outputColumnName
string
true
maxLength: 255
Output column name
replacementTextColumnName
string
false
maxLength: 255
Name of the output column with replacement text. Required only if intervention.action is replace
.
targetType
string¦null
false
Target type
Enumerated Values
Property
Value
targetType
[Binary
, Regression
, Multiclass
, TextGeneration
]
GuardConfigurationPredictionEnvironmentsInUseListResponse
{
"count" : 0 ,
"data" : [
{
"id" : "string" ,
"name" : "string" ,
"usedBy" : [
{
"configurationId" : "string" ,
"deploymentId" : "string" ,
"name" : "string"
}
]
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
false
Number of items returned on this page.
data
[PredictionEnvironmentInUseResponse ]
true
maxItems: 32
list of prediction environments in use for this custom model version.
next
string(uri)¦null
true
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
URL pointing to the previous page (if null, there is no previous page).
totalCount
integer
true
The total number of items across all pages.
GuardConfigurationRetrieveResponse
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"deploymentId" : "string" ,
"description" : "string" ,
"entityId" : "string" ,
"entityType" : "customModel" ,
"errorMessage" : "string" ,
"id" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : [
{
"defaultValue" : 0 ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : 0
}
],
"stages" : [
"prompt"
],
"type" : "guardModel"
}
Properties
Name
Type
Required
Restrictions
Description
createdAt
string(date-time)
true
When the configuration was created.
creatorId
string¦null
false
ID of the user who created the Guard configuration.
creatorName
string
false
maxLength: 1000
Name of the user who created the Guard configuration.
deploymentId
string¦null
false
ID of deployed model, for model guards.
description
string
true
maxLength: 4096
Guard configuration description
entityId
string¦null
true
ID of custom model or playground for this guard.
entityType
string
true
Type of associated entity.
errorMessage
string¦null
false
Error message if the guard configuration is invalid.
id
string
true
Guard configuration object ID
intervention
GuardConfigurationInterventionResponse
false
Intervention configuration for the guard.
isValid
boolean
false
Whether the guard is valid or not.
llmType
string¦null
false
Type of LLM used by this guard
modelInfo
GuardConfigurationModelInfoResponse
false
Configuration info for guards using deployed models.
name
string
true
maxLength: 255
Guard configuration name
nemoInfo
GuardConfigurationNemoInfoResponse
false
Configuration info for NeMo guards.
ootbType
string¦null
false
Guard template "Out of the Box" metric type
openaiApiBase
string¦null
false
maxLength: 255
Azure OpenAI API Base URL
openaiApiKey
string¦null
false
maxLength: 255
Azure OpenAI API Key
openaiCredential
string¦null
false
ID of user credential containing an OpenAI token.
openaiDeploymentId
string¦null
false
maxLength: 255
Open API Deployment ID
parameters
[GuardConfigurationParameterResponse ]
true
maxItems: 1
List of guard runtime parameters. Deprecated.
stages
[string]
true
maxItems: 16
The stages where the guard is configured to run.
type
string
true
Guard configuration type
Enumerated Values
Property
Value
entityType
[customModel
, customModelVersion
, playground
]
llmType
[openAi
, azureOpenAi
]
ootbType
[token_count
, faithfulness
, rouge_1
]
type
[guardModel
, nemo
, ootb
, pii
, userModel
]
GuardConfigurationToCustomModelResponse
{
"customModelVersionId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
customModelVersionId
string
true
ID of the new custom model version created.
GuardConfigurationToCustomModelVersion
{
"customModelId" : "string" ,
"data" : [
{
"customMetric" : {
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"deploymentId" : "string" ,
"description" : "string" ,
"errorMessage" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : [
{
"defaultValue" : 0 ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : 0
}
],
"stages" : [
"prompt"
],
"type" : "guardModel"
}
],
"overallConfig" : {
"timeoutAction" : "block" ,
"timeoutSec" : 2
}
}
Properties
Name
Type
Required
Restrictions
Description
customModelId
string
true
ID the custom model the user is working with.
data
[GuardConfigurationFullPost ]
true
maxItems: 200
List of complete guard configurations to push
overallConfig
OverallConfigUpdate
false
Overall moderation configuration to push (not specific to one guard)
GuardConfigurationUpdate
{
"customMetric" : {
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"deploymentId" : "string" ,
"description" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"message" : "string" ,
"sendNotification" : false
},
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "string" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "string" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiCredential" : "string" ,
"openaiDeploymentId" : "string" ,
"parameters" : []
}
Properties
Name
Type
Required
Restrictions
Description
customMetric
GuardConfigurationCustomMetricResponse
false
Custom metric configuration for the guard.
deploymentId
string¦null
false
ID of deployed model, for model guards.
description
string
false
maxLength: 4096
Guard configuration description
intervention
GuardConfigurationInterventionResponse
false
Intervention configuration for the guard.
llmType
string¦null
false
Type of LLM used by this guard
modelInfo
GuardConfigurationPayloadModelInfo
false
Configuration info for guards using deployed models.
name
string
false
maxLength: 255
Guard configuration name
nemoInfo
GuardConfigurationNemoInfoResponse
false
Configuration info for NeMo guards.
openaiApiBase
string¦null
false
maxLength: 255
Azure OpenAI API Base URL
openaiApiKey
string¦null
false
maxLength: 255
Azure OpenAI API Key
openaiCredential
string¦null
false
ID of user credential containing an OpenAI token.
openaiDeploymentId
string¦null
false
maxLength: 255
Open API Deployment ID
parameters
[GuardConfigurationParameterResponse ]
false
maxItems: 1
List of guard runtime parameters. Deprecated.
Enumerated Values
Property
Value
llmType
[openAi
, azureOpenAi
]
GuardConfigurationValueFieldResponse
{
"columnName" : "string"
}
Custom metric value
Properties
Name
Type
Required
Restrictions
Description
columnName
string
false
maxLength: 255
Timestamp column name
GuardCustomMetricResponse
{
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
Custom metric configuration for the guard.
Properties
Name
Type
Required
Restrictions
Description
baselineValues
[GuardMetricBaselineValue ]
true
maxItems: 5
Custom metric baseline values
description
string
true
maxLength: 1000
Custom metric description
directionality
string
true
Custom metric direction
isModelSpecific
boolean
true
Is custom metric specific to a model
name
string
true
maxLength: 255
Custom metric name
timestamp
GuardMetricTimestampSpoofingResponse
true
Custom metric timestamp
type
string
true
Custom metric type
units
string
true
maxLength: 255
Custom metric units
value
GuardValueFieldResponse
true
Custom metric value
Enumerated Values
Property
Value
directionality
[higherIsBetter
, lowerIsBetter
]
type
[average
, gauge
, sum
]
GuardInterventionResponse
{
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"modifyMessage" : "string" ,
"sendNotification" : true
}
Intervention configuration for the guard.
Properties
Name
Type
Required
Restrictions
Description
action
string
true
Action to take if conditions are met
allowedActions
[string]
false
maxItems: 10
The actions this guard is allowed to take.
conditionLogic
string
false
Action to take if conditions are met
conditions
[GuardConditionResponse ]
true
maxItems: 1
List of conditions to trigger intervention
modifyMessage
string
true
maxLength: 255
Message to use if prompt or response is blocked
sendNotification
boolean
false
Create a notification event if intervention is triggered
Enumerated Values
Property
Value
action
[block
, report
, replace
]
conditionLogic
any
GuardMetricBaselineValue
Properties
Name
Type
Required
Restrictions
Description
value
number
true
Custom metric baseline value
GuardMetricTimestampSpoofingResponse
{
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
}
Custom metric timestamp
Properties
Name
Type
Required
Restrictions
Description
columnName
string
false
maxLength: 255
Timestamp column name
timeFormat
string
true
Timestamp format
Enumerated Values
Property
Value
timeFormat
[%m/%d/%Y
, %m/%d/%y
, %d/%m/%y
, %m-%d-%Y
, %m-%d-%y
, %Y/%m/%d
, %Y-%m-%d
, %Y-%m-%d %H:%M:%S
, %Y/%m/%d %H:%M:%S
, %Y.%m.%d %H:%M:%S
, %Y-%m-%d %H:%M
, %Y/%m/%d %H:%M
, %y/%m/%d
, %y-%m-%d
, %y-%m-%d %H:%M:%S
, %y.%m.%d %H:%M:%S
, %y/%m/%d %H:%M:%S
, %y-%m-%d %H:%M
, %y.%m.%d %H:%M
, %y/%m/%d %H:%M
, %m/%d/%Y %H:%M
, %m/%d/%y %H:%M
, %d/%m/%Y %H:%M
, %d/%m/%y %H:%M
, %m-%d-%Y %H:%M
, %m-%d-%y %H:%M
, %d-%m-%Y %H:%M
, %d-%m-%y %H:%M
, %m.%d.%Y %H:%M
, %m/%d.%y %H:%M
, %d.%m.%Y %H:%M
, %d.%m.%y %H:%M
, %m/%d/%Y %H:%M:%S
, %m/%d/%y %H:%M:%S
, %m-%d-%Y %H:%M:%S
, %m-%d-%y %H:%M:%S
, %m.%d.%Y %H:%M:%S
, %m.%d.%y %H:%M:%S
, %d/%m/%Y %H:%M:%S
, %d/%m/%y %H:%M:%S
, %Y-%m-%d %H:%M:%S.%f
, %y-%m-%d %H:%M:%S.%f
, %Y-%m-%dT%H:%M:%S.%fZ
, %y-%m-%dT%H:%M:%S.%fZ
, %Y-%m-%dT%H:%M:%S.%f
, %y-%m-%dT%H:%M:%S.%f
, %Y-%m-%dT%H:%M:%S
, %y-%m-%dT%H:%M:%S
, %Y-%m-%dT%H:%M:%SZ
, %y-%m-%dT%H:%M:%SZ
, %Y.%m.%d %H:%M:%S.%f
, %y.%m.%d %H:%M:%S.%f
, %Y.%m.%dT%H:%M:%S.%fZ
, %y.%m.%dT%H:%M:%S.%fZ
, %Y.%m.%dT%H:%M:%S.%f
, %y.%m.%dT%H:%M:%S.%f
, %Y.%m.%dT%H:%M:%S
, %y.%m.%dT%H:%M:%S
, %Y.%m.%dT%H:%M:%SZ
, %y.%m.%dT%H:%M:%SZ
, %Y%m%d
, %m %d %Y %H %M %S
, %m %d %y %H %M %S
, %H:%M
, %M:%S
, %H:%M:%S
, %Y %m %d %H %M %S
, %y %m %d %H %M %S
, %Y %m %d
, %y %m %d
, %d/%m/%Y
, %Y-%d-%m
, %y-%d-%m
, %Y/%d/%m %H:%M:%S.%f
, %Y/%d/%m %H:%M:%S.%fZ
, %Y/%m/%d %H:%M:%S.%f
, %Y/%m/%d %H:%M:%S.%fZ
, %y/%d/%m %H:%M:%S.%f
, %y/%d/%m %H:%M:%S.%fZ
, %y/%m/%d %H:%M:%S.%f
, %y/%m/%d %H:%M:%S.%fZ
, %m.%d.%Y
, %m.%d.%y
, %d.%m.%y
, %d.%m.%Y
, %Y.%m.%d
, %Y.%d.%m
, %y.%m.%d
, %y.%d.%m
, %Y-%m-%d %I:%M:%S %p
, %Y/%m/%d %I:%M:%S %p
, %Y.%m.%d %I:%M:%S %p
, %Y-%m-%d %I:%M %p
, %Y/%m/%d %I:%M %p
, %y-%m-%d %I:%M:%S %p
, %y.%m.%d %I:%M:%S %p
, %y/%m/%d %I:%M:%S %p
, %y-%m-%d %I:%M %p
, %y.%m.%d %I:%M %p
, %y/%m/%d %I:%M %p
, %m/%d/%Y %I:%M %p
, %m/%d/%y %I:%M %p
, %d/%m/%Y %I:%M %p
, %d/%m/%y %I:%M %p
, %m-%d-%Y %I:%M %p
, %m-%d-%y %I:%M %p
, %d-%m-%Y %I:%M %p
, %d-%m-%y %I:%M %p
, %m.%d.%Y %I:%M %p
, %m/%d.%y %I:%M %p
, %d.%m.%Y %I:%M %p
, %d.%m.%y %I:%M %p
, %m/%d/%Y %I:%M:%S %p
, %m/%d/%y %I:%M:%S %p
, %m-%d-%Y %I:%M:%S %p
, %m-%d-%y %I:%M:%S %p
, %m.%d.%Y %I:%M:%S %p
, %m.%d.%y %I:%M:%S %p
, %d/%m/%Y %I:%M:%S %p
, %d/%m/%y %I:%M:%S %p
, %Y-%m-%d %I:%M:%S.%f %p
, %y-%m-%d %I:%M:%S.%f %p
, %Y-%m-%dT%I:%M:%S.%fZ %p
, %y-%m-%dT%I:%M:%S.%fZ %p
, %Y-%m-%dT%I:%M:%S.%f %p
, %y-%m-%dT%I:%M:%S.%f %p
, %Y-%m-%dT%I:%M:%S %p
, %y-%m-%dT%I:%M:%S %p
, %Y-%m-%dT%I:%M:%SZ %p
, %y-%m-%dT%I:%M:%SZ %p
, %Y.%m.%d %I:%M:%S.%f %p
, %y.%m.%d %I:%M:%S.%f %p
, %Y.%m.%dT%I:%M:%S.%fZ %p
, %y.%m.%dT%I:%M:%S.%fZ %p
, %Y.%m.%dT%I:%M:%S.%f %p
, %y.%m.%dT%I:%M:%S.%f %p
, %Y.%m.%dT%I:%M:%S %p
, %y.%m.%dT%I:%M:%S %p
, %Y.%m.%dT%I:%M:%SZ %p
, %y.%m.%dT%I:%M:%SZ %p
, %m %d %Y %I %M %S %p
, %m %d %y %I %M %S %p
, %I:%M %p
, %I:%M:%S %p
, %Y %m %d %I %M %S %p
, %y %m %d %I %M %S %p
, %Y/%d/%m %I:%M:%S.%f %p
, %Y/%d/%m %I:%M:%S.%fZ %p
, %Y/%m/%d %I:%M:%S.%f %p
, %Y/%m/%d %I:%M:%S.%fZ %p
, %y/%d/%m %I:%M:%S.%f %p
, %y/%d/%m %I:%M:%S.%fZ %p
, %y/%m/%d %I:%M:%S.%f %p
, %y/%m/%d %I:%M:%S.%fZ %p
]
GuardModelInfoResponse
{
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
}
Configuration info for guards using deployed models.
Properties
Name
Type
Required
Restrictions
Description
classNames
[string]
false
maxItems: 100
List of class names for multiclass models
inputColumnName
string
true
maxLength: 255
Input column name
modelId
string¦null
false
ID of registered model, for model guards.
modelName
string
false
maxLength: 255
ID of registered model, for .model guards
outputColumnName
string
true
maxLength: 255
Output column name
replacementTextColumnName
string
false
maxLength: 255
Name of the output column with replacement text. Required only if intervention.action is replace
.
targetType
string
true
Target type
Enumerated Values
Property
Value
targetType
[Binary
, Regression
, Multiclass
, TextGeneration
]
GuardNemoInfoResponse
{
"actions" : "" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
}
Configuration info for NeMo guards.
Properties
Name
Type
Required
Restrictions
Description
actions
string
false
maxLength: 4096
NeMo guardrails actions
blockedTerms
string
true
maxLength: 4096
NeMo guardrails blocked terms list
credentialId
string¦null
false
NeMo guardrails credential ID (deprecated; use "openai_api_key")
llmPrompts
string
false
maxLength: 4096
NeMo guardrails prompts
mainConfig
string
true
maxLength: 4096
Overall NeMo configuration YAML
railsConfig
string
true
maxLength: 4096
NeMo guardrails configuration Colang
GuardParameterResponse
{
"defaultValue" : "string" ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : "string"
}
Guard runtime parameter
Properties
Name
Type
Required
Restrictions
Description
defaultValue
string
true
maxLength: 4096
Parameter default value
description
string
true
maxLength: 255
Parameter description
fieldName
string
true
maxLength: 255
Parameter name
type
string
true
Parameter type
value
string
false
maxLength: 4096
Parameter default value
Enumerated Values
Property
Value
type
[string
, boolean
, deployment
, numeric
, operator
]
GuardTemplateListResponse
{
"count" : 0 ,
"data" : [
{
"additionalConfig" : "string" ,
"allowedStages" : [
"prompt"
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"customMetric" : {
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"description" : "string" ,
"errorMessage" : "string" ,
"id" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"modifyMessage" : "string" ,
"sendNotification" : true
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiDeploymentId" : "string" ,
"orgId" : "string" ,
"parameters" : [
{
"defaultValue" : "string" ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : "string"
}
],
"productionOnly" : true ,
"type" : "guardModel"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
false
Number of items returned on this page.
data
[GuardTemplateRetrieveResponse ]
true
maxItems: 200
list of guard templates.
next
string(uri)¦null
true
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
URL pointing to the previous page (if null, there is no previous page).
totalCount
integer
true
The total number of items across all pages.
GuardTemplateRetrieveResponse
{
"additionalConfig" : "string" ,
"allowedStages" : [
"prompt"
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"customMetric" : {
"baselineValues" : [
{
"value" : 0
}
],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"description" : "string" ,
"errorMessage" : "string" ,
"id" : "string" ,
"intervention" : {
"action" : "block" ,
"allowedActions" : [
"block"
],
"conditionLogic" : "any" ,
"conditions" : [
{
"comparand" : 0 ,
"comparator" : "greaterThan"
}
],
"modifyMessage" : "string" ,
"sendNotification" : true
},
"isValid" : true ,
"llmType" : "openAi" ,
"modelInfo" : {
"classNames" : [
"string"
],
"inputColumnName" : "string" ,
"modelId" : "string" ,
"modelName" : "" ,
"outputColumnName" : "string" ,
"replacementTextColumnName" : "" ,
"targetType" : "Binary"
},
"name" : "string" ,
"nemoInfo" : {
"actions" : "" ,
"blockedTerms" : "string" ,
"credentialId" : "string" ,
"llmPrompts" : "" ,
"mainConfig" : "string" ,
"railsConfig" : "string"
},
"ootbType" : "token_count" ,
"openaiApiBase" : "string" ,
"openaiApiKey" : "string" ,
"openaiDeploymentId" : "string" ,
"orgId" : "string" ,
"parameters" : [
{
"defaultValue" : "string" ,
"description" : "string" ,
"fieldName" : "string" ,
"type" : "string" ,
"value" : "string"
}
],
"productionOnly" : true ,
"type" : "guardModel"
}
Properties
Name
Type
Required
Restrictions
Description
additionalConfig
string
false
maxLength: 4096
Guard template additional configuration
allowedStages
[string]
true
maxItems: 16
The stages where the guard can run.
createdAt
string(date-time)
true
When the template was created.
creatorId
string¦null
false
ID of the user who created the Guard template.
creatorName
string
false
maxLength: 1000
ID of the user who created the Guard template.
customMetric
GuardCustomMetricResponse
false
Custom metric configuration for the guard.
description
string
true
maxLength: 4096
Guard template description
errorMessage
string¦null
false
Error message if the guard configuration is invalid.
id
string
true
Guard template object ID
intervention
GuardInterventionResponse
false
Intervention configuration for the guard.
isValid
boolean
false
True if the guard is fully configured and valid.
llmType
string¦null
false
Type of LLM used by this guard
modelInfo
GuardModelInfoResponse
false
Configuration info for guards using deployed models.
name
string
true
maxLength: 255
Guard template name
nemoInfo
GuardNemoInfoResponse
false
Configuration info for NeMo guards.
ootbType
string¦null
false
Guard template "Out of the Box" metric type
openaiApiBase
string¦null
false
maxLength: 255
Azure OpenAI API Base URL
openaiApiKey
string¦null
false
maxLength: 255
Azure OpenAI API Key
openaiDeploymentId
string¦null
false
maxLength: 255
Open API Deployment ID
orgId
string¦null
false
Organization ID of the user who created the Guard template.
parameters
[GuardParameterResponse ]
true
maxItems: 1
List of guard runtime parameters. Deprecated.
productionOnly
boolean¦null
false
Whether the guard is for production only, or if it can be used in production and playground.
type
string
true
Guard template type
Enumerated Values
Property
Value
llmType
[openAi
, azureOpenAi
]
ootbType
[token_count
, faithfulness
, rouge_1
]
type
[guardModel
, nemo
, ootb
, pii
, userModel
]
GuardValueFieldResponse
{
"columnName" : "string"
}
Custom metric value
Properties
Name
Type
Required
Restrictions
Description
columnName
string
false
maxLength: 255
Timestamp column name
OverallConfigUpdate
{
"timeoutAction" : "block" ,
"timeoutSec" : 2
}
Overall moderation configuration to push (not specific to one guard)
Properties
Name
Type
Required
Restrictions
Description
timeoutAction
string
true
Action to take if timeout occurs
timeoutSec
integer
true
minimum: 2
Timeout value in seconds for any guard
Enumerated Values
Property
Value
timeoutAction
[block
, score
]
OverallModerationConfigurationResponse
{
"entityId" : "string" ,
"entityType" : "customModel" ,
"timeoutAction" : "block" ,
"timeoutSec" : 2 ,
"updatedAt" : "2019-08-24T14:15:22Z" ,
"updaterId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
entityId
string
true
ID of custom model or playground for this configuration.
entityType
string
true
Type of associated entity.
timeoutAction
string
true
Action to take if timeout occurs
timeoutSec
integer
true
minimum: 2
Timeout value in seconds for any guard
updatedAt
string(date-time)
false
When the configuration was updated.
updaterId
string¦null
true
ID of user who updated the configuration.
Enumerated Values
Property
Value
entityType
[customModel
, customModelVersion
, playground
]
timeoutAction
[block
, score
]
OverallModerationConfigurationUpdate
{
"entityId" : "string" ,
"entityType" : "customModel" ,
"timeoutAction" : "block" ,
"timeoutSec" : 0
}
Properties
Name
Type
Required
Restrictions
Description
entityId
string
true
ID of custom model or playground for this configuration.
entityType
string
true
Type of associated entity.
timeoutAction
string
true
Action to take if timeout occurs
timeoutSec
integer
true
minimum: 0
Timeout value in seconds for any guard
Enumerated Values
Property
Value
entityType
[customModel
, customModelVersion
, playground
]
timeoutAction
[block
, score
]
{
"baseImageId" : "string" ,
"created" : "2019-08-24T14:15:22Z" ,
"datarobotRuntimeImageTag" : "string" ,
"dockerImageId" : "string" ,
"filename" : "string" ,
"hash" : "string" ,
"hashAlgorithm" : "SHA256" ,
"imageSize" : 0 ,
"shortDockerImageId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
baseImageId
string
true
Internal base image entity id for troubleshooting purposes
created
string(date-time)
true
ISO formatted image upload date
datarobotRuntimeImageTag
string¦null
false
For internal use only.
dockerImageId
string
true
A Docker image id (immutable, content-based) hash associated with the given image
filename
string
true
The name of the file when the download requested
hash
string
true
Hash of the image content, supposed to be used for verifying content after the download. The algorithm used for hashing is specified in hashAlgorithm
field. Note that hash is calculated over compressed image data.
hashAlgorithm
string
true
An algorithm name used for calculating content hash
imageSize
integer
true
Size in bytes of the compressed PPS image data
shortDockerImageId
string
true
A 12-chars shortened version of the dockerImageId
as shown in 'docker images' command line command output
Enumerated Values
Property
Value
hashAlgorithm
SHA256
PredictionEnvironmentInUseResponse
{
"id" : "string" ,
"name" : "string" ,
"usedBy" : [
{
"configurationId" : "string" ,
"deploymentId" : "string" ,
"name" : "string"
}
]
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
ID of prediction environment.
name
string
true
Name of prediction environment.
usedBy
[DeploymentAndGuardResponse ]
true
maxItems: 32
Guards using this prediction environment.
Updated July 23, 2024
Submit
Thanks for your feedback!