Skip to content

On-premise users: click in-app to access the full platform documentation for your version of DataRobot.

DataRobot API resources > API reference documentation > DataRobot REST API > Generative AI > LLM blueprints

LLM Generation (GenAI)

This page outlines the operations, endpoints, parameters, and example requests and responses for the LLM Generation (GenAI).

GET /api/v2/genai/customModelLLMValidations/

List custom model LLM validations.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/customModelLLMValidations/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
useCaseId query any false Only retrieve the custom model LLM validations associated with these use case IDs.
playgroundId query any false Only retrieve the custom model LLM validations associated with this playground ID.
offset query integer false Skip the specified number of values.
limit query integer false Retrieve only the specified number of values.
search query any false Only retrieve the custom model LLM validations matching the search query.
sort query any false Apply this sort order to the results. Valid options are "name", "deploymentName", "userName", "creationDate". Prefix the attribute name with a dash to sort in descending order, e.g., sort=-creationDate.
completedOnly query boolean false If true, only retrieve the completed custom model LLM validations. The default is false.
deploymentId query any false Only retrieve the custom model LLM validations associated with this deployment ID.
modelId query any false Only retrieve the custom model LLM validations associated with this model ID.
promptColumnName query any false Only retrieve the custom model LLM validations where the custom model uses this column name for prompt input.
targetColumnName query any false Only retrieve the custom model LLM validations where the custom model uses this column name for prediction output.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "chatModelId": "string",
      "creationDate": "2019-08-24T14:15:22Z",
      "deploymentAccessData": {
        "authorizationHeader": "[REDACTED]",
        "chatApiUrl": "string",
        "datarobotKey": "string",
        "inputType": "CSV",
        "modelType": "TEXT_GENERATION",
        "predictionApiUrl": "string"
      },
      "deploymentId": "string",
      "deploymentName": "string",
      "errorMessage": "string",
      "id": "string",
      "modelId": "string",
      "name": "string",
      "predictionTimeout": 0,
      "promptColumnName": "string",
      "targetColumnName": "string",
      "tenantId": "string",
      "useCaseId": "string",
      "userId": "string",
      "userName": "string",
      "validationStatus": "TESTING"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Custom model LLM validations successfully retrieved. ListCustomModelLLMValidationsResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/genai/customModelLLMValidations/

Validate an LLM hosted in a custom model deployment for use in the playground.

Code samples

curl -X POST https://app.datarobot.com/api/v2/genai/customModelLLMValidations/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{CreateCustomModelLLMValidationRequest}'

Body parameter

{
  "chatModelId": "string",
  "deploymentId": "string",
  "modelId": "string",
  "name": "Untitled",
  "predictionTimeout": 300,
  "promptColumnName": "string",
  "targetColumnName": "string",
  "useCaseId": "string"
}

Parameters

Name In Type Required Description
body body CreateCustomModelLLMValidationRequest true none

Example responses

202 Response

{
  "chatModelId": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "deploymentAccessData": {
    "authorizationHeader": "[REDACTED]",
    "chatApiUrl": "string",
    "datarobotKey": "string",
    "inputType": "CSV",
    "modelType": "TEXT_GENERATION",
    "predictionApiUrl": "string"
  },
  "deploymentId": "string",
  "deploymentName": "string",
  "errorMessage": "string",
  "id": "string",
  "modelId": "string",
  "name": "string",
  "predictionTimeout": 0,
  "promptColumnName": "string",
  "targetColumnName": "string",
  "tenantId": "string",
  "useCaseId": "string",
  "userId": "string",
  "userName": "string",
  "validationStatus": "TESTING"
}

Responses

Status Meaning Description Schema
202 Accepted Custom model LLM validation job successfully accepted. Follow the Location header to poll for job execution status. CustomModelLLMValidationResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/genai/customModelLLMValidations/{validationId}/

Delete an existing custom model LLM validation.

Code samples

curl -X DELETE https://app.datarobot.com/api/v2/genai/customModelLLMValidations/{validationId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
validationId path string true The ID of the custom model LLM validation to delete.

Example responses

422 Response

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
204 No Content Custom model LLM validation successfully deleted. None
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/customModelLLMValidations/{validationId}/

Retrieve the status of validating a custom model LLM.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/customModelLLMValidations/{validationId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
validationId path string true The ID of the custom model LLM validation to retrieve.

Example responses

200 Response

{
  "chatModelId": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "deploymentAccessData": {
    "authorizationHeader": "[REDACTED]",
    "chatApiUrl": "string",
    "datarobotKey": "string",
    "inputType": "CSV",
    "modelType": "TEXT_GENERATION",
    "predictionApiUrl": "string"
  },
  "deploymentId": "string",
  "deploymentName": "string",
  "errorMessage": "string",
  "id": "string",
  "modelId": "string",
  "name": "string",
  "predictionTimeout": 0,
  "promptColumnName": "string",
  "targetColumnName": "string",
  "tenantId": "string",
  "useCaseId": "string",
  "userId": "string",
  "userName": "string",
  "validationStatus": "TESTING"
}

Responses

Status Meaning Description Schema
200 OK Custom model LLM validation status successfully retrieved. CustomModelLLMValidationResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/genai/customModelLLMValidations/{validationId}/

Edit an existing custom model LLM validation.

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/genai/customModelLLMValidations/{validationId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "chatModelId": "string",
  "deploymentId": "string",
  "modelId": "string",
  "name": "string",
  "predictionTimeout": 1,
  "promptColumnName": "string",
  "targetColumnName": "string"
}

Parameters

Name In Type Required Description
validationId path string true The ID of the custom model LLM validation to edit.
body body EditCustomModelValidationRequest true none

Example responses

200 Response

{
  "chatModelId": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "deploymentAccessData": {
    "authorizationHeader": "[REDACTED]",
    "chatApiUrl": "string",
    "datarobotKey": "string",
    "inputType": "CSV",
    "modelType": "TEXT_GENERATION",
    "predictionApiUrl": "string"
  },
  "deploymentId": "string",
  "deploymentName": "string",
  "errorMessage": "string",
  "id": "string",
  "modelId": "string",
  "name": "string",
  "predictionTimeout": 0,
  "promptColumnName": "string",
  "targetColumnName": "string",
  "tenantId": "string",
  "useCaseId": "string",
  "userId": "string",
  "userName": "string",
  "validationStatus": "TESTING"
}

Responses

Status Meaning Description Schema
200 OK Custom model LLM validation successfully updated. CustomModelLLMValidationResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/genai/customModelLLMValidations/{validationId}/revalidate/

Revalidate an existing custom model LLM validation.

Code samples

curl -X POST https://app.datarobot.com/api/v2/genai/customModelLLMValidations/{validationId}/revalidate/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
validationId path string true The ID of the custom model LLM validation to revalidate.

Example responses

200 Response

{
  "chatModelId": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "deploymentAccessData": {
    "authorizationHeader": "[REDACTED]",
    "chatApiUrl": "string",
    "datarobotKey": "string",
    "inputType": "CSV",
    "modelType": "TEXT_GENERATION",
    "predictionApiUrl": "string"
  },
  "deploymentId": "string",
  "deploymentName": "string",
  "errorMessage": "string",
  "id": "string",
  "modelId": "string",
  "name": "string",
  "predictionTimeout": 0,
  "promptColumnName": "string",
  "targetColumnName": "string",
  "tenantId": "string",
  "useCaseId": "string",
  "userId": "string",
  "userName": "string",
  "validationStatus": "TESTING"
}

Responses

Status Meaning Description Schema
200 OK Custom model LLM successfully revalidated. CustomModelLLMValidationResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/genai/customModelVersions/

Export the specified LLM blueprint as a custom model version in Model Registry.

Code samples

curl -X POST https://app.datarobot.com/api/v2/genai/customModelVersions/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{CreateCustomModelVersionRequest}'

Body parameter

{
  "insightsConfiguration": [],
  "llmBlueprintId": "string",
  "llmTestConfigurationIds": [],
  "promptColumnName": "promptText",
  "targetColumnName": "resultText"
}

Parameters

Name In Type Required Description
body body CreateCustomModelVersionRequest true none

Example responses

202 Response

{
  "customModelId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Successful Response CreateCustomModelVersionResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/llmBlueprints/

List LLM blueprints.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/llmBlueprints/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
playgroundId query any false Playground ID.
llmIds query any false Retrieve only the LLM blueprints that use the specified LLM IDs.
vectorDatabaseIds query any false Retrieve only the LLM blueprints linked to the specified vector database IDs.
isSaved query any false Retrieve only the LLM blueprints that have the specified draft/saved status.
isStarred query any false Retrieve only the LLM blueprints that have the specified starred status.
offset query integer false Skip the specified number of values.
limit query integer false Retrieve only the specified number of values.
sort query any false Apply this sort order to the results. Valid options are "name", "description", "creationDate", "lastUpdateDate", "llmId", "vectorDatabaseId". Prefix the attribute name with a dash to sort in descending order, e.g., sort=-creationDate.
creationUserIds query any false Retrieve only the LLM blueprints created by these users.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "creationDate": "2019-08-24T14:15:22Z",
      "creationUserId": "string",
      "creationUserName": "string",
      "customModelLLMErrorMessage": "string",
      "customModelLLMErrorResolution": "string",
      "customModelLLMValidationStatus": "TESTING",
      "description": "string",
      "id": "string",
      "isActive": true,
      "isDeprecated": true,
      "isSaved": true,
      "isStarred": true,
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "lastUpdateUserId": "string",
      "llmId": "azure-openai-gpt-3.5-turbo",
      "llmName": "string",
      "llmSettings": {
        "maxCompletionLength": 0,
        "systemPrompt": "string",
        "temperature": 0,
        "topP": 0
      },
      "name": "string",
      "playgroundId": "string",
      "promptType": "CHAT_HISTORY_AWARE",
      "retirementDate": "2019-08-24",
      "vectorDatabaseErrorMessage": "string",
      "vectorDatabaseErrorResolution": "string",
      "vectorDatabaseFamilyId": "string",
      "vectorDatabaseId": "string",
      "vectorDatabaseName": "string",
      "vectorDatabaseSettings": {
        "addNeighborChunks": false,
        "maxDocumentsRetrievedPerPrompt": 1,
        "maxTokens": 1,
        "retriever": "SINGLE_LOOKUP_RETRIEVER"
      },
      "vectorDatabaseStatus": "NEW"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Successful Response ListLLMBlueprintsResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/genai/llmBlueprints/

Create a new LLM blueprint.

Code samples

curl -X POST https://app.datarobot.com/api/v2/genai/llmBlueprints/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{CreateLLMBlueprintRequest}'

Body parameter

{
  "description": "",
  "llmId": "azure-openai-gpt-3.5-turbo",
  "llmSettings": {
    "maxCompletionLength": 0,
    "systemPrompt": "string",
    "temperature": 0,
    "topP": 0
  },
  "name": "string",
  "playgroundId": "string",
  "promptType": "CHAT_HISTORY_AWARE",
  "vectorDatabaseId": "string",
  "vectorDatabaseSettings": {
    "addNeighborChunks": false,
    "maxDocumentsRetrievedPerPrompt": 1,
    "maxTokens": 128,
    "retriever": "SINGLE_LOOKUP_RETRIEVER"
  }
}

Parameters

Name In Type Required Description
body body CreateLLMBlueprintRequest true none

Example responses

201 Response

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "creationUserName": "string",
  "customModelLLMErrorMessage": "string",
  "customModelLLMErrorResolution": "string",
  "customModelLLMValidationStatus": "TESTING",
  "description": "string",
  "id": "string",
  "isActive": true,
  "isDeprecated": true,
  "isSaved": true,
  "isStarred": true,
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "lastUpdateUserId": "string",
  "llmId": "azure-openai-gpt-3.5-turbo",
  "llmName": "string",
  "llmSettings": {
    "maxCompletionLength": 0,
    "systemPrompt": "string",
    "temperature": 0,
    "topP": 0
  },
  "name": "string",
  "playgroundId": "string",
  "promptType": "CHAT_HISTORY_AWARE",
  "retirementDate": "2019-08-24",
  "vectorDatabaseErrorMessage": "string",
  "vectorDatabaseErrorResolution": "string",
  "vectorDatabaseFamilyId": "string",
  "vectorDatabaseId": "string",
  "vectorDatabaseName": "string",
  "vectorDatabaseSettings": {
    "addNeighborChunks": false,
    "maxDocumentsRetrievedPerPrompt": 1,
    "maxTokens": 1,
    "retriever": "SINGLE_LOOKUP_RETRIEVER"
  },
  "vectorDatabaseStatus": "NEW"
}

Responses

Status Meaning Description Schema
201 Created Successful Response LLMBlueprintResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/genai/llmBlueprints/fromChatPrompt/

Create a new LLM blueprint using the LLM and vector database settings currently used by the specified existing chat prompt.

Code samples

curl -X POST https://app.datarobot.com/api/v2/genai/llmBlueprints/fromChatPrompt/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{CreateFromChatPromptRequest}'

Body parameter

{
  "chatPromptId": "string",
  "description": "",
  "name": "string"
}

Parameters

Name In Type Required Description
body body CreateFromChatPromptRequest true none

Example responses

201 Response

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "creationUserName": "string",
  "customModelLLMErrorMessage": "string",
  "customModelLLMErrorResolution": "string",
  "customModelLLMValidationStatus": "TESTING",
  "description": "string",
  "id": "string",
  "isActive": true,
  "isDeprecated": true,
  "isSaved": true,
  "isStarred": true,
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "lastUpdateUserId": "string",
  "llmId": "azure-openai-gpt-3.5-turbo",
  "llmName": "string",
  "llmSettings": {
    "maxCompletionLength": 0,
    "systemPrompt": "string",
    "temperature": 0,
    "topP": 0
  },
  "name": "string",
  "playgroundId": "string",
  "promptType": "CHAT_HISTORY_AWARE",
  "retirementDate": "2019-08-24",
  "vectorDatabaseErrorMessage": "string",
  "vectorDatabaseErrorResolution": "string",
  "vectorDatabaseFamilyId": "string",
  "vectorDatabaseId": "string",
  "vectorDatabaseName": "string",
  "vectorDatabaseSettings": {
    "addNeighborChunks": false,
    "maxDocumentsRetrievedPerPrompt": 1,
    "maxTokens": 1,
    "retriever": "SINGLE_LOOKUP_RETRIEVER"
  },
  "vectorDatabaseStatus": "NEW"
}

