LLMs (GenAI)
This page outlines the operations, endpoints, parameters, and example requests and responses for the LLMs (GenAI).
GET /api/v2/genai/llms/
List the large language models (LLMs) available in the DataRobot platform for the current user.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/genai/llms/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name |
In |
Type |
Required |
Description |
offset |
query |
integer |
false |
Skip the specified number of values. |
limit |
query |
integer |
false |
Retrieve only the specified number of values. |
useCaseId |
query |
string |
false |
If specified, include custom model LLMs available for this use case. |
Example responses
200 Response
{
"count": 0,
"data": [
{
"contextSize": 0,
"description": "string",
"id": "azure-openai-gpt-3.5-turbo",
"isDeprecated": false,
"isMetered": true,
"license": "string",
"name": "string",
"provider": "string",
"settings": [
{
"constraints": {
"maxValue": 0,
"minValue": 0,
"type": "integer"
},
"defaultValue": true,
"description": "string",
"format": "multiline",
"id": "string",
"isNullable": true,
"name": "string",
"type": "integer"
}
],
"supportedCustomModelLLMValidations": [
{
"id": "string",
"name": "string"
}
],
"supportedLanguages": "string",
"vendor": "string"
}
],
"next": "string",
"previous": "string",
"totalCount": 0
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas
BooleanSettingConstraints
BooleanSettingConstraints
Properties
Name |
Type |
Required |
Restrictions |
Description |
type |
string |
false |
|
The data type of the setting. |
Enumerated Values
Property |
Value |
type |
boolean |
FloatSettingConstraints
{
"maxValue": 0,
"minValue": 0,
"type": "float"
}
FloatSettingConstraints
Properties
Name |
Type |
Required |
Restrictions |
Description |
maxValue |
number¦null |
false |
|
The maximum value of the setting (inclusive). |
minValue |
number¦null |
false |
|
The minimum value of the setting (inclusive). |
type |
string |
false |
|
The data type of the setting. |
Enumerated Values
Property |
Value |
type |
float |
HTTPValidationErrorResponse
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}
HTTPValidationErrorResponse
Properties
Name |
Type |
Required |
Restrictions |
Description |
detail |
[ValidationError] |
false |
|
none |
IntegerSettingConstraints
{
"maxValue": 0,
"minValue": 0,
"type": "integer"
}
IntegerSettingConstraints
Properties
Name |
Type |
Required |
Restrictions |
Description |
maxValue |
integer¦null |
false |
|
The maximum value of the setting (inclusive). |
minValue |
integer¦null |
false |
|
The minimum value of the setting (inclusive). |
type |
string |
false |
|
The data type of the setting. |
Enumerated Values
Property |
Value |
type |
integer |
LLMSettingDefinition
{
"constraints": {
"maxValue": 0,
"minValue": 0,
"type": "integer"
},
"defaultValue": true,
"description": "string",
"format": "multiline",
"id": "string",
"isNullable": true,
"name": "string",
"type": "integer"
}
LLMSettingDefinition
Properties
Name |
Type |
Required |
Restrictions |
Description |
constraints |
any |
true |
|
The constraints for the LLM setting values. |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
» anonymous |
IntegerSettingConstraints |
false |
|
Available constraints for integer settings. |
xor
Name |
Type |
Required |
Restrictions |
Description |
» anonymous |
FloatSettingConstraints |
false |
|
Available constraints for float settings. |
xor
Name |
Type |
Required |
Restrictions |
Description |
» anonymous |
StringSettingConstraints |
false |
|
Available constraints for string settings. |
xor
Name |
Type |
Required |
Restrictions |
Description |
» anonymous |
BooleanSettingConstraints |
false |
|
Available constraints for boolean settings. |
xor
Name |
Type |
Required |
Restrictions |
Description |
» anonymous |
ObjectIdSettingConstraints |
false |
|
Available constraints for ObjectId settings. |
continued
Name |
Type |
Required |
Restrictions |
Description |
defaultValue |
any |
true |
|
The default value of the LLM setting. |
anyOf
Name |
Type |
Required |
Restrictions |
Description |
» anonymous |
boolean |
false |
|
none |
or
Name |
Type |
Required |
Restrictions |
Description |
» anonymous |
integer |
false |
|
none |
or
Name |
Type |
Required |
Restrictions |
Description |
» anonymous |
number |
false |
|
none |
or
Name |
Type |
Required |
Restrictions |
Description |
» anonymous |
string |
false |
|
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
description |
string |
true |
|
The description of the LLM setting. |
format |
SettingFormat¦null |
false |
|
The expected format of the value of the LLM setting. |
id |
string |
true |
|
The ID of the LLM setting. |
isNullable |
boolean |
false |
|
Whether the setting allows null values (default: true). |
name |
string |
true |
|
The name of the LLM setting. |
type |
SettingType |
true |
|
The data type of the LLM setting. |
{
"contextSize": 0,
"description": "string",
"id": "azure-openai-gpt-3.5-turbo",
"isDeprecated": false,
"isMetered": true,
"license": "string",
"name": "string",
"provider": "string",
"settings": [
{
"constraints": {
"maxValue": 0,
"minValue": 0,
"type": "integer"
},
"defaultValue": true,
"description": "string",
"format": "multiline",
"id": "string",
"isNullable": true,
"name": "string",
"type": "integer"
}
],
"supportedCustomModelLLMValidations": [
{
"id": "string",
"name": "string"
}
],
"supportedLanguages": "string",
"vendor": "string"
}
LanguageModelDefinitionAPIFormatted
Properties
Name |
Type |
Required |
Restrictions |
Description |
contextSize |
integer¦null |
false |
|
The size of the LLM's context, measured in tokens. null if unknown. |
description |
string |
true |
|
The details about the LLM. |
id |
LanguageModelTypeId |
true |
|
The ID of the LLM. |
isDeprecated |
boolean |
false |
|
Whether the LLM is deprecated and will be removed in a future release. |
isMetered |
boolean |
false |
|
Whether the LLM usage is metered. |
license |
string |
true |
|
The usage license information for the LLM. |
name |
string |
true |
|
The name of the LLM. |
provider |
string |
true |
|
The party that provides access to the LLM. |
settings |
[LLMSettingDefinition] |
true |
|
The settings supported by the LLM. |
supportedCustomModelLLMValidations |
[SupportedCustomModelLLMValidation]¦null |
false |
|
The supported custom model validations if applicable for this LLM ID. |
supportedLanguages |
string |
true |
|
The languages supported by the LLM. |
vendor |
string |
true |
|
The vendor of the LLM. |
LanguageModelTypeId
"azure-openai-gpt-3.5-turbo"
LanguageModelTypeId
Properties
Name |
Type |
Required |
Restrictions |
Description |
LanguageModelTypeId |
string |
false |
|
The ID that defines the type of the LLM. |
Enumerated Values
Property |
Value |
LanguageModelTypeId |
[azure-openai-gpt-3.5-turbo , azure-openai-gpt-3.5-turbo-16k , azure-openai-gpt-4 , azure-openai-gpt-4-32k , azure-openai-gpt-4-turbo , azure-openai-gpt-4-o , amazon-titan , anthropic-claude-2 , anthropic-claude-3-haiku , anthropic-claude-3-sonnet , anthropic-claude-3-opus , google-bison , google-gemini-1.5-flash , google-gemini-1.5-pro , custom-model ] |
ListLLMsResponse
{
"count": 0,
"data": [
{
"contextSize": 0,
"description": "string",
"id": "azure-openai-gpt-3.5-turbo",
"isDeprecated": false,
"isMetered": true,
"license": "string",
"name": "string",
"provider": "string",
"settings": [
{
"constraints": {
"maxValue": 0,
"minValue": 0,
"type": "integer"
},
"defaultValue": true,
"description": "string",
"format": "multiline",
"id": "string",
"isNullable": true,
"name": "string",
"type": "integer"
}
],
"supportedCustomModelLLMValidations": [
{
"id": "string",
"name": "string"
}
],
"supportedLanguages": "string",
"vendor": "string"
}
],
"next": "string",
"previous": "string",
"totalCount": 0
}
ListLLMsResponse
Properties
Name |
Type |
Required |
Restrictions |
Description |
count |
integer |
true |
|
The number of records on this page. |
data |
[LanguageModelDefinitionAPIFormatted] |
true |
|
The list of records. |
next |
string¦null |
true |
|
The URL to the next page, or null if there is no such page. |
previous |
string¦null |
true |
|
The URL to the previous page, or null if there is no such page. |
totalCount |
integer |
true |
|
The total number of records. |
ObjectIdSettingConstraints
{
"allowedChoices": [
"string"
],
"type": "object_id"
}
ObjectIdSettingConstraints
Properties
Name |
Type |
Required |
Restrictions |
Description |
allowedChoices |
[string]¦null |
false |
|
The allowed values for the setting. |
type |
string |
false |
|
The data type of the setting. |
Enumerated Values
Property |
Value |
type |
object_id |
SettingFormat
Properties
Name |
Type |
Required |
Restrictions |
Description |
SettingFormat |
string |
false |
|
Supported formats for settings. |
Enumerated Values
Property |
Value |
SettingFormat |
multiline |
SettingType
SettingType
Properties
Name |
Type |
Required |
Restrictions |
Description |
SettingType |
string |
false |
|
Supported data types for settings. |
Enumerated Values
Property |
Value |
SettingType |
[integer , float , string , boolean , object_id , list ] |
StringSettingConstraints
{
"allowedChoices": [
"string"
],
"maxLength": 0,
"minLength": 0,
"type": "string"
}
StringSettingConstraints
Properties
Name |
Type |
Required |
Restrictions |
Description |
allowedChoices |
[string]¦null |
false |
|
The allowed values for the setting. |
maxLength |
integer¦null |
false |
|
The maximum length of the value (inclusive). |
minLength |
integer¦null |
false |
|
The minimum length of the value (inclusive). |
type |
string |
false |
|
The data type of the setting. |
Enumerated Values
Property |
Value |
type |
string |
SupportedCustomModelLLMValidation
{
"id": "string",
"name": "string"
}
SupportedCustomModelLLMValidation
Properties
Name |
Type |
Required |
Restrictions |
Description |
id |
string |
true |
|
The ID of the custom model LLM validation. |
name |
string |
true |
|
The name of the custom model LLM validation. |
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 |
Updated November 12, 2024
Thanks for your feedback!