DataRobot API resources > API reference documentation > DataRobot REST API > Comparison Chats (GenAI)

Comparison Chats (GenAI)¶

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

GET /api/v2/genai/comparisonChats/¶

List comparison chats.

Code samples¶

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/genai/comparisonChats/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
playgroundId	query	string	false	Only retrieve the comparison chats 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.
sort	query	any	false	Apply this sort order to the results. Valid options are "name" and "creationDate". Prefix the attribute name with a dash to sort in descending order, e.g., sort=-creationDate.

Example responses¶

200 Response

{
  "count": 0,
  "data": [
    {
      "creationDate": "2019-08-24T14:15:22Z",
      "creationUserId": "string",
      "id": "string",
      "name": "string",
      "playgroundId": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Successful Response	ListComparisonChatsResponse
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/comparisonChats/¶

Create a new comparison chat.

Code samples¶

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/genai/comparisonChats/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter¶

{
  "name": "string",
  "playgroundId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateComparisonChatRequest	true	none

Example responses¶

201 Response

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "id": "string",
  "name": "string",
  "playgroundId": "string"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Successful Response	ComparisonChatResponse
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/comparisonChats/{comparisonChatId}/¶

Delete an existing comparison chat.

Code samples¶

# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/genai/comparisonChats/{comparisonChatId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
comparisonChatId	path	string	true	The ID of the comparison chat to delete.

Example responses¶

422 Response

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

Responses¶

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

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

BearerAuth

GET /api/v2/genai/comparisonChats/{comparisonChatId}/¶

Retrieve an existing comparison chat.

Code samples¶

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/genai/comparisonChats/{comparisonChatId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
comparisonChatId	path	string	true	The ID of the comparison chat to retrieve.

Example responses¶

200 Response

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "id": "string",
  "name": "string",
  "playgroundId": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Successful Response	ComparisonChatResponse
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/comparisonChats/{comparisonChatId}/¶

Edit an existing comparison chat.

Code samples¶

# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/genai/comparisonChats/{comparisonChatId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter¶

{
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
comparisonChatId	path	string	true	The ID of the comparison chat to edit.
body	body	EditComparisonChatRequest	true	none

Example responses¶

200 Response

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "id": "string",
  "name": "string",
  "playgroundId": "string"
}

Responses¶

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

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

BearerAuth

Schemas¶

ComparisonChatResponse

{
  "creationDate": "2019-08-24T14:15:22Z",
  "creationUserId": "string",
  "id": "string",
  "name": "string",
  "playgroundId": "string"
}

ComparisonChatResponse

Properties¶

Name	Type	Required	Description
creationDate	string(date-time)	true	The creation date of the comparison chat (ISO 8601 formatted).
creationUserId	string	true	The ID of the user that created the comparison chat.
id	string	true	The ID of the comparison chat.
name	string	true	The name of the comparison chat.
playgroundId	string	true	The ID of the playground associated with the comparison chat.

ComparisonChatsSortQueryParam

"name"

ComparisonChatsSortQueryParam

Properties¶

Name	Type	Required	Restrictions	Description
ComparisonChatsSortQueryParam	string	false		Sort order values for listing comparison chats.

Enumerated Values¶

Property	Value
ComparisonChatsSortQueryParam	[`name`, `-name`, `creationDate`, `-creationDate`]

CreateComparisonChatRequest

{
  "name": "string",
  "playgroundId": "string"
}

CreateComparisonChatRequest

Properties¶

Name	Type	Required	Restrictions	Description
name	string	true	maxLength: 5000 minLength: 1 minLength: 1	The name of the comparison chat.
playgroundId	string	true		The ID of the playground to associate with the comparison chat.

EditComparisonChatRequest

{
  "name": "string"
}

EditComparisonChatRequest

Properties¶

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

HTTPValidationErrorResponse

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

HTTPValidationErrorResponse

Properties¶

Name	Type	Required	Restrictions	Description
detail	[ValidationError]	false		none

ListComparisonChatsResponse

{
  "count": 0,
  "data": [
    {
      "creationDate": "2019-08-24T14:15:22Z",
      "creationUserId": "string",
      "id": "string",
      "name": "string",
      "playgroundId": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

ListComparisonChatsResponse

Properties¶

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

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

Comparison Chats (GenAI)¶

GET /api/v2/genai/comparisonChats/¶

Code samples¶

Parameters

Example responses¶

Responses¶

POST /api/v2/genai/comparisonChats/¶

Code samples¶

Body parameter¶

Parameters

Example responses¶

Responses¶

DELETE /api/v2/genai/comparisonChats/{comparisonChatId}/¶

Code samples¶

Parameters

Example responses¶

Responses¶

GET /api/v2/genai/comparisonChats/{comparisonChatId}/¶

Code samples¶

Parameters

Example responses¶

Responses¶

PATCH /api/v2/genai/comparisonChats/{comparisonChatId}/¶

Code samples¶

Body parameter¶

Parameters

Example responses¶

Responses¶

Schemas¶

ComparisonChatResponse

Properties¶

ComparisonChatsSortQueryParam

Properties¶

Enumerated Values¶

CreateComparisonChatRequest

Properties¶

EditComparisonChatRequest

Properties¶

HTTPValidationErrorResponse

Properties¶

ListComparisonChatsResponse

Properties¶

ValidationError

Properties¶

Was this page helpful?

Great! Let us know what you found helpful.

What can we do to improve the content?