Responses

Status Meaning Description Schema
201 Created Successful Response LLMBlueprintResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/genai/llmBlueprints/fromLLMBlueprint/

Create a new LLM blueprint using the LLM and vector database settings currently used by the specified existing LLM blueprint.

Code samples

curl -X POST https://app.datarobot.com/api/v2/genai/llmBlueprints/fromLLMBlueprint/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{CreateFromLLMBlueprintRequest}'

Body parameter

{
  "description": "",
  "llmBlueprintId": "string",
  "name": "string"
}

Parameters

Name In Type Required Description
body body CreateFromLLMBlueprintRequest true none

Example responses

201 Response

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "creationUserName": "string",
  "customModelLLMErrorMessage": "string",
  "customModelLLMErrorResolution": "string",
  "customModelLLMValidationStatus": "TESTING",
  "description": "string",
  "id": "string",
  "isActive": true,
  "isDeprecated": true,
  "isSaved": true,
  "isStarred": true,
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "lastUpdateUserId": "string",
  "llmId": "azure-openai-gpt-3.5-turbo",
  "llmName": "string",
  "llmSettings": {
    "maxCompletionLength": 0,
    "systemPrompt": "string",
    "temperature": 0,
    "topP": 0
  },
  "name": "string",
  "playgroundId": "string",
  "promptType": "CHAT_HISTORY_AWARE",
  "retirementDate": "2019-08-24",
  "vectorDatabaseErrorMessage": "string",
  "vectorDatabaseErrorResolution": "string",
  "vectorDatabaseFamilyId": "string",
  "vectorDatabaseId": "string",
  "vectorDatabaseName": "string",
  "vectorDatabaseSettings": {
    "addNeighborChunks": false,
    "maxDocumentsRetrievedPerPrompt": 1,
    "maxTokens": 1,
    "retriever": "SINGLE_LOOKUP_RETRIEVER"
  },
  "vectorDatabaseStatus": "NEW"
}

Responses

Status Meaning Description Schema
201 Created Successful Response LLMBlueprintResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/genai/llmBlueprints/{llmBlueprintId}/

Delete an existing LLM blueprint.

Code samples

curl -X DELETE https://app.datarobot.com/api/v2/genai/llmBlueprints/{llmBlueprintId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
llmBlueprintId path string true The ID of the LLM blueprint to delete.

Example responses

422 Response

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
204 No Content Successful Response None
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/llmBlueprints/{llmBlueprintId}/

Retrieve an existing LLM blueprint.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/llmBlueprints/{llmBlueprintId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
llmBlueprintId path string true The ID of the LLM blueprint to retrieve.

Example responses

200 Response

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "creationUserName": "string",
  "customModelLLMErrorMessage": "string",
  "customModelLLMErrorResolution": "string",
  "customModelLLMValidationStatus": "TESTING",
  "description": "string",
  "id": "string",
  "isActive": true,
  "isDeprecated": true,
  "isSaved": true,
  "isStarred": true,
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "lastUpdateUserId": "string",
  "llmId": "azure-openai-gpt-3.5-turbo",
  "llmName": "string",
  "llmSettings": {
    "maxCompletionLength": 0,
    "systemPrompt": "string",
    "temperature": 0,
    "topP": 0
  },
  "name": "string",
  "playgroundId": "string",
  "promptType": "CHAT_HISTORY_AWARE",
  "retirementDate": "2019-08-24",
  "vectorDatabaseErrorMessage": "string",
  "vectorDatabaseErrorResolution": "string",
  "vectorDatabaseFamilyId": "string",
  "vectorDatabaseId": "string",
  "vectorDatabaseName": "string",
  "vectorDatabaseSettings": {
    "addNeighborChunks": false,
    "maxDocumentsRetrievedPerPrompt": 1,
    "maxTokens": 1,
    "retriever": "SINGLE_LOOKUP_RETRIEVER"
  },
  "vectorDatabaseStatus": "NEW"
}

Responses

Status Meaning Description Schema
200 OK Successful Response LLMBlueprintResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/genai/llmBlueprints/{llmBlueprintId}/

Edit an existing LLM blueprint.

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/genai/llmBlueprints/{llmBlueprintId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "description": "string",
  "isSaved": true,
  "isStarred": true,
  "llmId": "azure-openai-gpt-3.5-turbo",
  "llmSettings": {
    "maxCompletionLength": 0,
    "systemPrompt": "string",
    "temperature": 0,
    "topP": 0
  },
  "name": "string",
  "promptType": "CHAT_HISTORY_AWARE",
  "vectorDatabaseId": "string",
  "vectorDatabaseSettings": {
    "addNeighborChunks": false,
    "maxDocumentsRetrievedPerPrompt": 1,
    "maxTokens": 128,
    "retriever": "SINGLE_LOOKUP_RETRIEVER"
  }
}

Parameters

Name In Type Required Description
llmBlueprintId path string true The ID of the LLM blueprint to edit.
body body UpdateLLMBlueprintRequest true none

Example responses

200 Response

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "creationUserName": "string",
  "customModelLLMErrorMessage": "string",
  "customModelLLMErrorResolution": "string",
  "customModelLLMValidationStatus": "TESTING",
  "description": "string",
  "id": "string",
  "isActive": true,
  "isDeprecated": true,
  "isSaved": true,
  "isStarred": true,
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "lastUpdateUserId": "string",
  "llmId": "azure-openai-gpt-3.5-turbo",
  "llmName": "string",
  "llmSettings": {
    "maxCompletionLength": 0,
    "systemPrompt": "string",
    "temperature": 0,
    "topP": 0
  },
  "name": "string",
  "playgroundId": "string",
  "promptType": "CHAT_HISTORY_AWARE",
  "retirementDate": "2019-08-24",
  "vectorDatabaseErrorMessage": "string",
  "vectorDatabaseErrorResolution": "string",
  "vectorDatabaseFamilyId": "string",
  "vectorDatabaseId": "string",
  "vectorDatabaseName": "string",
  "vectorDatabaseSettings": {
    "addNeighborChunks": false,
    "maxDocumentsRetrievedPerPrompt": 1,
    "maxTokens": 1,
    "retriever": "SINGLE_LOOKUP_RETRIEVER"
  },
  "vectorDatabaseStatus": "NEW"
}

Responses

Status Meaning Description Schema
200 OK Successful Response LLMBlueprintResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/llms/

List the large language models (LLMs) available in the DataRobot platform for the current user.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/llms/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Skip the specified number of values.
limit query integer false Retrieve only the specified number of values.
useCaseId query any false If specified, include custom model LLMs available for this use case.
activeOnly query boolean false Whether to include only active models.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "contextSize": 0,
      "creator": "OpenAI",
      "dateAdded": "2019-08-24",
      "description": "string",
      "documentationLink": "string",
      "id": "azure-openai-gpt-3.5-turbo",
      "isActive": true,
      "isDeprecated": true,
      "isMetered": true,
      "license": "string",
      "name": "string",
      "provider": "string",
      "referenceLinks": [
        {
          "name": "string",
          "url": "string"
        }
      ],
      "retirementDate": "2019-08-24",
      "settings": [
        {
          "constraints": {
            "maxValue": 0,
            "minValue": 0,
            "type": "integer"
          },
          "defaultValue": true,
          "description": "string",
          "format": "multiline",
          "id": "string",
          "isNullable": true,
          "name": "string",
          "type": "integer"
        }
      ],
      "suggestedReplacement": "azure-openai-gpt-3.5-turbo",
      "supportedCustomModelLLMValidations": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "supportedLanguages": "string",
      "vendor": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Successful Response ListLLMsResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/playgrounds/

List playgrounds.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/playgrounds/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
useCaseId query any false Only retrieve the playgrounds linked to the specified use cases.
offset query integer false Skip the specified number of values.
limit query integer false Retrieve only the specified number of values.
search query any false Only retrieve the playgrounds with names matching the search query.
sort query any false Apply this sort order to the results. Valid options are "name", "description", "creationDate", "creationUserId", "lastUpdateDate", "lastUpdateUserId", "savedLLMBlueprintsCount". Prefix the attribute name with a dash to sort in descending order, e.g., sort=-creationDate.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "creationDate": "2019-08-24T14:15:22Z",
      "creationUserId": "string",
      "description": "string",
      "id": "string",
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "lastUpdateUserId": "string",
      "llmBlueprintsCount": 0,
      "name": "string",
      "savedLLMBlueprintsCount": 0,
      "useCaseId": "string",
      "userName": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Successful Response ListPlaygroundsResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/genai/playgrounds/

Create a new playground.

Code samples

curl -X POST https://app.datarobot.com/api/v2/genai/playgrounds/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{CreatePlaygroundRequest}'

Body parameter

{
  "copyInsights": {
    "sourcePlaygroundId": "string",
    "withEvaluationDatasets": false
  },
  "description": "string",
  "name": "string",
  "useCaseId": "string"
}

Parameters

Name In Type Required Description
body body CreatePlaygroundRequest true none

Example responses

201 Response

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "description": "string",
  "id": "string",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "lastUpdateUserId": "string",
  "llmBlueprintsCount": 0,
  "name": "string",
  "savedLLMBlueprintsCount": 0,
  "useCaseId": "string",
  "userName": "string"
}

Responses

Status Meaning Description Schema
201 Created Successful Response PlaygroundResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/genai/playgrounds/{playgroundId}/

Delete an existing playground.

Code samples

curl -X DELETE https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground to delete.

Example responses

422 Response

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
204 No Content Successful Response None
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/playgrounds/{playgroundId}/

Retrieve an existing playground.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground to retrieve.

Example responses

200 Response

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "description": "string",
  "id": "string",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "lastUpdateUserId": "string",
  "llmBlueprintsCount": 0,
  "name": "string",
  "savedLLMBlueprintsCount": 0,
  "useCaseId": "string",
  "userName": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful Response PlaygroundResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/genai/playgrounds/{playgroundId}/

Edit an existing playground.

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "description": "string",
  "name": "string"
}

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground to edit.
body body EditPlaygroundRequest true none

Example responses

200 Response

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "description": "string",
  "id": "string",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "lastUpdateUserId": "string",
  "llmBlueprintsCount": 0,
  "name": "string",
  "savedLLMBlueprintsCount": 0,
  "useCaseId": "string",
  "userName": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful Response PlaygroundResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/genai/playgrounds/{playgroundId}/nemoConfiguration/

Delete the NeMo configuration for the playground.

Code samples

curl -X DELETE https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/nemoConfiguration/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground to retrieve NeMo configuration for.

Example responses

422 Response

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
204 No Content Successful Response None
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/playgrounds/{playgroundId}/nemoConfiguration/

Retrieve the NeMo configuration for the playground.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/nemoConfiguration/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground to retrieve NeMo configuration for.

Example responses

200 Response

{
  "blockedTermsFileContents": "string",
  "promptLlmConfiguration": {
    "llmType": "openAi",
    "openaiApiBase": "string",
    "openaiApiDeploymentId": "string",
    "openaiApiKeyId": "string"
  },
  "promptModerationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "promptPipelineFiles": {
    "actionsFileContents": "string",
    "configYamlFileContents": "string",
    "flowDefinitionFileContents": "string",
    "promptsFileContents": "string"
  },
  "promptPipelineMetricName": "string",
  "promptPipelineTemplateId": "string",
  "responseLlmConfiguration": {
    "llmType": "openAi",
    "openaiApiBase": "string",
    "openaiApiDeploymentId": "string",
    "openaiApiKeyId": "string"
  },
  "responseModerationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "responsePipelineFiles": {
    "actionsFileContents": "string",
    "configYamlFileContents": "string",
    "flowDefinitionFileContents": "string",
    "promptsFileContents": "string"
  },
  "responsePipelineMetricName": "string",
  "responsePipelineTemplateId": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful Response NemoConfigurationResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/genai/playgrounds/{playgroundId}/nemoConfiguration/

Update/insert the NeMo configuration for the playground.

Code samples

curl -X POST https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/nemoConfiguration/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "blockedTermsFileContents": "string",
  "promptLlmConfiguration": {
    "llmType": "openAi",
    "openaiApiBase": "string",
    "openaiApiDeploymentId": "string",
    "openaiApiKeyId": "string"
  },
  "promptModerationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "promptPipelineFiles": {
    "configYamlFileContents": "string",
    "flowDefinitionFileContents": "string",
    "promptsFileContents": "string"
  },
  "promptPipelineMetricName": "string",
  "promptPipelineTemplateId": "string",
  "responseLlmConfiguration": {
    "llmType": "openAi",
    "openaiApiBase": "string",
    "openaiApiDeploymentId": "string",
    "openaiApiKeyId": "string"
  },
  "responseModerationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "responsePipelineFiles": {
    "configYamlFileContents": "string",
    "flowDefinitionFileContents": "string",
    "promptsFileContents": "string"
  },
  "responsePipelineMetricName": "string",
  "responsePipelineTemplateId": "string"
}

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground to retrieve NeMo configuration for.
body body NemoConfigurationUpsertRequest true none

Example responses

202 Response

{
  "blockedTermsFileContents": "string",
  "promptLlmConfiguration": {
    "llmType": "openAi",
    "openaiApiBase": "string",
    "openaiApiDeploymentId": "string",
    "openaiApiKeyId": "string"
  },
  "promptModerationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "promptPipelineFiles": {
    "actionsFileContents": "string",
    "configYamlFileContents": "string",
    "flowDefinitionFileContents": "string",
    "promptsFileContents": "string"
  },
  "promptPipelineMetricName": "string",
  "promptPipelineTemplateId": "string",
  "responseLlmConfiguration": {
    "llmType": "openAi",
    "openaiApiBase": "string",
    "openaiApiDeploymentId": "string",
    "openaiApiKeyId": "string"
  },
  "responseModerationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "responsePipelineFiles": {
    "actionsFileContents": "string",
    "configYamlFileContents": "string",
    "flowDefinitionFileContents": "string",
    "promptsFileContents": "string"
  },
  "responsePipelineMetricName": "string",
  "responsePipelineTemplateId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Successful Response NemoConfigurationResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/genai/playgrounds/{playgroundId}/nemoConfiguration/{metricId}/

