DataRobot API resources > API reference documentation > DataRobot REST API > Generative AI > Vector databases

Vector Databases (GenAI)¶

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

GET /api/v2/genai/customModelEmbeddingValidations/¶

List custom model embedding validations.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
useCaseId	query	any	false	Only retrieve the custom model embedding validations associated with these use case IDs.
playgroundId	query	any	false	Only retrieve the custom model embedding 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 embedding 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 embedding validations. The default is `false`.
deploymentId	query	any	false	Only retrieve the custom model embedding validations associated with this deployment ID.
modelId	query	any	false	Only retrieve the custom model embedding validations associated with this model ID.
promptColumnName	query	any	false	Only retrieve the custom model embedding validations where the custom model uses this column name for prompt input.
targetColumnName	query	any	false	Only retrieve the custom model embedding validations where the custom model uses this column name for prediction output.

Example responses¶


{
  "count": 0,
  "data": [
    {
      "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 embedding validations successfully retrieved.	ListCustomModelEmbeddingValidationResponse
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/customModelEmbeddingValidations/¶

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

Code samples¶


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

Body parameter¶


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

Parameters

Name	In	Type	Required	Description
body	body	CreateCustomModelEmbeddingValidationRequest	true	none

Example responses¶


{
  "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 embedding validation job successfully accepted. Follow the `Location` header to poll for job execution status.	CustomModelEmbeddingValidationResponse
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/customModelEmbeddingValidations/{validationId}/¶

Delete an existing custom model embedding validation.

Code samples¶


curl -X DELETE https://app.datarobot.com/api/v2/genai/customModelEmbeddingValidations/{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 embedding validation to delete.

Example responses¶


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

Responses¶

Status	Meaning	Description	Schema
204	No Content	Custom model embedding 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/customModelEmbeddingValidations/{validationId}/¶

Retrieve the status of validating a custom model embedding.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/genai/customModelEmbeddingValidations/{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 embedding validation to retrieve.

Example responses¶


{
  "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 embedding validation status successfully retrieved.	CustomModelEmbeddingValidationResponse
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/customModelEmbeddingValidations/{validationId}/¶

Edit an existing custom model embedding validation.

Code samples¶


curl -X PATCH https://app.datarobot.com/api/v2/genai/customModelEmbeddingValidations/{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 embedding validation to edit.
body	body	EditCustomModelValidationRequest	true	none

Example responses¶


{
  "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 embedding validation successfully updated.	CustomModelEmbeddingValidationResponse
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/customModelEmbeddingValidations/{validationId}/revalidate/¶

Revalidate an existing custom model embedding validation.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/genai/customModelEmbeddingValidations/{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 embedding validation to revalidate.

Example responses¶


{
  "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 embedding successfully revalidated.	CustomModelEmbeddingValidationResponse
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/customModelVectorDatabaseValidations/¶

List custom model vector database validations.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
useCaseId	query	any	false	Only retrieve the custom model vector database validations associated with these use case IDs.
playgroundId	query	any	false	Only retrieve the custom model vector database 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 vector database 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 vector database validations. The default is `false`.
deploymentId	query	any	false	Only retrieve the custom model vector database validations associated with this deployment ID.
modelId	query	any	false	Only retrieve the custom model vector database validations associated with this model ID.
promptColumnName	query	any	false	Only retrieve the custom model vector database validations where the custom model uses this column name for prompt input.
targetColumnName	query	any	false	Only retrieve the custom model vector database validations where the custom model uses this column name for prediction output.

Example responses¶


{
  "count": 0,
  "data": [
    {
      "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 vector database validations successfully retrieved.	ListCustomModelVectorDatabaseValidationsResponse
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/customModelVectorDatabaseValidations/¶

Validate a vector database hosted in a custom model deployment for use in the playground.

Code samples¶


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

Body parameter¶


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

Parameters

Name	In	Type	Required	Description
body	body	CreateCustomModelVectorDatabaseValidationRequest	true	none

Example responses¶


{
  "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 vector database validation job successfully accepted. Follow the `Location` header to poll for job execution status.	CustomModelVectorDatabaseValidationResponse
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/customModelVectorDatabaseValidations/{validationId}/¶

Delete an existing custom model vector database validation.

Code samples¶


curl -X DELETE https://app.datarobot.com/api/v2/genai/customModelVectorDatabaseValidations/{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 vector database validation to delete.

Example responses¶


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

Responses¶

Status	Meaning	Description	Schema
204	No Content	Successfully deleted custom model vector database validation	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/customModelVectorDatabaseValidations/{validationId}/¶

Retrieve the status of validating a custom model vector database.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/genai/customModelVectorDatabaseValidations/{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 vector database validation to retrieve.

Example responses¶


{
  "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 vector database validation status successfully retrieved.	CustomModelVectorDatabaseValidationResponse
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/customModelVectorDatabaseValidations/{validationId}/¶

Edit an existing custom model vector database validation.

Code samples¶


curl -X PATCH https://app.datarobot.com/api/v2/genai/customModelVectorDatabaseValidations/{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 vector database validation to edit.
body	body	EditCustomModelValidationRequest	true	none

Example responses¶


{
  "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 vector database validation successfully updated.	CustomModelVectorDatabaseValidationResponse
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/customModelVectorDatabaseValidations/{validationId}/revalidate/¶

Revalidate an existing custom model vector database.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/genai/customModelVectorDatabaseValidations/{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 vector database validation to revalidate.

Example responses¶


{
  "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 vector database successfully revalidated.	CustomModelVectorDatabaseValidationResponse
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/vectorDatabases/¶

List vector databases.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
useCaseId	query	any	false	Only retrieve the vector databases linked to these use case IDs.
playgroundId	query	any	false	Only retrieve the vector databases linked to this playground ID.
familyId	query	any	false	Only retrieve the vector databases linked to this family ID.
parentsOnly	query	boolean	false	If `true`, only retrieve (root) parent vector databases. The default is `false`.
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 vector databases with names matching the search query.
sort	query	any	false	Apply this sort order to the results. Valid options are "name", "creationDate", "creationUserId", "embeddingModel", "datasetId", "chunkingMethod", "chunksCount", "size", "userName", "datasetName", "playgroundsCount", "source". 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 vector databases that have finished building. The default is `false`.

Example responses¶


{
  "count": 0,
  "data": [
    {
      "addedDatasetIds": [
        "string"
      ],
      "addedDatasetNames": [
        "string"
      ],
      "chunkOverlapPercentage": 0,
      "chunkSize": 0,
      "chunkingLengthFunction": "approximate_token_count",
      "chunkingMethod": "recursive",
      "chunksCount": 0,
      "creationDate": "2019-08-24T14:15:22Z",
      "creationUserId": "string",
      "customChunking": true,
      "datasetId": "string",
      "datasetName": "string",
      "deploymentStatus": "Created",
      "embeddingModel": "intfloat/e5-large-v2",
      "embeddingRegisteredModelId": "string",
      "embeddingValidationId": "string",
      "errorMessage": "string",
      "errorResolution": "string",
      "executionStatus": "NEW",
      "familyId": "string",
      "id": "string",
      "isSeparatorRegex": true,
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "metadataColumns": [
        "string"
      ],
      "name": "string",
      "organizationId": "string",
      "parentId": "string",
      "percentage": 0,
      "playgroundsCount": 0,
      "separators": [
        null
      ],
      "size": 0,
      "source": "DataRobot",
      "tenantId": "string",
      "useCaseId": "string",
      "userName": "string",
      "validationId": "string",
      "version": 0
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Vector databases successfully retrieved.	ListVectorDatabasesResponse
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/vectorDatabases/¶

Create a new vector database.

Code samples¶


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

Body parameter¶


{
  "chunkingParameters": {
    "chunkOverlapPercentage": 50,
    "chunkSize": 0,
    "chunkingMethod": "recursive",
    "embeddingModel": "intfloat/e5-large-v2",
    "embeddingRegisteredModelId": "string",
    "embeddingValidationId": "string",
    "isSeparatorRegex": false,
    "separators": [
      "string"
    ]
  },
  "datasetId": "string",
  "name": "string",
  "parentVectorDatabaseId": "string",
  "updateDeployments": false,
  "updateLlmBlueprints": false,
  "useCaseId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateVectorDatabaseRequest	true	none

Example responses¶


{
  "addedDatasetIds": [
    "string"
  ],
  "addedDatasetNames": [
    "string"
  ],
  "chunkOverlapPercentage": 0,
  "chunkSize": 0,
  "chunkingLengthFunction": "approximate_token_count",
  "chunkingMethod": "recursive",
  "chunksCount": 0,
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "customChunking": true,
  "datasetId": "string",
  "datasetName": "string",
  "deploymentStatus": "Created",
  "embeddingModel": "intfloat/e5-large-v2",
  "embeddingRegisteredModelId": "string",
  "embeddingValidationId": "string",
  "errorMessage": "string",
  "errorResolution": "string",
  "executionStatus": "NEW",
  "familyId": "string",
  "id": "string",
  "isSeparatorRegex": true,
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "metadataColumns": [
    "string"
  ],
  "name": "string",
  "organizationId": "string",
  "parentId": "string",
  "percentage": 0,
  "playgroundsCount": 0,
  "separators": [
    null
  ],
  "size": 0,
  "source": "DataRobot",
  "tenantId": "string",
  "useCaseId": "string",
  "userName": "string",
  "validationId": "string",
  "version": 0
}

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Vector database creation job successfully accepted. Follow the `Location` header to poll for job execution status.	VectorDatabaseResponse
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/vectorDatabases/fromCustomModelDeployment/¶

Create a new vector database from a custom model deployment.

Code samples¶


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

Body parameter¶


{
  "name": "string",
  "useCaseId": "string",
  "validationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	any	true	none

Example responses¶


{
  "addedDatasetIds": [
    "string"
  ],
  "addedDatasetNames": [
    "string"
  ],
  "chunkOverlapPercentage": 0,
  "chunkSize": 0,
  "chunkingLengthFunction": "approximate_token_count",
  "chunkingMethod": "recursive",
  "chunksCount": 0,
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "customChunking": true,
  "datasetId": "string",
  "datasetName": "string",
  "deploymentStatus": "Created",
  "embeddingModel": "intfloat/e5-large-v2",
  "embeddingRegisteredModelId": "string",
  "embeddingValidationId": "string",
  "errorMessage": "string",
  "errorResolution": "string",
  "executionStatus": "NEW",
  "familyId": "string",
  "id": "string",
  "isSeparatorRegex": true,
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "metadataColumns": [
    "string"
  ],
  "name": "string",
  "organizationId": "string",
  "parentId": "string",
  "percentage": 0,
  "playgroundsCount": 0,
  "separators": [
    null
  ],
  "size": 0,
  "source": "DataRobot",
  "tenantId": "string",
  "useCaseId": "string",
  "userName": "string",
  "validationId": "string",
  "version": 0
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Custom model hosted vector database successfully added. Full representation is available in the response body.	VectorDatabaseResponse
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/vectorDatabases/supportedEmbeddings/¶

List the supported embedding models for building vector databases.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
datasetId	query	any	false	Only retrieve the embedding models compatible with this dataset ID.
useCaseId	query	any	false	If specified, include the custom model embeddings available for this use case ID.

Example responses¶


{
  "customModelEmbeddingValidations": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "defaultEmbeddingModel": "string",
  "embeddingModels": [
    {
      "description": "string",
      "embeddingModel": "intfloat/e5-large-v2",
      "languages": [
        "Afrikaans"
      ],
      "maxSequenceLength": 0
    }
  ],
  "nimEmbeddingModels": [
    {
      "description": "string",
      "id": "string",
      "name": "string"
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Supported embeddings successfully retrieved.	SupportedEmbeddingsResponse
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/vectorDatabases/supportedRetrievalSettings/¶

List all vector database retrieval settings that are supported by LLM blueprints.

Code samples¶


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

Example responses¶


{
  "settings": [
    {
      "default": null,
      "description": "string",
      "enum": [
        "string"
      ],
      "groupId": "string",
      "maximum": 0,
      "minimum": 0,
      "name": "string",
      "settings": [
        {}
      ],
      "title": "string",
      "type": "string"
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Supported vector database retrieval settings successfully retrieved.	SupportedRetrievalSettingsResponse
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/vectorDatabases/supportedTextChunkings/¶

List the supported text chunking methods for building vector databases.

Code samples¶


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

Example responses¶


{
  "textChunkingConfigs": [
    {
      "defaultMethod": "string",
      "embeddingModel": "intfloat/e5-large-v2",
      "methods": [
        {
          "chunkingMethod": "recursive",
          "chunkingParameters": [
            {
              "default": 0,
              "description": "string",
              "max": 0,
              "min": 0,
              "name": "string",
              "type": "int"
            }
          ],
          "description": "string",
          "title": "Recursive"
        }
      ]
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Supported text chunking methods successfully retrieved.	SupportedTextChunkingResponse

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

BearerAuth

DELETE /api/v2/genai/vectorDatabases/{vectorDatabaseId}/¶

Delete an existing vector database.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
vectorDatabaseId	path	string	true	The ID of the vector database to delete.

Example responses¶


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

Responses¶

Status	Meaning	Description	Schema
204	No Content	Vector database 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/vectorDatabases/{vectorDatabaseId}/¶

Retrieve an existing vector database.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
vectorDatabaseId	path	string	true	The ID of the vector database to retrieve.

Example responses¶


{
  "addedDatasetIds": [
    "string"
  ],
  "addedDatasetNames": [
    "string"
  ],
  "chunkOverlapPercentage": 0,
  "chunkSize": 0,
  "chunkingLengthFunction": "approximate_token_count",
  "chunkingMethod": "recursive",
  "chunksCount": 0,
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "customChunking": true,
  "datasetId": "string",
  "datasetName": "string",
  "deploymentStatus": "Created",
  "embeddingModel": "intfloat/e5-large-v2",
  "embeddingRegisteredModelId": "string",
  "embeddingValidationId": "string",
  "errorMessage": "string",
  "errorResolution": "string",
  "executionStatus": "NEW",
  "familyId": "string",
  "id": "string",
  "isSeparatorRegex": true,
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "metadataColumns": [
    "string"
  ],
  "name": "string",
  "organizationId": "string",
  "parentId": "string",
  "percentage": 0,
  "playgroundsCount": 0,
  "separators": [
    null
  ],
  "size": 0,
  "source": "DataRobot",
  "tenantId": "string",
  "useCaseId": "string",
  "userName": "string",
  "validationId": "string",
  "version": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Vector database successfully retrieved.	VectorDatabaseResponse
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/vectorDatabases/{vectorDatabaseId}/¶

Edit an existing vector database.

Code samples¶


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

Body parameter¶


{
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
vectorDatabaseId	path	string	true	The ID of the vector database to edit.
body	body	EditVectorDatabaseRequest	true	none

Example responses¶


{
  "addedDatasetIds": [
    "string"
  ],
  "addedDatasetNames": [
    "string"
  ],
  "chunkOverlapPercentage": 0,
  "chunkSize": 0,
  "chunkingLengthFunction": "approximate_token_count",
  "chunkingMethod": "recursive",
  "chunksCount": 0,
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "customChunking": true,
  "datasetId": "string",
  "datasetName": "string",
  "deploymentStatus": "Created",
  "embeddingModel": "intfloat/e5-large-v2",
  "embeddingRegisteredModelId": "string",
  "embeddingValidationId": "string",
  "errorMessage": "string",
  "errorResolution": "string",
  "executionStatus": "NEW",
  "familyId": "string",
  "id": "string",
  "isSeparatorRegex": true,
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "metadataColumns": [
    "string"
  ],
  "name": "string",
  "organizationId": "string",
  "parentId": "string",
  "percentage": 0,
  "playgroundsCount": 0,
  "separators": [
    null
  ],
  "size": 0,
  "source": "DataRobot",
  "tenantId": "string",
  "useCaseId": "string",
  "userName": "string",
  "validationId": "string",
  "version": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Vector database successfully updated.	VectorDatabaseResponse
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/vectorDatabases/{vectorDatabaseId}/customModelVersions/¶

Export the specified Vector Database as a custom model version in Model Registry.

Code samples¶


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

Body parameter¶


{
  "promptColumnName": "promptText",
  "targetColumnName": "relevant"
}

Parameters

Name	In	Type	Required	Description
vectorDatabaseId	path	string	true	The ID of the vector database to create a custom model version for.
body	body	CreateVectorDatabaseCustomModelVersionRequest	true	none

Example responses¶


{
  "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

POST /api/v2/genai/vectorDatabases/{vectorDatabaseId}/datasetExportJobs/¶

Export an existing vector database as dataset to Data Registry.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
vectorDatabaseId	path	string	true	The ID of the vector database to retrieve.

Example responses¶


{
  "exportDatasetId": "string",
  "jobId": "string",
  "vectorDatabaseId": "string"
}

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Vector database export job successfully accepted.Follow the `Location` header to poll for job execution status.	VectorDatabaseExportResponse
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/vectorDatabases/{vectorDatabaseId}/latestVersion/¶

Retrieve the latest vector database within the family associated with this vector database.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
vectorDatabaseId	path	string	true	The ID of the vector database to retrieve the latest version.
completedOnly	query	boolean	false	If `true`, only retrieve the vector databases that have finished building. The default is `false`.

Example responses¶


{
  "addedDatasetIds": [
    "string"
  ],
  "addedDatasetNames": [
    "string"
  ],
  "chunkOverlapPercentage": 0,
  "chunkSize": 0,
  "chunkingLengthFunction": "approximate_token_count",
  "chunkingMethod": "recursive",
  "chunksCount": 0,
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "customChunking": true,
  "datasetId": "string",
  "datasetName": "string",
  "deploymentStatus": "Created",
  "embeddingModel": "intfloat/e5-large-v2",
  "embeddingRegisteredModelId": "string",
  "embeddingValidationId": "string",
  "errorMessage": "string",
  "errorResolution": "string",
  "executionStatus": "NEW",
  "familyId": "string",
  "id": "string",
  "isSeparatorRegex": true,
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "metadataColumns": [
    "string"
  ],
  "name": "string",
  "organizationId": "string",
  "parentId": "string",
  "percentage": 0,
  "playgroundsCount": 0,
  "separators": [
    null
  ],
  "size": 0,
  "source": "DataRobot",
  "tenantId": "string",
  "useCaseId": "string",
  "userName": "string",
  "validationId": "string",
  "version": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Latest vector database version successfully retrieved.	VectorDatabaseResponse
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/vectorDatabases/{vectorDatabaseId}/supportedSyntheticDatasetGenerationLanguages/¶

List the languages for synthetic dataset generation that are supported by this vector database.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
vectorDatabaseId	path	string	true	The ID of the vector database to retrieve supported languages.

Example responses¶


{
  "recommendedLanguage": "string",
  "supportedLanguages": [
    "string"
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Supported languages successfully retrieved.	SupportedLanguagesResponse
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/vectorDatabases/{vectorDatabaseId}/textAndEmbeddings/¶

Retrieve the text chunk and embeddings asset for an existing vector database.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
vectorDatabaseId	path	string	true	The ID of the vector database to retrieve the assets for.

Example responses¶


null

Responses¶

Status	Meaning	Description	Schema
200	OK	Text and embeddings asset successfully retrieved.	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationErrorResponse

Response Schema¶

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

BearerAuth

Schemas¶

ChunkingLengthFunctionNames


"tokenizer_length_function"

ChunkingLengthFunctionNames

Properties¶

Name	Type	Required	Restrictions	Description
ChunkingLengthFunctionNames	string	false		Supported length functions for text splitters.

Enumerated Values¶

Property	Value
ChunkingLengthFunctionNames	[`tokenizer_length_function`, `approximate_token_count`]

ChunkingMethodNames


"recursive"

ChunkingMethodNames

Properties¶

Name	Type	Required	Restrictions	Description
ChunkingMethodNames	string	false		Supported names of text chunking methods.

Enumerated Values¶

Property	Value
ChunkingMethodNames	[`recursive`, `semantic`]

ChunkingMethodNamesTitle


"Recursive"

ChunkingMethodNamesTitle

Properties¶

Name	Type	Required	Restrictions	Description
ChunkingMethodNamesTitle	string	false		Supported user-facing friendly ames of text chunking methods.

Enumerated Values¶

Property	Value
ChunkingMethodNamesTitle	[`Recursive`, `Semantic`]

ChunkingParameterTypes


"int"

ChunkingParameterTypes

Properties¶

Name	Type	Required	Restrictions	Description
ChunkingParameterTypes	string	false		Supported parameter data types for text chunking parameters.

Enumerated Values¶

Property	Value
ChunkingParameterTypes	[`int`, `list[str]`, `bool`]

ChunkingParameters


{
  "chunkOverlapPercentage": 50,
  "chunkSize": 0,
  "chunkingMethod": "recursive",
  "embeddingModel": "intfloat/e5-large-v2",
  "embeddingRegisteredModelId": "string",
  "embeddingValidationId": "string",
  "isSeparatorRegex": false,
  "separators": [
    "string"
  ]
}

ChunkingParameters

Properties¶

Name	Type	Required	Restrictions	Description
chunkOverlapPercentage	any	false		The chunk overlap percentage to use for text chunking.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	maximum: 50 minimum: 0	none

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

continued

Name	Type	Required	Restrictions	Description
chunkSize	any	false		The chunk size to use for text chunking (measured in tokens).

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
chunkingMethod	any	false		The text chunking method to use.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	ChunkingMethodNames	false		Supported names of text chunking methods.

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

continued

Name	Type	Required	Restrictions	Description
embeddingModel	any	false		The name of the embedding model to use. If omitted, DataRobot will choose the default embedding model automatically.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	EmbeddingModelNames	false		Embedding model names (matching the format of HuggingFace repositories).

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

continued

Name	Type	Required	Restrictions	Description
embeddingRegisteredModelId	any	false		The ID of registered model (in case of using NIM registered model for embeddings).

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
embeddingValidationId	any	false		The validation ID of the custom embedding model (in case of using a custom model for embeddings).

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
isSeparatorRegex	boolean	false		Whether the text chunking separator uses a regular expression.
separators	any	false		The list of separators to use for text chunking.

anyOf

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

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

CreateCustomModelEmbeddingValidationRequest


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

CreateCustomModelEmbeddingValidationRequest

Properties¶

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	string	true	maxLength: 5000	The name of the column the custom model uses for prompt text input.
targetColumnName	string	true	maxLength: 5000	The name of the column the custom model uses for prediction output.
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

CreateCustomModelVectorDatabaseFromDeploymentRequest


{
  "deploymentId": "string",
  "modelId": "string",
  "name": "string",
  "promptColumnName": "string",
  "targetColumnName": "string",
  "useCaseId": "string"
}

CreateCustomModelVectorDatabaseFromDeploymentRequest

Properties¶

Name	Type	Required	Restrictions	Description
deploymentId	string	true		The ID of the custom model deployment.
modelId	string	true		The ID of the model in the custom model deployment.
name	string	true	maxLength: 5000 minLength: 1 minLength: 1	The name of the vector database.
promptColumnName	string	true	maxLength: 5000	The name of the column the custom model uses for prompt text input.
targetColumnName	string	true	maxLength: 5000	The name of the column the custom model uses for prediction output.
useCaseId	string	true		The ID of the use case to link the vector database to.

CreateCustomModelVectorDatabaseFromValidationIdPayload


{
  "name": "string",
  "useCaseId": "string",
  "validationId": "string"
}

CreateCustomModelVectorDatabaseFromValidationIdPayload

Properties¶

Name	Type	Required	Restrictions	Description
name	string	true	maxLength: 5000 minLength: 1 minLength: 1	The name of the vector database.
useCaseId	string	true		The ID of the use case to link the vector database to.
validationId	string	true		The validation ID of the custom model validation.

CreateCustomModelVectorDatabaseValidationRequest


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

CreateCustomModelVectorDatabaseValidationRequest

Properties¶

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	string	true	maxLength: 5000	The name of the column the custom model uses for prompt text input.
targetColumnName	string	true	maxLength: 5000	The name of the column the custom model uses for prediction output.
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

CreateCustomModelVersionResponse


{
  "customModelId": "string"
}

CreateCustomModelVersionResponse

Properties¶

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

CreateVectorDatabaseCustomModelVersionRequest


{
  "promptColumnName": "promptText",
  "targetColumnName": "relevant"
}

CreateVectorDatabaseCustomModelVersionRequest

Properties¶

Name	Type	Required	Restrictions	Description
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.

CreateVectorDatabaseRequest


{
  "chunkingParameters": {
    "chunkOverlapPercentage": 50,
    "chunkSize": 0,
    "chunkingMethod": "recursive",
    "embeddingModel": "intfloat/e5-large-v2",
    "embeddingRegisteredModelId": "string",
    "embeddingValidationId": "string",
    "isSeparatorRegex": false,
    "separators": [
      "string"
    ]
  },
  "datasetId": "string",
  "name": "string",
  "parentVectorDatabaseId": "string",
  "updateDeployments": false,
  "updateLlmBlueprints": false,
  "useCaseId": "string"
}

CreateVectorDatabaseRequest

Properties¶

Name	Type	Required	Restrictions	Description
chunkingParameters	any	false		The text chunking parameters to use for building the vector database.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	ChunkingParameters	false		Chunking parameters for creating a vector database.

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

continued

Name	Type	Required	Restrictions	Description
datasetId	string	true		The ID of the dataset to use for building the vector database.
name	any	false		The name of the vector database.

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
parentVectorDatabaseId	any	false		The ID of the parent vector database used as base for the re-building.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

continued

Name	Type	Required	Description
updateDeployments	boolean	false	Whether to update the deployments that use the parent vector database.Can only be set to `true` if parent_vector_database_id is provided.
updateLlmBlueprints	boolean	false	Whether to update the LLM blueprints that use the parent vector database.Can only be set to `true` if parent_vector_database_id is provided.
useCaseId	string	true	The ID of the use case to link the vector database to.

CustomEmbeddingModelNames


"custom-embeddings/default"

CustomEmbeddingModelNames

Properties¶

Name	Type	Required	Restrictions	Description
CustomEmbeddingModelNames	string	false		Model names for custom embedding models.

Enumerated Values¶

Property	Value
CustomEmbeddingModelNames	`custom-embeddings/default`

CustomModelEmbeddingValidationResponse


{
  "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"
}

CustomModelEmbeddingValidationResponse

Properties¶

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	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`]

CustomModelVectorDatabaseValidationResponse


{
  "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"
}

CustomModelVectorDatabaseValidationResponse

Properties¶

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	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.

DatasetLanguages


"Afrikaans"

DatasetLanguages

Properties¶

Name	Type	Required	Restrictions	Description
DatasetLanguages	string	false		The names of dataset languages.

Enumerated Values¶

Property Value

DatasetLanguages [Afrikaans, Amharic, Arabic, Assamese, Azerbaijani, Belarusian, Bulgarian, Bengali, Breton, Bosnian, Catalan, Czech, Welsh, Danish, German, Greek, English, Esperanto, Spanish, Estonian, Basque, Persian, Finnish, French, Western Frisian, Irish, Scottish Gaelic, Galician, Gujarati, Hausa, Hebrew, Hindi, Croatian, Hungarian, Armenian, Indonesian, Icelandic, Italian, Japanese, Javanese, Georgian, Kazakh, Khmer, Kannada, Korean, Kurdish, Kyrgyz, Latin, Lao, Lithuanian, Latvian, Malagasy, Macedonian, Malayalam, Mongolian, Marathi, Malay, Burmese, Nepali, Dutch, Norwegian, Oromo, Oriya, Panjabi, Polish, Pashto, Portuguese, Romanian, Russian, Sanskrit, Sindhi, Sinhala, Slovak, Slovenian, Somali, Albanian, Serbian, Sundanese, Swedish, Swahili, Tamil, Telugu, Thai, Tagalog, Turkish, Uyghur, Ukrainian, Urdu, Uzbek, Vietnamese, Xhosa, Yiddish, Chinese]

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	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

EditVectorDatabaseRequest


{
  "name": "string"
}

EditVectorDatabaseRequest

Properties¶

Name	Type	Required	Restrictions	Description
name	string	true	maxLength: 5000 minLength: 1 minLength: 1	The new name of the vector database.

EmbeddingModel


{
  "description": "string",
  "embeddingModel": "intfloat/e5-large-v2",
  "languages": [
    "Afrikaans"
  ],
  "maxSequenceLength": 0
}

EmbeddingModel

Properties¶

Name	Type	Required	Description
description	string	true	The description of the embedding model.
embeddingModel	EmbeddingModelNames	true	The name of the embedding model.
languages	[DatasetLanguages]	true	The list of languages the embedding models supports.
maxSequenceLength	integer	true	The maximum input token sequence length that the embedding model can accept.

EmbeddingModelNames


"intfloat/e5-large-v2"

EmbeddingModelNames

Properties¶

Name	Type	Required	Restrictions	Description
EmbeddingModelNames	string	false		Embedding model names (matching the format of HuggingFace repositories).

Enumerated Values¶

Property	Value
EmbeddingModelNames	[`intfloat/e5-large-v2`, `intfloat/e5-base-v2`, `intfloat/multilingual-e5-base`, `intfloat/multilingual-e5-small`, `sentence-transformers/all-MiniLM-L6-v2`, `jinaai/jina-embedding-t-en-v1`, `jinaai/jina-embedding-s-en-v2`, `cl-nagoya/sup-simcse-ja-base`]

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`]

HTTPValidationErrorResponse


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

HTTPValidationErrorResponse

Properties¶

Name	Type	Required	Restrictions	Description
detail	[ValidationError]	false		none

ListCustomModelEmbeddingValidationResponse


{
  "count": 0,
  "data": [
    {
      "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
}

ListCustomModelEmbeddingValidationResponse

Properties¶

Name	Type	Required	Description
count	integer	true	The number of records on this page.
data	[CustomModelEmbeddingValidationResponse]	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`]

ListCustomModelVectorDatabaseValidationsResponse


{
  "count": 0,
  "data": [
    {
      "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
}

ListCustomModelVectorDatabaseValidationsResponse

Properties¶

Name	Type	Required	Description
count	integer	true	The number of records on this page.
data	[CustomModelVectorDatabaseValidationResponse]	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.

ListVectorDatabaseSortQueryParam


"name"

ListVectorDatabaseSortQueryParam

Properties¶

Name	Type	Required	Restrictions	Description
ListVectorDatabaseSortQueryParam	string	false		Sort order values for listing vector databases.

Enumerated Values¶

Property	Value
ListVectorDatabaseSortQueryParam	[`name`, `-name`, `creationUserId`, `-creationUserId`, `creationDate`, `-creationDate`, `embeddingModel`, `-embeddingModel`, `datasetId`, `-datasetId`, `chunkingMethod`, `-chunkingMethod`, `chunksCount`, `-chunksCount`, `size`, `-size`, `userName`, `-userName`, `datasetName`, `-datasetName`, `playgroundsCount`, `-playgroundsCount`, `source`, `-source`]

ListVectorDatabasesResponse


{
  "count": 0,
  "data": [
    {
      "addedDatasetIds": [
        "string"
      ],
      "addedDatasetNames": [
        "string"
      ],
      "chunkOverlapPercentage": 0,
      "chunkSize": 0,
      "chunkingLengthFunction": "approximate_token_count",
      "chunkingMethod": "recursive",
      "chunksCount": 0,
      "creationDate": "2019-08-24T14:15:22Z",
      "creationUserId": "string",
      "customChunking": true,
      "datasetId": "string",
      "datasetName": "string",
      "deploymentStatus": "Created",
      "embeddingModel": "intfloat/e5-large-v2",
      "embeddingRegisteredModelId": "string",
      "embeddingValidationId": "string",
      "errorMessage": "string",
      "errorResolution": "string",
      "executionStatus": "NEW",
      "familyId": "string",
      "id": "string",
      "isSeparatorRegex": true,
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "metadataColumns": [
        "string"
      ],
      "name": "string",
      "organizationId": "string",
      "parentId": "string",
      "percentage": 0,
      "playgroundsCount": 0,
      "separators": [
        null
      ],
      "size": 0,
      "source": "DataRobot",
      "tenantId": "string",
      "useCaseId": "string",
      "userName": "string",
      "validationId": "string",
      "version": 0
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

ListVectorDatabasesResponse

Properties¶

Name	Type	Required	Description
count	integer	true	The number of records on this page.
data	[VectorDatabaseResponse]	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.

SupportedCustomModelEmbeddings


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

SupportedCustomModelEmbeddings

Properties¶

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

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`]

SupportedEmbeddingsResponse


{
  "customModelEmbeddingValidations": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "defaultEmbeddingModel": "string",
  "embeddingModels": [
    {
      "description": "string",
      "embeddingModel": "intfloat/e5-large-v2",
      "languages": [
        "Afrikaans"
      ],
      "maxSequenceLength": 0
    }
  ],
  "nimEmbeddingModels": [
    {
      "description": "string",
      "id": "string",
      "name": "string"
    }
  ]
}

SupportedEmbeddingsResponse

Properties¶

Name	Type	Required	Description
customModelEmbeddingValidations	[SupportedCustomModelEmbeddings]	false	The list of validated custom embedding models.
defaultEmbeddingModel	string	true	The name of the default embedding model.
embeddingModels	[EmbeddingModel]	true	The list of embeddings models.
nimEmbeddingModels	[SupportedNIMModelEmbeddings]	false	The list of NIM registered models.

SupportedLanguagesResponse


{
  "recommendedLanguage": "string",
  "supportedLanguages": [
    "string"
  ]
}

SupportedLanguagesResponse

Properties¶

Name	Type	Required	Restrictions	Description
recommendedLanguage	string	true		The recommended language.
supportedLanguages	[string]	true		The list of supported languages.

SupportedNIMModelEmbeddings


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

SupportedNIMModelEmbeddings

Properties¶

Name	Type	Required	Description
description	string	true	The description of the registered NIM model.
id	string	true	The validation ID of the registered NIM model.
name	string	true	The name of the registered NIM model.

SupportedRetrievalSettingsResponse


{
  "settings": [
    {
      "default": null,
      "description": "string",
      "enum": [
        "string"
      ],
      "groupId": "string",
      "maximum": 0,
      "minimum": 0,
      "name": "string",
      "settings": [
        {}
      ],
      "title": "string",
      "type": "string"
    }
  ]
}

SupportedRetrievalSettingsResponse

Properties¶

Name	Type	Required	Restrictions	Description
settings	[VectorDatabaseSettingParameter]	true		The list of retrieval settings.

SupportedTextChunkingResponse


{
  "textChunkingConfigs": [
    {
      "defaultMethod": "string",
      "embeddingModel": "intfloat/e5-large-v2",
      "methods": [
        {
          "chunkingMethod": "recursive",
          "chunkingParameters": [
            {
              "default": 0,
              "description": "string",
              "max": 0,
              "min": 0,
              "name": "string",
              "type": "int"
            }
          ],
          "description": "string",
          "title": "Recursive"
        }
      ]
    }
  ]
}

SupportedTextChunkingResponse

Properties¶

Name	Type	Required	Restrictions	Description
textChunkingConfigs	[TextChunkingConfig]	true		The list of text chunking configurations.

TextChunkingConfig


{
  "defaultMethod": "string",
  "embeddingModel": "intfloat/e5-large-v2",
  "methods": [
    {
      "chunkingMethod": "recursive",
      "chunkingParameters": [
        {
          "default": 0,
          "description": "string",
          "max": 0,
          "min": 0,
          "name": "string",
          "type": "int"
        }
      ],
      "description": "string",
      "title": "Recursive"
    }
  ]
}

TextChunkingConfig

Properties¶

Name	Type	Required	Restrictions	Description
defaultMethod	string	true		The name of the default text chunking method.
embeddingModel	any	true		The name of the embedding model.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	EmbeddingModelNames	false		Embedding model names (matching the format of HuggingFace repositories).

or

Name	Type	Required	Restrictions	Description
» anonymous	CustomEmbeddingModelNames	false		Model names for custom embedding models.

continued

Name	Type	Required	Restrictions	Description
methods	[TextChunkingMethod]	true		The list of text chunking methods.

TextChunkingMethod


{
  "chunkingMethod": "recursive",
  "chunkingParameters": [
    {
      "default": 0,
      "description": "string",
      "max": 0,
      "min": 0,
      "name": "string",
      "type": "int"
    }
  ],
  "description": "string",
  "title": "Recursive"
}

TextChunkingMethod

Properties¶

Name	Type	Required	Description
chunkingMethod	ChunkingMethodNames	true	The name of the text chunking method.
chunkingParameters	[TextChunkingParameterFields]	true	The list of text chunking parameters.
description	string	true	The description of the text chunking method.
title	ChunkingMethodNamesTitle	true	User-friendly label for the text chunking method.

TextChunkingParameterFields


{
  "default": 0,
  "description": "string",
  "max": 0,
  "min": 0,
  "name": "string",
  "type": "int"
}

TextChunkingParameterFields

Properties¶

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

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false		none

or

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

or

Name	Type	Required	Restrictions	Description
» anonymous	boolean	false		none

continued

Name	Type	Required	Restrictions	Description
description	string	true		The description of the parameter.
max	any	true		The maximum value of the parameter (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
min	any	true		The minimum value of the parameter (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
name	string	true		The name of the parameter.
type	ChunkingParameterTypes	true		The data type of the parameter.

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

VectorDatabaseDeploymentStatuses


"Created"

VectorDatabaseDeploymentStatuses

Properties¶

Name	Type	Required	Restrictions	Description
VectorDatabaseDeploymentStatuses	string	false		Sort order values for listing vector databases.

Enumerated Values¶

Property	Value
VectorDatabaseDeploymentStatuses	[`Created`, `Assembling`, `Registered`, `Deployed`]

VectorDatabaseExportResponse


{
  "exportDatasetId": "string",
  "jobId": "string",
  "vectorDatabaseId": "string"
}

VectorDatabaseExportResponse

Properties¶

Name	Type	Required	Description
exportDatasetId	string	true	The Data Registry dataset ID.
jobId	string(uuid4)	true	The ID of the export job.
vectorDatabaseId	string	true	The ID of the vector database.

VectorDatabaseResponse


{
  "addedDatasetIds": [
    "string"
  ],
  "addedDatasetNames": [
    "string"
  ],
  "chunkOverlapPercentage": 0,
  "chunkSize": 0,
  "chunkingLengthFunction": "approximate_token_count",
  "chunkingMethod": "recursive",
  "chunksCount": 0,
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "customChunking": true,
  "datasetId": "string",
  "datasetName": "string",
  "deploymentStatus": "Created",
  "embeddingModel": "intfloat/e5-large-v2",
  "embeddingRegisteredModelId": "string",
  "embeddingValidationId": "string",
  "errorMessage": "string",
  "errorResolution": "string",
  "executionStatus": "NEW",
  "familyId": "string",
  "id": "string",
  "isSeparatorRegex": true,
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "metadataColumns": [
    "string"
  ],
  "name": "string",
  "organizationId": "string",
  "parentId": "string",
  "percentage": 0,
  "playgroundsCount": 0,
  "separators": [
    null
  ],
  "size": 0,
  "source": "DataRobot",
  "tenantId": "string",
  "useCaseId": "string",
  "userName": "string",
  "validationId": "string",
  "version": 0
}

VectorDatabaseResponse

Properties¶

Name	Type	Required	Restrictions	Description
addedDatasetIds	any	true		The list of dataset IDs that were added to the vector database in addition to the initial creation dataset.

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
addedDatasetNames	any	true		The list of dataset names that were added to the vector database in addition to the initial creation dataset.

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
chunkOverlapPercentage	any	true		The chunk overlap percentage that the vector database uses.

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
chunkSize	any	true		The size of the text chunk (measured in tokens) that the vector database uses.

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
chunkingLengthFunction	any	false		The length function to use for the text splitter.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	ChunkingLengthFunctionNames	false		Supported length functions for text splitters.

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

continued

Name	Type	Required	Restrictions	Description
chunkingMethod	any	true		The text chunking method the vector database uses.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	ChunkingMethodNames	false		Supported names of text chunking methods.

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

continued

Name	Type	Required	Description
chunksCount	integer	true	The number of text chunks in the vector database.
creationDate	string(date-time)	true	The creation date of the vector database (ISO 8601 formatted).
creationUserId	string	true	The ID of the user that created this vector database.
customChunking	boolean	true	Whether the vector database uses custom chunking.
datasetId	any	true	The ID of the dataset the vector database was built from.

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
datasetName	string	true		The name of the dataset this vector database was built from.
deploymentStatus	any	false		How far along in the deployment process this vector database is.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	VectorDatabaseDeploymentStatuses	false		Sort order values for listing vector databases.

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

continued

Name	Type	Required	Restrictions	Description
embeddingModel	any	true		The name of the embedding model the vector database uses.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	EmbeddingModelNames	false		Embedding model names (matching the format of HuggingFace repositories).

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
embeddingRegisteredModelId	any	true		The ID of registered model (in case of using NIM registered model for embeddings).

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
embeddingValidationId	any	true		The validation ID of the custom model embedding (in case of using a custom model for embeddings).

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	true		The error message associated with the vector database creation error (in case of a creation error).

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	true		The suggested error resolution for the vector database creation error (in case of a creation error).

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 creation status of the vector database.
familyId	any	true		An ID associated with a family of vector databases, that is, a parent and all descendant vector databases. All vector databases that are descendants of the same root parent share a family ID.The family ID is equal to the vector database ID of the root parent.Like this each vector database knows it's direct parent and the root parent.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

continued

Name	Type	Required	Description
id	string	true	The ID of the vector database.
isSeparatorRegex	boolean	true	Whether the text chunking separator uses a regular expression.
lastUpdateDate	string(date-time)	true	The date of the most recent update of this playground (ISO 8601 formatted).
metadataColumns	any	false	The list of metadata columns in the vector database.

anyOf

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

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

continued

Name	Type	Required	Description
name	string	true	The name of the vector database.
organizationId	string	true	The ID of the DataRobot organization this vector database belongs to.
parentId	any	true	The ID of the direct parent vector database.It is generated when a vector database is created from another vector database.For the root (parent), ID is 'None'.

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
percentage	any	false		Vector database progress percentage.

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
playgroundsCount	integer	true		The number of playgrounds that use this vector database.
separators	any	true		The text chunking separators that the vector database uses.

anyOf

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

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

continued

Name	Type	Required	Description
size	integer	true	The size of the vector database (in bytes).
source	VectorDatabaseSource	true	The source of the vector database.
tenantId	string(uuid4)	true	The ID of the DataRobot tenant this vector database belongs to.
useCaseId	string	true	The ID of the use case the vector database is linked to.
userName	string	true	The name of the user that created this vector database.
validationId	any	true	The validation ID of the custom model vector database (in case of using a custom model vector database).

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
version	integer	true		The version of the vector database linked to a certain family ID.

VectorDatabaseSettingParameter


{
  "default": null,
  "description": "string",
  "enum": [
    "string"
  ],
  "groupId": "string",
  "maximum": 0,
  "minimum": 0,
  "name": "string",
  "settings": [
    {
      "default": null,
      "description": "string",
      "enum": [
        "string"
      ],
      "groupId": "string",
      "maximum": 0,
      "minimum": 0,
      "name": "string",
      "settings": [
        {}
      ],
      "title": "string",
      "type": "string"
    }
  ],
  "title": "string",
  "type": "string"
}

VectorDatabaseSettingParameter

Properties¶

Name	Type	Required	Description
default	any	false	The default value of the parameter.
description	string	true	The description of the parameter.
enum	any	false	The list of possible values for the parameter.

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
groupId	any	false		The identifier of the group the parameter belongs to.

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
maximum	any	false		The maximum value of the parameter.

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
minimum	any	false		The minimum value of the parameter.

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
name	string	true		The name of the parameter.
settings	any	false		The list of available settings for the parameter.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	[VectorDatabaseSettingParameter]	false		[API response object for a single vector database setting parameter.]

or

Name	Type	Required	Restrictions	Description
» anonymous	null	false		none

continued

Name	Type	Required	Restrictions	Description
title	string	true		The title of the parameter.
type	any	true		The type of the parameter.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	VectorDatabaseSettingTypes	false		The types of vector database setting parameters.

or

Name	Type	Required	Restrictions	Description
» anonymous	[VectorDatabaseSettingTypes]	false		[The types of vector database setting parameters.]

VectorDatabaseSettingTypes


"string"

VectorDatabaseSettingTypes

Properties¶

Name	Type	Required	Restrictions	Description
VectorDatabaseSettingTypes	string	false		The types of vector database setting parameters.

Enumerated Values¶

Property	Value
VectorDatabaseSettingTypes	[`string`, `integer`, `boolean`, `null`, `number`, `array`]

VectorDatabaseSource


"DataRobot"

VectorDatabaseSource

Properties¶

Name	Type	Required	Restrictions	Description
VectorDatabaseSource	string	false		The source of the vector database.

Enumerated Values¶

Property	Value
VectorDatabaseSource	[`DataRobot`, `External`]

Was this page helpful?

Great! Let us know what you found helpful.

What can we do to improve the content?

Thanks for your feedback!