Delete a NeMo metric for the playground.

Code samples

curl -X DELETE https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/nemoConfiguration/{metricId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground to retrieve NeMo configuration for.
metricId path string true The ID of the metric to delete.

Example responses

422 Response

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
204 No Content Successful Response None
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/playgrounds/{playgroundId}/ootbMetricConfigurations/

List OOTB metric configurations for the selected playground.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/ootbMetricConfigurations/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground.

Example responses

200 Response

{
  "ootbMetricConfigurations": [
    {
      "customModelLLMValidationId": "string",
      "customOotbMetricName": "string",
      "errorMessage": "string",
      "errorResolution": [
        "ootbMetricName"
      ],
      "executionStatus": "NEW",
      "llmId": "azure-openai-gpt-3.5-turbo",
      "moderationConfiguration": {
        "guardConditions": [
          {
            "comparand": 0,
            "comparator": "greaterThan"
          }
        ],
        "intervention": {
          "action": "block",
          "message": "string"
        }
      },
      "ootbMetricConfigurationId": "string",
      "ootbMetricName": "latency"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OOTB metric configurations list OOTBMetricConfigurationsResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/genai/playgrounds/{playgroundId}/ootbMetricConfigurations/

Create a new OOTB metric configuration.

Code samples

curl -X POST https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/ootbMetricConfigurations/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "ootbMetricConfigurations": [
    {
      "customModelLLMValidationId": "string",
      "customOotbMetricName": "string",
      "llmId": "azure-openai-gpt-3.5-turbo",
      "moderationConfiguration": {
        "guardConditions": [
          {
            "comparand": 0,
            "comparator": "greaterThan"
          }
        ],
        "intervention": {
          "action": "block",
          "message": "string"
        }
      },
      "ootbMetricName": "latency"
    }
  ]
}

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground associated with the OOTB metric configuration.
body body CreateOOTBMetricConfigurationsRequest true none

Example responses

201 Response

{
  "ootbMetricConfigurations": [
    {
      "customModelLLMValidationId": "string",
      "customOotbMetricName": "string",
      "errorMessage": "string",
      "errorResolution": [
        "ootbMetricName"
      ],
      "executionStatus": "NEW",
      "llmId": "azure-openai-gpt-3.5-turbo",
      "moderationConfiguration": {
        "guardConditions": [
          {
            "comparand": 0,
            "comparator": "greaterThan"
          }
        ],
        "intervention": {
          "action": "block",
          "message": "string"
        }
      },
      "ootbMetricConfigurationId": "string",
      "ootbMetricName": "latency"
    }
  ]
}

Responses

Status Meaning Description Schema
201 Created OOTB metric configuration created successfully OOTBMetricConfigurationsResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/playgrounds/{playgroundId}/supportedInsights/

List the supported insights.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/supportedInsights/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground to retrieve supported insights from.
withAggregationTypesOnly query boolean false If true, only include the insights containing aggregation types. The default is false.
productionOnly query boolean false If true, only include the insights that can be transferred to production. The default is false.
completedOnly query boolean false If true, only include the insights that are completed. The default is false.
llmBlueprintIds query any false The IDs of the LLM blueprints to check for VDB related metrics support.

Example responses

200 Response

{
  "insightsConfiguration": [
    {
      "aggregationTypes": [
        "average"
      ],
      "costConfigurationId": "string",
      "customMetricId": "string",
      "customModelLLMValidationId": "string",
      "deploymentId": "string",
      "errorMessage": "string",
      "errorResolution": [
        "string"
      ],
      "evaluationDatasetConfigurationId": "string",
      "executionStatus": "NEW",
      "insightName": "string",
      "insightType": "Reference",
      "isTransferable": false,
      "llmId": "azure-openai-gpt-3.5-turbo",
      "llmIsActive": true,
      "llmIsDeprecated": true,
      "modelId": "string",
      "modelPackageRegisteredModelId": "string",
      "moderationConfiguration": {
        "guardConditions": [
          {
            "comparand": 0,
            "comparator": "greaterThan"
          }
        ],
        "intervention": {
          "action": "block",
          "message": "string"
        }
      },
      "nemoMetricId": "string",
      "ootbMetricId": "string",
      "ootbMetricName": "latency",
      "resultUnit": "s",
      "sidecarModelMetricMetadata": {
        "expectedResponseColumnName": "string",
        "promptColumnName": "string",
        "responseColumnName": "string",
        "targetColumnName": "string"
      },
      "sidecarModelMetricValidationId": "string",
      "stage": "prompt_pipeline"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Supported insights configuration successfully retrieved. SupportedInsightsResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/playgrounds/{playgroundId}/trace/

Retrieve the playground prompt traces for an existing playground.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/trace/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground to retrieve prompt traces for.
offset query integer false Skip the specified number of values.
limit query integer false Retrieve only the specified number of values.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "chatId": "string",
      "chatName": "string",
      "chatPromptId": "string",
      "comparisonPromptId": "string",
      "confidenceScores": {},
      "evaluationDatasetConfigurationId": "string",
      "executionStatus": "NEW",
      "llmBlueprintId": "string",
      "llmBlueprintName": "string",
      "llmLicense": "string",
      "llmName": "string",
      "llmSettings": {
        "maxCompletionLength": 0,
        "systemPrompt": "string",
        "temperature": 0,
        "topP": 0
      },
      "llmVendor": "string",
      "promptType": "CHAT_HISTORY_AWARE",
      "resultMetadata": {
        "blockedResultText": "string",
        "cost": 0,
        "errorMessage": "string",
        "estimatedDocsTokenCount": 0,
        "feedbackResult": {
          "negativeUserIds": [],
          "positiveUserIds": []
        },
        "finalPrompt": "string",
        "inputTokenCount": 0,
        "latencyMilliseconds": 0,
        "metrics": [],
        "outputTokenCount": 0,
        "providerLLMGuards": [
          {
            "name": "string",
            "satisfyCriteria": true,
            "stage": "prompt",
            "value": "string"
          }
        ],
        "totalTokenCount": 0
      },
      "resultText": "string",
      "text": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "useCaseId": "string",
      "user": {
        "id": "string",
        "name": "string"
      },
      "vectorDatabaseId": "string",
      "vectorDatabaseSettings": {
        "addNeighborChunks": false,
        "maxDocumentsRetrievedPerPrompt": 1,
        "maxTokens": 1,
        "retriever": "SINGLE_LOOKUP_RETRIEVER"
      },
      "warning": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Successful Response ListTracesResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/playgrounds/{playgroundId}/trace/metadata/

Retrieve the prompt traces metadata for an existing playground.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/trace/metadata/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground to retrieve prompt traces for.

Example responses

200 Response

{
  "chats": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "users": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful Response TraceMetadataResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/genai/playgrounds/{playgroundId}/traceDatasets/

Export prompt traces for an existing playground as a Data Registry dataset.

Code samples

curl -X POST https://app.datarobot.com/api/v2/genai/playgrounds/{playgroundId}/traceDatasets/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "excludeTracesWithWarnings": true
}

Parameters

Name In Type Required Description
playgroundId path string true The ID of the playground to export the prompt traces for.
body body CreateTraceDatasetRequest false none

Example responses

202 Response

{
  "aiCatalogId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Successful Response TraceDatasetResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PUT /api/v2/genai/playgrounds/{targetPlaygroundId}/supportedInsights/{sourcePlaygroundId}/

Copy supported insights between playgrounds.

Code samples

curl -X PUT https://app.datarobot.com/api/v2/genai/playgrounds/{targetPlaygroundId}/supportedInsights/{sourcePlaygroundId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "addToExisting": true,
  "withEvaluationDatasets": false
}

Parameters

Name In Type Required Description
sourcePlaygroundId path string true The ID of the source playground to copy supported insights from.
targetPlaygroundId path string true The ID of the target playground to copy supported insights to.
body body CopySupportedInsightsRequest true none

Example responses

422 Response

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
204 No Content Supported insights configuration successfully copied. None
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/status/{statusId}/

Retrieve the execution status of a GenAI worker job.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/status/{statusId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
statusId path string(uuid) true The ID of the job to retrieve the status for.

Example responses

200 Response

{
  "code": 0,
  "created": "2019-08-24T14:15:22Z",
  "description": "",
  "message": "",
  "status": "INITIALIZED",
  "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  "statusType": ""
}

Responses

Status Meaning Description Schema
200 OK Successful Response Inline
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

Response Schema

Status Code 200

Response Get Status Status Statusid Get

Name Type Required Restrictions Description
Response Get Status Status Statusid Get any false none

anyOf

Name Type Required Restrictions Description
» anonymous StatusResponse false API response object for job execution status.
»» code JobErrorCode true Possible job error codes. This enum exists for consistency with the DataRobot Status API.
»» created string(date-time) true The creation date of the job (ISO 8601 formatted).
»» description string false The description associated with the job.
»» message string false The error message associated with the job.
»» status JobExecutionState true Possible job states. Values match the DataRobot Status API.
»» statusId string(uuid) true ID that can be used with GET /api/v2/status/{statusId}/ to poll for the testing job's status.
»» statusType string false The type of the status object.

or

Name Type Required Restrictions Description
» anonymous string false none

Enumerated Values

Property Value
code [0, 1]
status [INITIALIZED, RUNNING, COMPLETED, ERROR, ABORTED, EXPIRED]

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/userLimits/llmApiCalls/

Retrieve the number of LLM API calls the user has made which count towards the usage limit.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/userLimits/llmApiCalls/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Example responses

200 Response

{
  "counter": 0
}

Responses

Status Meaning Description Schema
200 OK Successful Response RetrieveUserLimitCounterResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/genai/userLimits/vectorDatabases/

Retrieve the number of vector databases the user has created which count towards the usage limit.

Code samples

curl -X GET https://app.datarobot.com/api/v2/genai/userLimits/vectorDatabases/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Example responses

200 Response

{
  "counter": 0
}

Responses

Status Meaning Description Schema
200 OK Successful Response RetrieveUserLimitCounterResponse
422 Unprocessable Entity Validation Error HTTPValidationErrorResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas

AggregationType

"average"

AggregationType

Properties

Name Type Required Restrictions Description
AggregationType string false The type of the metric aggregation.

Enumerated Values

Property Value
AggregationType [average, percentYes, classPercentCoverage, ngramImportance, guardConditionPercentYes]

BooleanSettingConstraints

{
  "type": "boolean"
}

BooleanSettingConstraints

Properties

Name Type Required Restrictions Description
type string false The data type of the setting.

CommonLLMSettings

{
  "maxCompletionLength": 0,
  "systemPrompt": "string",
  "temperature": 0,
  "topP": 0
}

CommonLLMSettings

Properties

Name Type Required Restrictions Description
maxCompletionLength any false Maximum number of tokens allowed in the completion. The combined count of this value and prompt tokens must be below the model's maximum context size, where prompt token count is comprised of system prompt, user prompt, recent chat history, and vector database citations.

anyOf

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
systemPrompt any false System prompt guides the style of the LLM response. It is a "universal" prompt, prepended to all individual prompts.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 500000
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
temperature any false Temperature controls the randomness of model output, where higher values return more diverse output and lower values return more deterministic results.

anyOf

Name Type Required Restrictions Description
» anonymous number false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
topP any false Top P sets a threshold that controls the selection of words included in the response, based on a cumulative probability cutoff for token selection. For example, 0.2 considers only the top 20% probability mass. Higher numbers return more diverse options for outputs.

anyOf

Name Type Required Restrictions Description
» anonymous number false none

or

Name Type Required Restrictions Description
» anonymous null false none

CopyInsightsRequest

{
  "sourcePlaygroundId": "string",
  "withEvaluationDatasets": false
}

CopyInsightsRequest

Properties

Name Type Required Restrictions Description
sourcePlaygroundId string true The ID of the existing playground from where to copy insights.
withEvaluationDatasets boolean false If true also copies source playground evaluation datasets to target playground.

CopySupportedInsightsRequest

{
  "addToExisting": true,
  "withEvaluationDatasets": false
}

CopySupportedInsightsRequest

Properties

Name Type Required Restrictions Description
addToExisting boolean false If true, adds copied insights to existing insights in the target playground. If false, replaces insights in the target playground with copied insights.
withEvaluationDatasets boolean false If true also copies source playground evaluation datasets to target playground.

CreateCustomModelLLMValidationRequest

{
  "chatModelId": "string",
  "deploymentId": "string",
  "modelId": "string",
  "name": "Untitled",
  "predictionTimeout": 300,
  "promptColumnName": "string",
  "targetColumnName": "string",
  "useCaseId": "string"
}

CreateCustomModelLLMValidationRequest

Properties

Name Type Required Restrictions Description
chatModelId any false The model ID to specify when calling the OpenAI chat completion API of the deployment. If this parameter is specified, the deployment must support the OpenAI chat completion API.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 5000
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
deploymentId string true The ID of the custom model deployment.
modelId any false The ID of the model used in the deployment.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
name string false maxLength: 5000
 The name to use for the validated custom model.
predictionTimeout integer false maximum: 600
minimum: 1
 The timeout in seconds for the prediction when validating a custom model. Defaults to 300.
promptColumnName any false The name of the column the custom model uses for prompt text input. This value is used to call the Prediction API of the deployment. For LLM deployments that support the OpenAI chat completion API, it is recommended to specify chatModelId instead.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 5000
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
targetColumnName any false The name of the column the custom model uses for prediction output. This value is used to call the Prediction API of the deployment. For LLM deployments that support the OpenAI chat completion API, it is recommended to specify chatModelId instead.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 5000
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
useCaseId any false The ID of the use case to associate with the validated custom model.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

CreateCustomModelVersionRequest

{
  "insightsConfiguration": [],
  "llmBlueprintId": "string",
  "llmTestConfigurationIds": [],
  "promptColumnName": "promptText",
  "targetColumnName": "resultText"
}

CreateCustomModelVersionRequest

Properties

Name Type Required Restrictions Description
insightsConfiguration [InsightsConfigurationWithAdditionalData] false The configuration of insights to transfer to production.
llmBlueprintId string true The ID of the LLM blueprint to use for the custom model version.
llmTestConfigurationIds [string] false maxItems: 100
 The IDs of the LLM test configurations to execute.
promptColumnName string false maxLength: 5000
 The name of the column to use for prompt text input in the custom model.
targetColumnName string false maxLength: 5000
 The name of the column to use for prediction output in the custom model.

CreateCustomModelVersionResponse

{
  "customModelId": "string"
}

CreateCustomModelVersionResponse

Properties

Name Type Required Restrictions Description
customModelId string true The ID of the created custom model.

CreateFromChatPromptRequest

{
  "chatPromptId": "string",
  "description": "",
  "name": "string"
}

CreateFromChatPromptRequest

Properties

Name Type Required Restrictions Description
chatPromptId string true The ID of an existing chat prompt to copy the LLM and vector database settings from.
description string false maxLength: 5000
 The description of the new LLM blueprint.
name string true maxLength: 5000
 The name of the new LLM blueprint.

CreateFromLLMBlueprintRequest

{
  "description": "",
  "llmBlueprintId": "string",
  "name": "string"
}

CreateFromLLMBlueprintRequest

Properties

Name Type Required Restrictions Description
description string false maxLength: 5000
 The description of the new LLM blueprint.
llmBlueprintId string true The ID of an existing LLM blueprint to copy the LLM and vector database settings from.
name string true maxLength: 5000
 The name of the new LLM blueprint.

CreateLLMBlueprintRequest

{
  "description": "",
  "llmId": "azure-openai-gpt-3.5-turbo",
  "llmSettings": {
    "maxCompletionLength": 0,
    "systemPrompt": "string",
    "temperature": 0,
    "topP": 0
  },
  "name": "string",
  "playgroundId": "string",
  "promptType": "CHAT_HISTORY_AWARE",
  "vectorDatabaseId": "string",
  "vectorDatabaseSettings": {
    "addNeighborChunks": false,
    "maxDocumentsRetrievedPerPrompt": 1,
    "maxTokens": 128,
    "retriever": "SINGLE_LOOKUP_RETRIEVER"
  }
}

CreateLLMBlueprintRequest

Properties

Name Type Required Restrictions Description
description string false maxLength: 5000
 The description of the LLM blueprint.
llmId any false The ID of the LLM selected for this LLM blueprint.

anyOf

Name Type Required Restrictions Description
» anonymous LanguageModelTypeId false The ID that defines the type of the LLM.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
llmSettings any false A key/value dictionary of LLM settings.

anyOf

Name Type Required Restrictions Description
» anonymous CommonLLMSettings false The settings that are available for all non-custom LLMs.

or

Name Type Required Restrictions Description
» anonymous CustomModelLLMSettings false The settings that are available for custom model LLMs.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
name string true maxLength: 5000
 The name of the LLM blueprint.
playgroundId string true The ID of the playground to link this LLM blueprint to.
promptType PromptType false Specifies whether chat history is submitted as context to the user prompt.
vectorDatabaseId any false The ID of the vector database linked to this LLM blueprint.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
vectorDatabaseSettings any false A key/value dictionary of vector database settings.

anyOf

Name Type Required Restrictions Description
» anonymous VectorDatabaseSettingsRequest false Specifies the vector database retrieval settings in LLM blueprint API requests.

or

Name Type Required Restrictions Description
» anonymous null false none

CreateOOTBMetricConfigurationsRequest

{
  "ootbMetricConfigurations": [
    {
      "customModelLLMValidationId": "string",
      "customOotbMetricName": "string",
      "llmId": "azure-openai-gpt-3.5-turbo",
      "moderationConfiguration": {
        "guardConditions": [
          {
            "comparand": 0,
            "comparator": "greaterThan"
          }
        ],
        "intervention": {
          "action": "block",
          "message": "string"
        }
      },
      "ootbMetricName": "latency"
    }
  ]
}

CreateOOTBMetricConfigurationsRequest

Properties

Name Type Required Restrictions Description
ootbMetricConfigurations [OOTBMetricConfigurationRequest] true The list of OOTB metrics to use.

CreatePlaygroundRequest

{
  "copyInsights": {
    "sourcePlaygroundId": "string",
    "withEvaluationDatasets": false
  },
  "description": "string",
  "name": "string",
  "useCaseId": "string"
}

CreatePlaygroundRequest

Properties

Name Type Required Restrictions Description
copyInsights any false If present, copy insights from source playground to the created playground.

anyOf

Name Type Required Restrictions Description
» anonymous CopyInsightsRequest false The body of the Copy Insights request.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
description string true maxLength: 5000
 The description of the playground.
name string true maxLength: 5000
 The name of the playground.
useCaseId string true The ID of the use case to link the playground to.

CreateTraceDatasetRequest

{
  "excludeTracesWithWarnings": true
}

CreateTraceDatasetRequest

Properties

Name Type Required Restrictions Description
excludeTracesWithWarnings boolean false Whether to exclude traces with warnings.

CustomModelLLMSettings

{
  "externalLlmContextSize": 128,
  "systemPrompt": "string",
  "validationId": "string"
}

CustomModelLLMSettings

Properties

Name Type Required Restrictions Description
externalLlmContextSize any false The external LLM's context size, in tokens. This value is only used for pruning documents supplied to the LLM when a vector database is associated with the LLM blueprint. It does not affect the external LLM's actual context size in any way and is not supplied to the LLM.

anyOf

Name Type Required Restrictions Description
» anonymous integer false maximum: 128000
minimum: 128
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
systemPrompt any false System prompt guides the style of the LLM response. It is a "universal" prompt, prepended to all individual prompts.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 500000
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
validationId any false The validation ID of the custom model LLM.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

CustomModelLLMValidationResponse

{
  "chatModelId": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "deploymentAccessData": {
    "authorizationHeader": "[REDACTED]",
    "chatApiUrl": "string",
    "datarobotKey": "string",
    "inputType": "CSV",
    "modelType": "TEXT_GENERATION",
    "predictionApiUrl": "string"
  },
  "deploymentId": "string",
  "deploymentName": "string",
  "errorMessage": "string",
  "id": "string",
  "modelId": "string",
  "name": "string",
  "predictionTimeout": 0,
  "promptColumnName": "string",
  "targetColumnName": "string",
  "tenantId": "string",
  "useCaseId": "string",
  "userId": "string",
  "userName": "string",
  "validationStatus": "TESTING"
}

CustomModelLLMValidationResponse

Properties

Name Type Required Restrictions Description
chatModelId any false The model ID to specify when calling the OpenAI chat completion API of the deployment.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
creationDate string(date-time) true The creation date of the custom model validation (ISO 8601 formatted).
deploymentAccessData any true The parameters used for accessing the deployment.

anyOf

Name Type Required Restrictions Description
» anonymous DeploymentAccessData false Add authorization_header to avoid breaking change to API.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
deploymentId string true The ID of the custom model deployment.
deploymentName any false The name of the custom model deployment.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
errorMessage any false The error message associated with the validation error (if the validation failed).

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
id string true The ID of the custom model validation.
modelId string true The ID of the model used in the deployment.
name string true The name of the validated custom model.
predictionTimeout integer true The timeout in seconds for the prediction API used in this custom model validation.
promptColumnName string true The name of the column the custom model uses for prompt text input.
targetColumnName string true The name of the column the custom model uses for prediction output.
tenantId string(uuid4) true The ID of the tenant the custom model validation belongs to.
useCaseId any true The ID of the use case associated with the validated custom model.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
userId string true The ID of the user that created this custom model validation.
userName any false The name of the user that created this custom model validation.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
validationStatus CustomModelValidationStatus true The status of the custom model validation.

CustomModelValidationStatus

"TESTING"

CustomModelValidationStatus

Properties

Name Type Required Restrictions Description
CustomModelValidationStatus string false Status of custom model validation.

Enumerated Values

Property Value
CustomModelValidationStatus [TESTING, PASSED, FAILED]

DataRobotUser

{
  "id": "string",
  "name": "string"
}

DataRobotUser

Properties

Name Type Required Restrictions Description
id string true The ID of the user.
name string true The name of the user.

DeploymentAccessData

{
  "authorizationHeader": "[REDACTED]",
  "chatApiUrl": "string",
  "datarobotKey": "string",
  "inputType": "CSV",
  "modelType": "TEXT_GENERATION",
  "predictionApiUrl": "string"
}

DeploymentAccessData

Properties

Name Type Required Restrictions Description
authorizationHeader string false The Authorization header to use for the deployment.
chatApiUrl any false The URL of the deployment's chat API.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
datarobotKey any true The server key associated with the prediction API.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
inputType DeploymentInputType true The format of the input data.
modelType SupportedDeploymentType true The type of the target output the deployment produces.
predictionApiUrl string true The URL of the deployment's prediction API.

DeploymentInputType

"CSV"

DeploymentInputType

Properties

Name Type Required Restrictions Description
DeploymentInputType string false The format of the input data submitted to a DataRobot deployment.

Enumerated Values

Property Value
DeploymentInputType [CSV, JSON]

EditCustomModelValidationRequest

{
  "chatModelId": "string",
  "deploymentId": "string",
  "modelId": "string",
  "name": "string",
  "predictionTimeout": 1,
  "promptColumnName": "string",
  "targetColumnName": "string"
}

EditCustomModelValidationRequest

Properties

Name Type Required Restrictions Description
chatModelId any false The model ID to specify when calling the OpenAI chat completion API of the deployment. If this parameter is specified, the deployment must support the OpenAI chat completion API.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 5000
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
deploymentId any false If specified, changes the ID of the deployment associated with this custom model validation.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
modelId any false If specified, changes the ID of the model associated with this custom model validation.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
name any false If specified, renames the custom model validation to this value.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 5000
minLength: 1
minLength: 1
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
predictionTimeout any false If specified, sets the timeout in seconds for the prediction when validating a custom model.

anyOf

Name Type Required Restrictions Description
» anonymous integer false maximum: 600
minimum: 1
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
promptColumnName any false If specified, changes the name of the column that will be used to format the prompt text input for the custom model deployment.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 5000
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
targetColumnName any false If specified, changes the name of the column that will be used to extract the prediction response from the custom model deployment.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 5000
 none

or

Name Type Required Restrictions Description
» anonymous null false none

EditPlaygroundRequest

{
  "description": "string",
  "name": "string"
}

EditPlaygroundRequest

Properties

Name Type Required Restrictions Description
description any false If specified, updates the playground description to this value.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 5000
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
name any false If specified, renames the playground to this value.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 5000
 none

or

Name Type Required Restrictions Description
» anonymous null false none

ExecutionStatus

"NEW"

ExecutionStatus

Properties

Name Type Required Restrictions Description
ExecutionStatus string false Job and entity execution status.

Enumerated Values

Property Value
ExecutionStatus [NEW, RUNNING, COMPLETED, REQUIRES_USER_INPUT, SKIPPED, ERROR]

FeedbackResult

{
  "negativeUserIds": [],
  "positiveUserIds": []
}

FeedbackResult

Properties

Name Type Required Restrictions Description
negativeUserIds [string] false The list of user IDs whose feedback is negative.
positiveUserIds [string] false The list of user IDs whose feedback is positive.

FloatSettingConstraints

{
  "maxValue": 0,
  "minValue": 0,
  "type": "float"
}

FloatSettingConstraints

Properties

Name Type Required Restrictions Description
maxValue any false The maximum value of the setting (inclusive).

anyOf

Name Type Required Restrictions Description
» anonymous number false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
minValue any false The minimum value of the setting (inclusive).

anyOf

Name Type Required Restrictions Description
» anonymous number false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
type string false The data type of the setting.

GuardCondition

{
  "comparand": 0,
  "comparator": "greaterThan"
}

GuardCondition

Properties

Name Type Required Restrictions Description
comparand any true The comparand(s) used in the guard condition.

anyOf

Name Type Required Restrictions Description
» anonymous number false none

or

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous boolean false none

or

Name Type Required Restrictions Description
» anonymous [string] false none

continued

Name Type Required Restrictions Description
comparator GuardConditionComparator true The comparator used in the guard condition.

GuardConditionComparator

"greaterThan"

GuardConditionComparator

Properties

Name Type Required Restrictions Description
GuardConditionComparator string false The comparator used in a guard condition.

Enumerated Values

Property Value
GuardConditionComparator [greaterThan, lessThan, equals, notEquals, is, isNot, matches, doesNotMatch, contains, doesNotContain]

HTTPValidationErrorResponse

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

HTTPValidationErrorResponse

Properties

Name Type Required Restrictions Description
detail [ValidationError] false none

InsightErrorResolution

"ootbMetricName"

InsightErrorResolution

Properties

Name Type Required Restrictions Description
InsightErrorResolution string false Error type linking directly to the field name that is related to the error.

Enumerated Values

Property Value
InsightErrorResolution [ootbMetricName, intervention, guardCondition, sidecarOverall, sidecarRevalidate, sidecarDeploymentId, sidecarInputColumnName, sidecarOutputColumnName, promptPipelineFiles, promptPipelineTemplateId, responsePipelineFiles, responsePipelineTemplateId]

InsightTypes

"Reference"

InsightTypes

Properties

Name Type Required Restrictions Description
InsightTypes string false The type of insight.

Enumerated Values

Property Value
InsightTypes [Reference, Quality metric, Operational metric, Evaluation deployment, Custom metric, Nemo]

InsightsConfigurationWithAdditionalData

{
  "aggregationTypes": [
    "average"
  ],
  "costConfigurationId": "string",
  "customMetricId": "string",
  "customModelLLMValidationId": "string",
  "deploymentId": "string",
  "errorMessage": "string",
  "errorResolution": [
    "string"
  ],
  "evaluationDatasetConfigurationId": "string",
  "executionStatus": "NEW",
  "insightName": "string",
  "insightType": "Reference",
  "isTransferable": false,
  "llmId": "azure-openai-gpt-3.5-turbo",
  "llmIsActive": true,
  "llmIsDeprecated": true,
  "modelId": "string",
  "modelPackageRegisteredModelId": "string",
  "moderationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "nemoMetricId": "string",
  "ootbMetricId": "string",
  "ootbMetricName": "latency",
  "resultUnit": "s",
  "sidecarModelMetricMetadata": {
    "expectedResponseColumnName": "string",
    "promptColumnName": "string",
    "responseColumnName": "string",
    "targetColumnName": "string"
  },
  "sidecarModelMetricValidationId": "string",
  "stage": "prompt_pipeline"
}

InsightsConfigurationWithAdditionalData

Properties

Name Type Required Restrictions Description
aggregationTypes any true The aggregation types used in the insights configuration.

anyOf

Name Type Required Restrictions Description
» anonymous [AggregationType] false [The type of the metric aggregation.]

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
costConfigurationId any false The ID of the cost configuration.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
customMetricId any false The ID of the custom metric (if using a custom metric).

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
customModelLLMValidationId any false The ID of the custom model LLM validation if using a custom model LLM for OOTB metrics.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
deploymentId any false The ID of the custom model deployment associated with the insight.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
errorMessage any false The error message associated with the evaluation dataset configuration or sidecar model metric validation or OOTB metric.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
errorResolution any false The error type associated with the insight error status and error message as an indicator of what fields needs to be edited if any.

anyOf

Name Type Required Restrictions Description
» anonymous [string] false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
evaluationDatasetConfigurationId any false The ID of the evaluation dataset configuration.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
executionStatus any false The execution status of the evaluation dataset configuration.

anyOf

Name Type Required Restrictions Description
» anonymous ExecutionStatus false Job and entity execution status.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
insightName string true maxLength: 5000
minLength: 1
minLength: 1
 The name of the insight.
insightType any false The type of the insight.

anyOf

Name Type Required Restrictions Description
» anonymous InsightTypes false The type of insight.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
isTransferable boolean false Indicates if insight can be transferred to production.
llmId any false The LLM ID for OOTB metrics that use LLMs.

anyOf

Name Type Required Restrictions Description
» anonymous LanguageModelTypeId false The ID that defines the type of the LLM.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
llmIsActive any false Whether the LLM is active.

anyOf

Name Type Required Restrictions Description
» anonymous boolean false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
llmIsDeprecated any false Whether the LLM is deprecated and will be removed in a future release.

anyOf

Name Type Required Restrictions Description
» anonymous boolean false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
modelId any false The ID of the model associated with deploymentId.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
modelPackageRegisteredModelId any false The ID of the registered model package associated with deploymentId.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
moderationConfiguration any false The moderation configuration associated with the insight configuration.

anyOf

Name Type Required Restrictions Description
» anonymous ModerationConfigurationWithID false Moderation Configuration associated with an insight.

or

Name Type Required Restrictions Description
» anonymous ModerationConfigurationWithoutID false Moderation Configuration associated with an insight.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
nemoMetricId any false The ID of the Nemo configuration.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
ootbMetricId any false The ID of the ootb metric (if using an ootb metric).

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
ootbMetricName any false The OOTB metric name.

anyOf

Name Type Required Restrictions Description
» anonymous OOTBMetricInsightNames false The Out-Of-The-Box metric name that can be used in the playground.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
resultUnit any false The unit of measurement associated with the insight result.

anyOf

Name Type Required Restrictions Description
» anonymous MetricUnit false The unit of measurement associated with a metric.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
sidecarModelMetricMetadata any false The metadata of the sidecar model metric (if using a sidecar model metric).

anyOf

Name Type Required Restrictions Description
» anonymous SidecarModelMetricMetadata false The metadata of a sidecar model metric.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
sidecarModelMetricValidationId any false The ID of the sidecar model metric validation (if using a sidecar model metric).

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
stage any false The stage (prompt or response) where insight is calculated at.

anyOf

Name Type Required Restrictions Description
» anonymous PipelineStage false Enum that describes at which stage the metric may be calculated.

or

Name Type Required Restrictions Description
» anonymous null false none

IntegerSettingConstraints

{
  "maxValue": 0,
  "minValue": 0,
  "type": "integer"
}

IntegerSettingConstraints

Properties

Name Type Required Restrictions Description
maxValue any false The maximum value of the setting (inclusive).

anyOf

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
minValue any false The minimum value of the setting (inclusive).

anyOf

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
type string false The data type of the setting.

Intervention

{
  "action": "block",
  "message": "string"
}

Intervention

Properties

Name Type Required Restrictions Description
action ModerationAction true The intervention strategy.
message string true minLength: 1
minLength: 1
 The intervention message to replace the prediction when a guard condition is satisfied.

JobErrorCode

0

JobErrorCode

Properties

Name Type Required Restrictions Description
JobErrorCode integer false Possible job error codes. This enum exists for consistency with the DataRobot Status API.

Enumerated Values

Property Value
JobErrorCode [0, 1]

JobExecutionState

"INITIALIZED"

JobExecutionState

Properties

Name Type Required Restrictions Description
JobExecutionState string false Possible job states. Values match the DataRobot Status API.

Enumerated Values

Property Value
JobExecutionState [INITIALIZED, RUNNING, COMPLETED, ERROR, ABORTED, EXPIRED]

LLMBlueprintResponse

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "creationUserName": "string",
  "customModelLLMErrorMessage": "string",
  "customModelLLMErrorResolution": "string",
  "customModelLLMValidationStatus": "TESTING",
  "description": "string",
  "id": "string",
  "isActive": true,
  "isDeprecated": true,
  "isSaved": true,
  "isStarred": true,
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "lastUpdateUserId": "string",
  "llmId": "azure-openai-gpt-3.5-turbo",
  "llmName": "string",
  "llmSettings": {
    "maxCompletionLength": 0,
    "systemPrompt": "string",
    "temperature": 0,
    "topP": 0
  },
  "name": "string",
  "playgroundId": "string",
  "promptType": "CHAT_HISTORY_AWARE",
  "retirementDate": "2019-08-24",
  "vectorDatabaseErrorMessage": "string",
  "vectorDatabaseErrorResolution": "string",
  "vectorDatabaseFamilyId": "string",
  "vectorDatabaseId": "string",
  "vectorDatabaseName": "string",
  "vectorDatabaseSettings": {
    "addNeighborChunks": false,
    "maxDocumentsRetrievedPerPrompt": 1,
    "maxTokens": 1,
    "retriever": "SINGLE_LOOKUP_RETRIEVER"
  },
  "vectorDatabaseStatus": "NEW"
}

LLMBlueprintResponse

Properties

Name Type Required Restrictions Description
creationDate string(date-time) true The creation date of the LLM blueprint (ISO 8601 formatted).
creationUserId string true The ID of the user that created this LLM blueprint.
creationUserName string true The name of the user who created this LLM blueprint.
customModelLLMErrorMessage any true The error message of the custom model LLM (if using a custom model LLM).

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
customModelLLMErrorResolution any true The suggested error resolution for the custom model LLM (if using a custom model LLM).

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
customModelLLMValidationStatus any true The validation status of the custom model LLM (if using a custom model LLM).

anyOf

Name Type Required Restrictions Description
» anonymous CustomModelValidationStatus false Status of custom model validation.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
description string true The description of the LLM blueprint.
id string true The ID of the LLM blueprint.
isActive boolean true Whether the LLM specified in this blueprint is active in the current environment.
isDeprecated boolean true Whether the LLM specified in this blueprint is deprecated.
isSaved boolean true If false, then this LLM blueprint is a draft and its settings can be changed. If true, then its settings are frozen and cannot be changed anymore.
isStarred boolean true Specifies whether this LLM blueprint is starred.
lastUpdateDate string(date-time) true The date of the most recent update of this LLM blueprint (ISO 8601 formatted).
lastUpdateUserId string true The ID of the user that made the most recent update to this LLM blueprint.
llmId any false The ID of the LLM selected for this LLM blueprint.

anyOf

Name Type Required Restrictions Description
» anonymous LanguageModelTypeId false The ID that defines the type of the LLM.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
llmName any true The name of the LLM used by this LLM blueprint.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
llmSettings any false A key/value dictionary of LLM settings.

anyOf

Name Type Required Restrictions Description
» anonymous CommonLLMSettings false The settings that are available for all non-custom LLMs.

or

Name Type Required Restrictions Description
» anonymous CustomModelLLMSettings false The settings that are available for custom model LLMs.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
name string true The name of the LLM blueprint.
playgroundId string true The ID of the playground this LLM blueprint belongs to.
promptType PromptType true Specifies whether the chat history is submitted as context to the user prompt.
retirementDate any false When the LLM is expected to be retired and no longer available for submitting new prompts.

anyOf

Name Type Required Restrictions Description
» anonymous string(date) false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
vectorDatabaseErrorMessage any true The error message of the vector database associated with this LLM.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
vectorDatabaseErrorResolution any true The suggested error resolution for the vector database associated with this LLM blueprint.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
vectorDatabaseFamilyId any true The ID of the vector database family associated with this LLM blueprint.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
vectorDatabaseId any false The ID of the vector database linked to this LLM blueprint.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
vectorDatabaseName any true The name of the vector database associated with this LLM blueprint.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
vectorDatabaseSettings any false A key/value dictionary of vector database settings.

anyOf

Name Type Required Restrictions Description
» anonymous VectorDatabaseSettings false Vector database retrieval settings.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
vectorDatabaseStatus any true The creation status of the vector database associated with this LLM blueprint.

anyOf

Name Type Required Restrictions Description
» anonymous ExecutionStatus false Job and entity execution status.

or

Name Type Required Restrictions Description
» anonymous null false none

LLMCreator

"OpenAI"

LLMCreator

Properties

Name Type Required Restrictions Description
LLMCreator string false The creator of the LLM.

Enumerated Values

Property Value
LLMCreator [OpenAI, Amazon, Google, Anthropic, Unknown]

LLMReference

{
  "name": "string",
  "url": "string"
}

LLMReference

Properties

Name Type Required Restrictions Description
name string true Description of the reference document.
url any true URL of the reference document.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

LLMSettingDefinition

{
  "constraints": {
    "maxValue": 0,
    "minValue": 0,
    "type": "integer"
  },
  "defaultValue": true,
  "description": "string",
  "format": "multiline",
  "id": "string",
  "isNullable": true,
  "name": "string",
  "type": "integer"
}

LLMSettingDefinition

Properties

Name Type Required Restrictions Description
constraints any true The constraints for the LLM setting values.

anyOf - discriminator: type

Name Type Required Restrictions Description
» anonymous any false none

oneOf

Name Type Required Restrictions Description
»» anonymous IntegerSettingConstraints false Available constraints for integer settings.

xor

Name Type Required Restrictions Description
»» anonymous FloatSettingConstraints false Available constraints for float settings.

xor

Name Type Required Restrictions Description
»» anonymous StringSettingConstraints false Available constraints for string settings.

xor

Name Type Required Restrictions Description
»» anonymous BooleanSettingConstraints false Available constraints for boolean settings.

xor

Name Type Required Restrictions Description
»» anonymous ObjectIdSettingConstraints false Available constraints for ObjectId settings.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
defaultValue any true The default value of the LLM setting.

anyOf

Name Type Required Restrictions Description
» anonymous boolean false none

or

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous number false none

or

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
description string true The description of the LLM setting.
format any false The expected format of the value of the LLM setting.

anyOf

Name Type Required Restrictions Description
» anonymous SettingFormat false Supported formats for settings.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
id string true The ID of the LLM setting.
isNullable boolean false Whether the setting allows null values (default: true).
name string true The name of the LLM setting.
type SettingType true The data type of the LLM setting.

LLMType

"openAi"

LLMType

Properties

Name Type Required Restrictions Description
LLMType string false LLM provider type.

Enumerated Values

Property Value
LLMType [openAi, azureOpenAi]

LanguageModelDefinitionResponse

{
  "contextSize": 0,
  "creator": "OpenAI",
  "dateAdded": "2019-08-24",
  "description": "string",
  "documentationLink": "string",
  "id": "azure-openai-gpt-3.5-turbo",
  "isActive": true,
  "isDeprecated": true,
  "isMetered": true,
  "license": "string",
  "name": "string",
  "provider": "string",
  "referenceLinks": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "retirementDate": "2019-08-24",
  "settings": [
    {
      "constraints": {
        "maxValue": 0,
        "minValue": 0,
        "type": "integer"
      },
      "defaultValue": true,
      "description": "string",
      "format": "multiline",
      "id": "string",
      "isNullable": true,
      "name": "string",
      "type": "integer"
    }
  ],
  "suggestedReplacement": "azure-openai-gpt-3.5-turbo",
  "supportedCustomModelLLMValidations": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "supportedLanguages": "string",
  "vendor": "string"
}

LanguageModelDefinitionResponse

Properties

Name Type Required Restrictions Description
contextSize any false The size of the LLM's context, measured in tokens. null if unknown.

anyOf

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
creator LLMCreator true The company that originally created the LLM.
dateAdded string(date) true The date the LLM was added to the GenAI playground.
description string true The details about the LLM.
documentationLink any true The link to the vendor documentation for the LLM.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
id LanguageModelTypeId true The ID of the LLM.
isActive boolean true Whether the LLM is active.
isDeprecated boolean true Whether the LLM is deprecated and will be removed in a future release.
isMetered boolean false Whether the LLM usage is metered.
license string true The usage license information for the LLM.
name string true The name of the LLM.
provider string true The party that provides access to the LLM.
referenceLinks [LLMReference] true The references for the LLM.
retirementDate any false When the LLM is expected to be retired and no longer available for submitting new prompts.

anyOf

Name Type Required Restrictions Description
» anonymous string(date) false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
settings [LLMSettingDefinition] true The settings supported by the LLM.
suggestedReplacement any false The ID of the LLM suggested as a replacement for this one when it is retired.

anyOf

Name Type Required Restrictions Description
» anonymous LanguageModelTypeId false The ID that defines the type of the LLM.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
supportedCustomModelLLMValidations any false The supported custom model validations if applicable for this LLM ID.

anyOf

Name Type Required Restrictions Description
» anonymous [SupportedCustomModelLLMValidation] false [The metadata describing a validated custom model LLM.]

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
supportedLanguages string true The languages supported by the LLM.
vendor string true The vendor of the LLM.

LanguageModelTypeId

"azure-openai-gpt-3.5-turbo"

LanguageModelTypeId

Properties

Name Type Required Restrictions Description
LanguageModelTypeId string false The ID that defines the type of the LLM.

Enumerated Values

Property Value
LanguageModelTypeId [azure-openai-gpt-3.5-turbo, azure-openai-gpt-3.5-turbo-16k, azure-openai-gpt-4, azure-openai-gpt-4-32k, azure-openai-gpt-4-turbo, azure-openai-gpt-4-o, azure-openai-gpt-4-o-mini, amazon-titan, amazon-nova-micro, amazon-nova-lite, amazon-nova-pro, anthropic-claude-2, anthropic-claude-3-haiku, anthropic-claude-3-sonnet, anthropic-claude-3-opus, anthropic-claude-3.5-sonnet-v1, amazon-anthropic-claude-3.5-sonnet-v2, google-bison, google-gemini-1.5-flash, google-gemini-1.5-pro, custom-model]

ListCustomModelLLMValidationsResponse

{
  "count": 0,
  "data": [
    {
      "chatModelId": "string",
      "creationDate": "2019-08-24T14:15:22Z",
      "deploymentAccessData": {
        "authorizationHeader": "[REDACTED]",
        "chatApiUrl": "string",
        "datarobotKey": "string",
        "inputType": "CSV",
        "modelType": "TEXT_GENERATION",
        "predictionApiUrl": "string"
      },
      "deploymentId": "string",
      "deploymentName": "string",
      "errorMessage": "string",
      "id": "string",
      "modelId": "string",
      "name": "string",
      "predictionTimeout": 0,
      "promptColumnName": "string",
      "targetColumnName": "string",
      "tenantId": "string",
      "useCaseId": "string",
      "userId": "string",
      "userName": "string",
      "validationStatus": "TESTING"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

ListCustomModelLLMValidationsResponse

Properties

Name Type Required Restrictions Description
count integer true The number of records on this page.
data [CustomModelLLMValidationResponse] true The list of records.
next any true The URL to the next page, or null if there is no such page.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
previous any true The URL to the previous page, or null if there is no such page.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
totalCount integer true The total number of records.

ListCustomModelValidationSortQueryParam

"name"

ListCustomModelValidationSortQueryParam

Properties

Name Type Required Restrictions Description
ListCustomModelValidationSortQueryParam string false Sort order values for listing custom model validations.

Enumerated Values

Property Value
ListCustomModelValidationSortQueryParam [name, -name, deploymentName, -deploymentName, userName, -userName, creationDate, -creationDate]

ListLLMBlueprintSortQueryParam

"name"

ListLLMBlueprintSortQueryParam

Properties

Name Type Required Restrictions Description
ListLLMBlueprintSortQueryParam string false Sort order values for listing LLM blueprints.

Enumerated Values

Property Value
ListLLMBlueprintSortQueryParam [name, -name, description, -description, creationUserId, -creationUserId, creationDate, -creationDate, lastUpdateUserId, -lastUpdateUserId, lastUpdateDate, -lastUpdateDate, llmId, -llmId, vectorDatabaseId, -vectorDatabaseId]

ListLLMBlueprintsResponse

{
  "count": 0,
  "data": [
    {
      "creationDate": "2019-08-24T14:15:22Z",
      "creationUserId": "string",
      "creationUserName": "string",
      "customModelLLMErrorMessage": "string",
      "customModelLLMErrorResolution": "string",
      "customModelLLMValidationStatus": "TESTING",
      "description": "string",
      "id": "string",
      "isActive": true,
      "isDeprecated": true,
      "isSaved": true,
      "isStarred": true,
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "lastUpdateUserId": "string",
      "llmId": "azure-openai-gpt-3.5-turbo",
      "llmName": "string",
      "llmSettings": {
        "maxCompletionLength": 0,
        "systemPrompt": "string",
        "temperature": 0,
        "topP": 0
      },
      "name": "string",
      "playgroundId": "string",
      "promptType": "CHAT_HISTORY_AWARE",
      "retirementDate": "2019-08-24",
      "vectorDatabaseErrorMessage": "string",
      "vectorDatabaseErrorResolution": "string",
      "vectorDatabaseFamilyId": "string",
      "vectorDatabaseId": "string",
      "vectorDatabaseName": "string",
      "vectorDatabaseSettings": {
        "addNeighborChunks": false,
        "maxDocumentsRetrievedPerPrompt": 1,
        "maxTokens": 1,
        "retriever": "SINGLE_LOOKUP_RETRIEVER"
      },
      "vectorDatabaseStatus": "NEW"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

ListLLMBlueprintsResponse

Properties

Name Type Required Restrictions Description
count integer true The number of records on this page.
data [LLMBlueprintResponse] true The list of records.
next any true The URL to the next page, or null if there is no such page.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
previous any true The URL to the previous page, or null if there is no such page.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
totalCount integer true The total number of records.

ListLLMsResponse

{
  "count": 0,
  "data": [
    {
      "contextSize": 0,
      "creator": "OpenAI",
      "dateAdded": "2019-08-24",
      "description": "string",
      "documentationLink": "string",
      "id": "azure-openai-gpt-3.5-turbo",
      "isActive": true,
      "isDeprecated": true,
      "isMetered": true,
      "license": "string",
      "name": "string",
      "provider": "string",
      "referenceLinks": [
        {
          "name": "string",
          "url": "string"
        }
      ],
      "retirementDate": "2019-08-24",
      "settings": [
        {
          "constraints": {
            "maxValue": 0,
            "minValue": 0,
            "type": "integer"
          },
          "defaultValue": true,
          "description": "string",
          "format": "multiline",
          "id": "string",
          "isNullable": true,
          "name": "string",
          "type": "integer"
        }
      ],
      "suggestedReplacement": "azure-openai-gpt-3.5-turbo",
      "supportedCustomModelLLMValidations": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "supportedLanguages": "string",
      "vendor": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

ListLLMsResponse

Properties

Name Type Required Restrictions Description
count integer true The number of records on this page.
data [LanguageModelDefinitionResponse] true The list of records.
next any true The URL to the next page, or null if there is no such page.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
previous any true The URL to the previous page, or null if there is no such page.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
totalCount integer true The total number of records.

ListPlaygroundSortQueryParam

"name"

ListPlaygroundSortQueryParam

Properties

Name Type Required Restrictions Description
ListPlaygroundSortQueryParam string false Sort order values for listing playgrounds.

Enumerated Values

Property Value
ListPlaygroundSortQueryParam [name, -name, description, -description, creationUserId, -creationUserId, creationDate, -creationDate, lastUpdateUserId, -lastUpdateUserId, lastUpdateDate, -lastUpdateDate, savedLLMBlueprintsCount, -savedLLMBlueprintsCount, llmBlueprintsCount, -llmBlueprintsCount]

ListPlaygroundsResponse

{
  "count": 0,
  "data": [
    {
      "creationDate": "2019-08-24T14:15:22Z",
      "creationUserId": "string",
      "description": "string",
      "id": "string",
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "lastUpdateUserId": "string",
      "llmBlueprintsCount": 0,
      "name": "string",
      "savedLLMBlueprintsCount": 0,
      "useCaseId": "string",
      "userName": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

ListPlaygroundsResponse

Properties

Name Type Required Restrictions Description
count integer true The number of records on this page.
data [PlaygroundResponse] true The list of records.
next any true The URL to the next page, or null if there is no such page.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
previous any true The URL to the previous page, or null if there is no such page.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
totalCount integer true The total number of records.

ListTracesResponse

{
  "count": 0,
  "data": [
    {
      "chatId": "string",
      "chatName": "string",
      "chatPromptId": "string",
      "comparisonPromptId": "string",
      "confidenceScores": {},
      "evaluationDatasetConfigurationId": "string",
      "executionStatus": "NEW",
      "llmBlueprintId": "string",
      "llmBlueprintName": "string",
      "llmLicense": "string",
      "llmName": "string",
      "llmSettings": {
        "maxCompletionLength": 0,
        "systemPrompt": "string",
        "temperature": 0,
        "topP": 0
      },
      "llmVendor": "string",
      "promptType": "CHAT_HISTORY_AWARE",
      "resultMetadata": {
        "blockedResultText": "string",
        "cost": 0,
        "errorMessage": "string",
        "estimatedDocsTokenCount": 0,
        "feedbackResult": {
          "negativeUserIds": [],
          "positiveUserIds": []
        },
        "finalPrompt": "string",
        "inputTokenCount": 0,
        "latencyMilliseconds": 0,
        "metrics": [],
        "outputTokenCount": 0,
        "providerLLMGuards": [
          {
            "name": "string",
            "satisfyCriteria": true,
            "stage": "prompt",
            "value": "string"
          }
        ],
        "totalTokenCount": 0
      },
      "resultText": "string",
      "text": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "useCaseId": "string",
      "user": {
        "id": "string",
        "name": "string"
      },
      "vectorDatabaseId": "string",
      "vectorDatabaseSettings": {
        "addNeighborChunks": false,
        "maxDocumentsRetrievedPerPrompt": 1,
        "maxTokens": 1,
        "retriever": "SINGLE_LOOKUP_RETRIEVER"
      },
      "warning": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

ListTracesResponse

Properties

Name Type Required Restrictions Description
count integer true The number of records on this page.
data [PromptTraceResponse] true The list of records.
next any true The URL to the next page, or null if there is no such page.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
previous any true The URL to the previous page, or null if there is no such page.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
totalCount integer true The total number of records.

MetricMetadata

{
  "costConfigurationId": "string",
  "customModelId": "string",
  "errorMessage": "string",
  "evaluationDatasetConfigurationId": "string",
  "executionStatus": "NEW",
  "formattedName": "string",
  "formattedValue": "string",
  "llmIsDeprecated": true,
  "name": "string",
  "nemoMetricId": "string",
  "ootbMetricId": "string",
  "sidecarModelMetricValidationId": "string",
  "stage": "prompt_pipeline",
  "value": null
}

MetricMetadata

Properties

Name Type Required Restrictions Description
costConfigurationId any false The ID of the cost configuration.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
customModelId any false The ID of the custom model used for the metric.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
errorMessage any false The error message associated with the metric computation.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
evaluationDatasetConfigurationId any false The ID of the evaluation dataset configuration.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
executionStatus any false The creation status of the vector database.

anyOf

Name Type Required Restrictions Description
» anonymous ExecutionStatus false Job and entity execution status.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
formattedName any false The formatted name of the metric.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
formattedValue any false The formatted value of the metric.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
llmIsDeprecated any false Whether the LLM is deprecated and will be removed in a future release.

anyOf

Name Type Required Restrictions Description
» anonymous boolean false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
name string true The name of the metric.
nemoMetricId any false The id of the NeMo Pipeline configuration.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
ootbMetricId any false The id of the OOTB metric configuration.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
sidecarModelMetricValidationId any false The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
stage any false The stage (prompt or response) that the metric applies to.

anyOf

Name Type Required Restrictions Description
» anonymous PipelineStage false Enum that describes at which stage the metric may be calculated.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
value any true The value of the metric.

MetricUnit

"s"

MetricUnit

Properties

Name Type Required Restrictions Description
MetricUnit string false The unit of measurement associated with a metric.

Enumerated Values

Property Value
MetricUnit [s, ms, %]

ModerationAction

"block"

ModerationAction

Properties

Name Type Required Restrictions Description
ModerationAction string false The moderation strategy.

Enumerated Values

Property Value
ModerationAction [block, report, reportAndBlock]

ModerationConfigurationWithID

{
  "guardConditions": [
    {
      "comparand": 0,
      "comparator": "greaterThan"
    }
  ],
  "intervention": {
    "action": "block",
    "message": "string"
  }
}

ModerationConfigurationWithID

Properties

Name Type Required Restrictions Description
guardConditions [GuardCondition] true maxItems: 1
minItems: 1
 The guard conditions associated with a metric.
intervention Intervention true The intervention specific moderation configuration.

ModerationConfigurationWithoutID

{
  "guardConditions": [
    {
      "comparand": 0,
      "comparator": "greaterThan"
    }
  ],
  "intervention": {
    "action": "block",
    "message": "string"
  }
}

ModerationConfigurationWithoutID

Properties

Name Type Required Restrictions Description
guardConditions [GuardCondition] true maxItems: 1
minItems: 1
 The guard conditions associated with a metric.
intervention Intervention true The intervention specific moderation configuration.

NemoConfigurationResponse

{
  "blockedTermsFileContents": "string",
  "promptLlmConfiguration": {
    "llmType": "openAi",
    "openaiApiBase": "string",
    "openaiApiDeploymentId": "string",
    "openaiApiKeyId": "string"
  },
  "promptModerationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "promptPipelineFiles": {
    "actionsFileContents": "string",
    "configYamlFileContents": "string",
    "flowDefinitionFileContents": "string",
    "promptsFileContents": "string"
  },
  "promptPipelineMetricName": "string",
  "promptPipelineTemplateId": "string",
  "responseLlmConfiguration": {
    "llmType": "openAi",
    "openaiApiBase": "string",
    "openaiApiDeploymentId": "string",
    "openaiApiKeyId": "string"
  },
  "responseModerationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "responsePipelineFiles": {
    "actionsFileContents": "string",
    "configYamlFileContents": "string",
    "flowDefinitionFileContents": "string",
    "promptsFileContents": "string"
  },
  "responsePipelineMetricName": "string",
  "responsePipelineTemplateId": "string"
}

NemoConfigurationResponse

Properties

Name Type Required Restrictions Description
blockedTermsFileContents string true The contents of the blocked terms file.
promptLlmConfiguration any true The LLM configuration for the prompt pipeline.

anyOf

Name Type Required Restrictions Description
» anonymous NemoLLMConfiguration false Configuration of LLM used for NeMo guardrails.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
promptModerationConfiguration any false The moderation configuration for the prompt pipeline.

anyOf

Name Type Required Restrictions Description
» anonymous ModerationConfigurationWithoutID false Moderation Configuration associated with an insight.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
promptPipelineFiles any true The prompt pipeline files for this configuration.

anyOf

Name Type Required Restrictions Description
» anonymous NemoPipelineFiles false Files used to setup a NeMo pipeline.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
promptPipelineMetricName any true Name for the NeMo Prompt pipeline metric.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
promptPipelineTemplateId any true Guard template to be used for the prompt pipeline, defines actions.py.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
responseLlmConfiguration any true The LLM configuration for the response pipeline.

anyOf

Name Type Required Restrictions Description
» anonymous NemoLLMConfiguration false Configuration of LLM used for NeMo guardrails.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
responseModerationConfiguration any false The moderation configuration for the response pipeline.

anyOf

Name Type Required Restrictions Description
» anonymous ModerationConfigurationWithoutID false Moderation Configuration associated with an insight.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
responsePipelineFiles any true The response pipeline files for this configuration.

anyOf

Name Type Required Restrictions Description
» anonymous NemoPipelineFiles false Files used to setup a NeMo pipeline.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
responsePipelineMetricName any true Name for the NeMo Response pipeline metric.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
responsePipelineTemplateId any true Guard template to be used for the response pipeline, defines actions.py.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

NemoConfigurationUpsertRequest

{
  "blockedTermsFileContents": "string",
  "promptLlmConfiguration": {
    "llmType": "openAi",
    "openaiApiBase": "string",
    "openaiApiDeploymentId": "string",
    "openaiApiKeyId": "string"
  },
  "promptModerationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "promptPipelineFiles": {
    "configYamlFileContents": "string",
    "flowDefinitionFileContents": "string",
    "promptsFileContents": "string"
  },
  "promptPipelineMetricName": "string",
  "promptPipelineTemplateId": "string",
  "responseLlmConfiguration": {
    "llmType": "openAi",
    "openaiApiBase": "string",
    "openaiApiDeploymentId": "string",
    "openaiApiKeyId": "string"
  },
  "responseModerationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "responsePipelineFiles": {
    "configYamlFileContents": "string",
    "flowDefinitionFileContents": "string",
    "promptsFileContents": "string"
  },
  "responsePipelineMetricName": "string",
  "responsePipelineTemplateId": "string"
}

NemoConfigurationUpsertRequest

Properties

Name Type Required Restrictions Description
blockedTermsFileContents string true The contents of the blocked terms file.
promptLlmConfiguration any false The LLM configuration for the prompt pipeline.

anyOf

Name Type Required Restrictions Description
» anonymous NemoLLMConfiguration false Configuration of LLM used for NeMo guardrails.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
promptModerationConfiguration any false The moderation configuration for the prompt pipeline.

anyOf

Name Type Required Restrictions Description
» anonymous ModerationConfigurationWithoutID false Moderation Configuration associated with an insight.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
promptPipelineFiles any false The prompt pipeline files for this configuration.

anyOf

Name Type Required Restrictions Description
» anonymous NemoPiplineFilesRequest false All of the files except for the actions.py file.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
promptPipelineMetricName any false Name for the NeMo Prompt pipeline metric.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
promptPipelineTemplateId any false Guard template to be used for the prompt pipeline, defines actions.py.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
responseLlmConfiguration any false The LLM configuration for the response pipeline.

anyOf

Name Type Required Restrictions Description
» anonymous NemoLLMConfiguration false Configuration of LLM used for NeMo guardrails.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
responseModerationConfiguration any false The moderation configuration for the response pipeline.

anyOf

Name Type Required Restrictions Description
» anonymous ModerationConfigurationWithoutID false Moderation Configuration associated with an insight.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
responsePipelineFiles any false The response pipeline files for this configuration.

anyOf

Name Type Required Restrictions Description
» anonymous NemoPiplineFilesRequest false All of the files except for the actions.py file.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
responsePipelineMetricName any false Name for the NeMo Response pipeline metric.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
responsePipelineTemplateId any false Guard template to be used for the response pipeline, defines actions.py.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

NemoLLMConfiguration

{
  "llmType": "openAi",
  "openaiApiBase": "string",
  "openaiApiDeploymentId": "string",
  "openaiApiKeyId": "string"
}

NemoLLMConfiguration

Properties

Name Type Required Restrictions Description
llmType LLMType true LLM provider type.
openaiApiBase any false Azure OpenAI API base.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
openaiApiDeploymentId any false Azure OpenAI API deployment ID.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
openaiApiKeyId any false OpenAI API Key.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

NemoPipelineFiles

{
  "actionsFileContents": "string",
  "configYamlFileContents": "string",
  "flowDefinitionFileContents": "string",
  "promptsFileContents": "string"
}

NemoPipelineFiles

Properties

Name Type Required Restrictions Description
actionsFileContents string true Contents of actions.py file.
configYamlFileContents string true Contents of config.yaml file.
flowDefinitionFileContents string true Contents of flows.co file.
promptsFileContents string true Contents of prompts.yaml file.

NemoPiplineFilesRequest

{
  "configYamlFileContents": "string",
  "flowDefinitionFileContents": "string",
  "promptsFileContents": "string"
}

NemoPiplineFilesRequest

Properties

Name Type Required Restrictions Description
configYamlFileContents string true The contents of the config.yaml file.
flowDefinitionFileContents string true The contents of the flow definition file.
promptsFileContents string true The contents of the prompts file.

OOTBMetricConfigurationRequest

{
  "customModelLLMValidationId": "string",
  "customOotbMetricName": "string",
  "llmId": "azure-openai-gpt-3.5-turbo",
  "moderationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "ootbMetricName": "latency"
}

OOTBMetricConfigurationRequest

Properties

Name Type Required Restrictions Description
customModelLLMValidationId any false The ID of the custom model LLM validation (if using a custom model LLM).

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
customOotbMetricName any false The custom OOTB metric name to be associated with the OOTB metric. Will default to OOTB metric name if not defined.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
llmId any false The ID of the LLM to use for correctness and faithfulness metrics.

anyOf

Name Type Required Restrictions Description
» anonymous LanguageModelTypeId false The ID that defines the type of the LLM.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
moderationConfiguration any false The moderation configuration to be associated with the OOTB metric.

anyOf

Name Type Required Restrictions Description
» anonymous ModerationConfigurationWithoutID false Moderation Configuration associated with an insight.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
ootbMetricName OOTBMetricInsightNames true The Out-Of-The-Box metric name that can be used in the playground.

OOTBMetricConfigurationResponse

{
  "customModelLLMValidationId": "string",
  "customOotbMetricName": "string",
  "errorMessage": "string",
  "errorResolution": [
    "ootbMetricName"
  ],
  "executionStatus": "NEW",
  "llmId": "azure-openai-gpt-3.5-turbo",
  "moderationConfiguration": {
    "guardConditions": [
      {
        "comparand": 0,
        "comparator": "greaterThan"
      }
    ],
    "intervention": {
      "action": "block",
      "message": "string"
    }
  },
  "ootbMetricConfigurationId": "string",
  "ootbMetricName": "latency"
}

OOTBMetricConfigurationResponse

Properties

Name Type Required Restrictions Description
customModelLLMValidationId any false The ID of the custom model LLM validation (if using a custom model LLM).

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
customOotbMetricName any false The custom OOTB metric name to be associated with the OOTB metric.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
errorMessage any false The error message associated with the OOTB metric configuration.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
errorResolution any false The error type associated with the insight error status and error message as an indicator of what fields needs to be edited if any.

anyOf

Name Type Required Restrictions Description
» anonymous [InsightErrorResolution] false [Error type linking directly to the field name that is related to the error.]

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
executionStatus ExecutionStatus true The execution status of the OOTB metric configuration.
llmId any false The ID of the LLM to use for correctness and faithfulness metrics.

anyOf

Name Type Required Restrictions Description
» anonymous LanguageModelTypeId false The ID that defines the type of the LLM.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
moderationConfiguration any false The moderation configuration to be associated with the OOTB metric.

anyOf

Name Type Required Restrictions Description
» anonymous ModerationConfigurationWithoutID false Moderation Configuration associated with an insight.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
ootbMetricConfigurationId string true The ID of OOTB metric.
ootbMetricName OOTBMetricInsightNames true The Out-Of-The-Box metric name that can be used in the playground.

OOTBMetricConfigurationsResponse

{
  "ootbMetricConfigurations": [
    {
      "customModelLLMValidationId": "string",
      "customOotbMetricName": "string",
      "errorMessage": "string",
      "errorResolution": [
        "ootbMetricName"
      ],
      "executionStatus": "NEW",
      "llmId": "azure-openai-gpt-3.5-turbo",
      "moderationConfiguration": {
        "guardConditions": [
          {
            "comparand": 0,
            "comparator": "greaterThan"
          }
        ],
        "intervention": {
          "action": "block",
          "message": "string"
        }
      },
      "ootbMetricConfigurationId": "string",
      "ootbMetricName": "latency"
    }
  ]
}

OOTBMetricConfigurationsResponse

Properties

Name Type Required Restrictions Description
ootbMetricConfigurations [OOTBMetricConfigurationResponse] true The list of OOTB metric configurations to use.

OOTBMetricInsightNames

"latency"

OOTBMetricInsightNames

Properties

Name Type Required Restrictions Description
OOTBMetricInsightNames string false The Out-Of-The-Box metric name that can be used in the playground.

Enumerated Values

Property Value
OOTBMetricInsightNames [latency, citations, rouge_1, faithfulness, correctness, prompt_tokens, response_tokens, document_tokens, all_tokens, jailbreak_violation, toxicity_violation, pii_violation, exact_match, starts_with, contains]

ObjectIdSettingConstraints

{
  "allowedChoices": [
    "string"
  ],
  "type": "object_id"
}

ObjectIdSettingConstraints

Properties

Name Type Required Restrictions Description
allowedChoices any false The allowed values for the setting.

anyOf

Name Type Required Restrictions Description
» anonymous [string] false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
type string false The data type of the setting.

PipelineStage

"prompt_pipeline"

PipelineStage

Properties

Name Type Required Restrictions Description
PipelineStage string false Enum that describes at which stage the metric may be calculated.

Enumerated Values

Property Value
PipelineStage [prompt_pipeline, response_pipeline]

PlaygroundResponse

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "description": "string",
  "id": "string",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "lastUpdateUserId": "string",
  "llmBlueprintsCount": 0,
  "name": "string",
  "savedLLMBlueprintsCount": 0,
  "useCaseId": "string",
  "userName": "string"
}

PlaygroundResponse

Properties

Name Type Required Restrictions Description
creationDate string(date-time) true The creation date of the playground (ISO 8601 formatted).
creationUserId string true The ID of the user that created this playground.
description string true The description of the playground.
id string true The ID of the playground.
lastUpdateDate string(date-time) true The date of the most recent update of this playground (ISO 8601 formatted).
lastUpdateUserId string true The ID of the user that made the most recent update to this playground.
llmBlueprintsCount integer true The number of LLM blueprints in this playground.
name string true The name of the playground.
savedLLMBlueprintsCount integer true The number of saved LLM blueprints in this playground.
useCaseId string true The ID of the use case this playground belongs to.
userName string true The name of the user that created this playground.

PromptTraceResponse

{
  "chatId": "string",
  "chatName": "string",
  "chatPromptId": "string",
  "comparisonPromptId": "string",
  "confidenceScores": {},
  "evaluationDatasetConfigurationId": "string",
  "executionStatus": "NEW",
  "llmBlueprintId": "string",
  "llmBlueprintName": "string",
  "llmLicense": "string",
  "llmName": "string",
  "llmSettings": {
    "maxCompletionLength": 0,
    "systemPrompt": "string",
    "temperature": 0,
    "topP": 0
  },
  "llmVendor": "string",
  "promptType": "CHAT_HISTORY_AWARE",
  "resultMetadata": {
    "blockedResultText": "string",
    "cost": 0,
    "errorMessage": "string",
    "estimatedDocsTokenCount": 0,
    "feedbackResult": {
      "negativeUserIds": [],
      "positiveUserIds": []
    },
    "finalPrompt": "string",
    "inputTokenCount": 0,
    "latencyMilliseconds": 0,
    "metrics": [],
    "outputTokenCount": 0,
    "providerLLMGuards": [
      {
        "name": "string",
        "satisfyCriteria": true,
        "stage": "prompt",
        "value": "string"
      }
    ],
    "totalTokenCount": 0
  },
  "resultText": "string",
  "text": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "useCaseId": "string",
  "user": {
    "id": "string",
    "name": "string"
  },
  "vectorDatabaseId": "string",
  "vectorDatabaseSettings": {
    "addNeighborChunks": false,
    "maxDocumentsRetrievedPerPrompt": 1,
    "maxTokens": 1,
    "retriever": "SINGLE_LOOKUP_RETRIEVER"
  },
  "warning": "string"
}

PromptTraceResponse

Properties

Name Type Required Restrictions Description
chatId any true The ID of the chat associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
chatName any true The name of the chat associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
chatPromptId any true The ID of the chat prompt associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
comparisonPromptId any true The ID of the comparison prompts associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
confidenceScores any true The confidence scores that measure the similarity between the prompt context and the prompt completion for the prompt associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous object false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
evaluationDatasetConfigurationId any true The ID of the evaluation dataset associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
executionStatus ExecutionStatus true The execution status of the prompt associated with the trace.
llmBlueprintId string true The ID of the LLM blueprint associated with the trace.
llmBlueprintName string true The name of the LLM blueprint associated with the trace.
llmLicense any true The usage license information for the LLM associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
llmName any true The name of the LLM associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
llmSettings any true The settings of the LLM associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous CommonLLMSettings false The settings that are available for all non-custom LLMs.

or

Name Type Required Restrictions Description
» anonymous CustomModelLLMSettings false The settings that are available for custom model LLMs.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
llmVendor any true The vendor of the LLM associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
promptType any true The type of prompt, chat history awair or one time prompt.

anyOf

Name Type Required Restrictions Description
» anonymous PromptType false Determines whether chat history is submitted as context to the user prompt.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
resultMetadata any true The additional information about the prompt associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous ResultMetadata false The additional information about prompt execution results.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
resultText any true The completion text of the prompt associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
text string true The text of the prompt associated with the trace.
timestamp string(date-time) true The timestamp of the trace (ISO 8601 formatted).
useCaseId string true The ID of the use case associated with the trace.
user DataRobotUser true The user associated with the trace.
vectorDatabaseId any true The ID of the vector database associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
vectorDatabaseSettings any true The settings of the vector database associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous VectorDatabaseSettings false Vector database retrieval settings.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
warning any true The warning message for the prompt associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

PromptType

"CHAT_HISTORY_AWARE"

PromptType

Properties

Name Type Required Restrictions Description
PromptType string false Determines whether chat history is submitted as context to the user prompt.

Enumerated Values

Property Value
PromptType [CHAT_HISTORY_AWARE, ONE_TIME_PROMPT]

ProviderGuardStage

"prompt"

ProviderGuardStage

Properties

Name Type Required Restrictions Description
ProviderGuardStage string false The data stage where the provider guard metric is acting upon.

Enumerated Values

Property Value
ProviderGuardStage [prompt, response]

ProviderGuardsMetadata

{
  "name": "string",
  "satisfyCriteria": true,
  "stage": "prompt",
  "value": "string"
}

ProviderGuardsMetadata

Properties

Name Type Required Restrictions Description
name string true The name of the provider guard metric.
satisfyCriteria boolean true Whether the configured provider guard metric satisfied its hidden internal guard criteria.
stage ProviderGuardStage true The data stage where the provider guard metric is acting upon.
value any true The value of the provider guard metric.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous number false none

or

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous null false none

ResultMetadata

{
  "blockedResultText": "string",
  "cost": 0,
  "errorMessage": "string",
  "estimatedDocsTokenCount": 0,
  "feedbackResult": {
    "negativeUserIds": [],
    "positiveUserIds": []
  },
  "finalPrompt": "string",
  "inputTokenCount": 0,
  "latencyMilliseconds": 0,
  "metrics": [],
  "outputTokenCount": 0,
  "providerLLMGuards": [
    {
      "name": "string",
      "satisfyCriteria": true,
      "stage": "prompt",
      "value": "string"
    }
  ],
  "totalTokenCount": 0
}

ResultMetadata

Properties

Name Type Required Restrictions Description
blockedResultText any false The message to replace the result text if it is non empty, which represents a blocked response.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
cost any false The estimated cost of executing the prompt.

anyOf

Name Type Required Restrictions Description
» anonymous number false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
errorMessage any false The error message for the prompt (in case of an errored prompt).

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
estimatedDocsTokenCount integer false The estimated number of tokens in the documents retrieved from the vector database.
feedbackResult FeedbackResult false The user feedback associated with the prompt.
finalPrompt any false The final representation of the prompt that was submitted to the LLM.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous [object] false none
»» additionalProperties any false none

anyOf

Name Type Required Restrictions Description
»»» anonymous string false none

or

Name Type Required Restrictions Description
»»» anonymous [object] false none

or

Name Type Required Restrictions Description
»»» anonymous null false none

or

Name Type Required Restrictions Description
» anonymous [object] false none
»» additionalProperties any false none

anyOf

Name Type Required Restrictions Description
»»» anonymous string false none

or

Name Type Required Restrictions Description
»»» anonymous [object] false none

or

Name Type Required Restrictions Description
» anonymous object false none
»» additionalProperties any false none

anyOf

Name Type Required Restrictions Description
»»» anonymous string false none

or

Name Type Required Restrictions Description
»»» anonymous [object] false none
»»»» additionalProperties string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
inputTokenCount integer false The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).
latencyMilliseconds integer true The latency of the LLM response (in milliseconds).
metrics [MetricMetadata] false The evaluation metrics for the prompt.
outputTokenCount integer false The number of tokens in the LLM output.
providerLLMGuards any false The provider llm guards metadata.

anyOf

Name Type Required Restrictions Description
» anonymous [ProviderGuardsMetadata] false [Info on the provider guard metrics.]

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
totalTokenCount integer false The combined number of tokens in the LLM input and output.

RetrieveUserLimitCounterResponse

{
  "counter": 0
}

RetrieveUserLimitCounterResponse

Properties

Name Type Required Restrictions Description
counter integer true The number of completed operations which count towards the usage limit.

SettingFormat

"multiline"

SettingFormat

Properties

Name Type Required Restrictions Description
SettingFormat string false Supported formats for settings.

Enumerated Values

Property Value
SettingFormat multiline

SettingType

"integer"

SettingType

Properties

Name Type Required Restrictions Description
SettingType string false Supported data types for settings.

Enumerated Values

Property Value
SettingType [integer, float, string, boolean, object_id, list]

SidecarModelMetricMetadata

{
  "expectedResponseColumnName": "string",
  "promptColumnName": "string",
  "responseColumnName": "string",
  "targetColumnName": "string"
}

SidecarModelMetricMetadata

Properties

Name Type Required Restrictions Description
expectedResponseColumnName any false The name of the column the custom model uses for expected response text input.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
promptColumnName any false The name of the column the custom model uses for prompt text input.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
responseColumnName any false The name of the column the custom model uses for response text input.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
targetColumnName any true The name of the column the custom model uses for prediction output.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

StatusResponse

{
  "code": 0,
  "created": "2019-08-24T14:15:22Z",
  "description": "",
  "message": "",
  "status": "INITIALIZED",
  "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  "statusType": ""
}

StatusResponse

Properties

Name Type Required Restrictions Description
code JobErrorCode true The error code associated with the job.
created string(date-time) true The creation date of the job (ISO 8601 formatted).
description string false The description associated with the job.
message string false The error message associated with the job.
status JobExecutionState true The execution status of the job.
statusId string(uuid) true ID that can be used with GET /api/v2/status/{statusId}/ to poll for the testing job's status.
statusType string false The type of the status object.

StringSettingConstraints

{
  "allowedChoices": [
    "string"
  ],
  "maxLength": 0,
  "minLength": 0,
  "type": "string"
}

StringSettingConstraints

Properties

Name Type Required Restrictions Description
allowedChoices any false The allowed values for the setting.

anyOf

Name Type Required Restrictions Description
» anonymous [string] false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
maxLength any false The maximum length of the value (inclusive).

anyOf

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
minLength any false The minimum length of the value (inclusive).

anyOf

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
type string false The data type of the setting.

SupportedCustomModelLLMValidation

{
  "id": "string",
  "name": "string"
}

SupportedCustomModelLLMValidation

Properties

Name Type Required Restrictions Description
id string true The ID of the custom model LLM validation.
name string true The name of the custom model LLM validation.

SupportedDeploymentType

"TEXT_GENERATION"

SupportedDeploymentType

Properties

Name Type Required Restrictions Description
SupportedDeploymentType string false The type of the target output a DataRobot deployment produces.

Enumerated Values

Property Value
SupportedDeploymentType [TEXT_GENERATION, VECTOR_DATABASE, UNSTRUCTURED, REGRESSION, MULTICLASS, BINARY, NOT_SUPPORTED]

SupportedInsightsResponse

{
  "insightsConfiguration": [
    {
      "aggregationTypes": [
        "average"
      ],
      "costConfigurationId": "string",
      "customMetricId": "string",
      "customModelLLMValidationId": "string",
      "deploymentId": "string",
      "errorMessage": "string",
      "errorResolution": [
        "string"
      ],
      "evaluationDatasetConfigurationId": "string",
      "executionStatus": "NEW",
      "insightName": "string",
      "insightType": "Reference",
      "isTransferable": false,
      "llmId": "azure-openai-gpt-3.5-turbo",
      "llmIsActive": true,
      "llmIsDeprecated": true,
      "modelId": "string",
      "modelPackageRegisteredModelId": "string",
      "moderationConfiguration": {
        "guardConditions": [
          {
            "comparand": 0,
            "comparator": "greaterThan"
          }
        ],
        "intervention": {
          "action": "block",
          "message": "string"
        }
      },
      "nemoMetricId": "string",
      "ootbMetricId": "string",
      "ootbMetricName": "latency",
      "resultUnit": "s",
      "sidecarModelMetricMetadata": {
        "expectedResponseColumnName": "string",
        "promptColumnName": "string",
        "responseColumnName": "string",
        "targetColumnName": "string"
      },
      "sidecarModelMetricValidationId": "string",
      "stage": "prompt_pipeline"
    }
  ]
}

SupportedInsightsResponse

Properties

Name Type Required Restrictions Description
insightsConfiguration [InsightsConfigurationWithAdditionalData] true The list of supported insights configurations.

TraceChat

{
  "id": "string",
  "name": "string"
}

TraceChat

Properties

Name Type Required Restrictions Description
id string true The ID of the chat associated with the trace.
name any true Name of the chat associated with the trace.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

TraceDatasetResponse

{
  "aiCatalogId": "string"
}

TraceDatasetResponse

Properties

Name Type Required Restrictions Description
aiCatalogId string true The Data Registry dataset ID.

TraceMetadataResponse

{
  "chats": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "users": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

TraceMetadataResponse

Properties

Name Type Required Restrictions Description
chats [TraceChat] true The list of combined chat and comparison prompt chats available in trace.
users [DataRobotUser] true The list of unique users available in the trace response.

UpdateLLMBlueprintRequest

{
  "description": "string",
  "isSaved": true,
  "isStarred": true,
  "llmId": "azure-openai-gpt-3.5-turbo",
  "llmSettings": {
    "maxCompletionLength": 0,
    "systemPrompt": "string",
    "temperature": 0,
    "topP": 0
  },
  "name": "string",
  "promptType": "CHAT_HISTORY_AWARE",
  "vectorDatabaseId": "string",
  "vectorDatabaseSettings": {
    "addNeighborChunks": false,
    "maxDocumentsRetrievedPerPrompt": 1,
    "maxTokens": 128,
    "retriever": "SINGLE_LOOKUP_RETRIEVER"
  }
}

UpdateLLMBlueprintRequest

Properties

Name Type Required Restrictions Description
description any false If specified, updates the LLM blueprint description to this value.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 5000
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
isSaved any false If specified, updates the saved status of the LLM blueprint to this value.

anyOf

Name Type Required Restrictions Description
» anonymous boolean false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
isStarred any false If specified, updates the starred status of the LLM blueprint to this value.

anyOf

Name Type Required Restrictions Description
» anonymous boolean false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
llmId any false If specified, changes the LLM used by the LLM blueprint.

anyOf

Name Type Required Restrictions Description
» anonymous LanguageModelTypeId false The ID that defines the type of the LLM.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
llmSettings any false If specified, updates the LLM settings to these values.

anyOf

Name Type Required Restrictions Description
» anonymous CommonLLMSettings false The settings that are available for all non-custom LLMs.

or

Name Type Required Restrictions Description
» anonymous CustomModelLLMSettings false The settings that are available for custom model LLMs.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
name any false If specified, renames the LLM blueprint to this value.

anyOf

Name Type Required Restrictions Description
» anonymous string false maxLength: 5000
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
promptType any false If specified, updates the chat context behavior of the LLM blueprint to this value.

anyOf

Name Type Required Restrictions Description
» anonymous PromptType false Determines whether chat history is submitted as context to the user prompt.

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
vectorDatabaseId any false If specified, changes the vector database used by the LLM blueprint. If the specified value is null, unlinks the vector database from the LLM blueprint. If omitted, the currently used vector database remains in use.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
vectorDatabaseSettings any false If specified, updates the vector database retrieval settings to these values.

anyOf

Name Type Required Restrictions Description
» anonymous VectorDatabaseSettingsRequest false Specifies the vector database retrieval settings in LLM blueprint API requests.

or

Name Type Required Restrictions Description
» anonymous null false none

ValidationError

{
  "loc": [
    "string"
  ],
  "msg": "string",
  "type": "string"
}

ValidationError

Properties

Name Type Required Restrictions Description
loc [anyOf] true none

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous integer false none

continued

Name Type Required Restrictions Description
msg string true none
type string true none

VectorDatabaseRetrievers

"SINGLE_LOOKUP_RETRIEVER"

VectorDatabaseRetrievers

Properties

Name Type Required Restrictions Description
VectorDatabaseRetrievers string false The method used to retrieve relevant chunks from the vector database.

Enumerated Values

Property Value
VectorDatabaseRetrievers [SINGLE_LOOKUP_RETRIEVER, CONVERSATIONAL_RETRIEVER, MULTI_STEP_RETRIEVER]

VectorDatabaseSettings

{
  "addNeighborChunks": false,
  "maxDocumentsRetrievedPerPrompt": 1,
  "maxTokens": 1,
  "retriever": "SINGLE_LOOKUP_RETRIEVER"
}

VectorDatabaseSettings

Properties

Name Type Required Restrictions Description
addNeighborChunks boolean false Add neighboring chunks to those that the similarity search retrieves, such that when selected, search returns i, i-1, and i+1.
maxDocumentsRetrievedPerPrompt any false The maximum number of chunks to retrieve from the vector database.

anyOf

Name Type Required Restrictions Description
» anonymous integer false maximum: 10
minimum: 1
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
maxTokens any false The maximum number of tokens to retrieve from the vector database.

anyOf

Name Type Required Restrictions Description
» anonymous integer false maximum: 51200
minimum: 1
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
retriever VectorDatabaseRetrievers false The method used to retrieve relevant chunks from the vector database.

VectorDatabaseSettingsRequest

{
  "addNeighborChunks": false,
  "maxDocumentsRetrievedPerPrompt": 1,
  "maxTokens": 128,
  "retriever": "SINGLE_LOOKUP_RETRIEVER"
}

VectorDatabaseSettingsRequest

Properties

Name Type Required Restrictions Description
addNeighborChunks boolean false Add neighboring chunks to those that the similarity search retrieves, such that when selected, search returns i, i-1, and i+1.
maxDocumentsRetrievedPerPrompt any false The maximum number of chunks to retrieve from the vector database.

anyOf

Name Type Required Restrictions Description
» anonymous integer false maximum: 10
minimum: 1
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
maxTokens any false The maximum number of tokens to retrieve from the vector database.

anyOf

Name Type Required Restrictions Description
» anonymous integer false maximum: 51200
minimum: 128
 none

or

Name Type Required Restrictions Description
» anonymous null false none

continued

Name Type Required Restrictions Description
retriever VectorDatabaseRetrievers false The method used to retrieve relevant chunks from the vector database.
Updated March 25, 2025