Create a new evaluation dataset for the given agent

POST

/api/v2/agents/{agent_id}/evaluations/datasets

Create a new evaluation dataset for the given agent.

Path Parameters:

agent_id: ID of the agent to create the dataset for

Request Body:
JSON object containing the dataset details

Returns:
JSON response with object containing created dataset

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///api/v2/agents//evaluations/datasets' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "description": "string",
    "tags": [
        "string"
    ],
    "chatlog_ids": [
        0
    ],
    "custom_queries": [
        {
            "question": "string",
            "response": {
                "property1": null,
                "property2": null
            }
        }
    ]
}'

Response Example

201 - Success

{
    "success": true,
    "message": "Dataset created successfully",
    "data": {
        "id": 28,
        "name": "test1",
        "description": "i am made to test",
        "tags": [
            "evaluation",
            "test",
            "qa"
        ],
        "queries": [
            {
                "id": 47,
                "chatlog": 1,
                "question": "hi",
                "response": "Hello! How can I assist you today?",
                "evaluation_dataset_id": 28
            }
        ],
        "created_by": "johndoe@example.com",
        "created_on": "2024-11-13T12:28:45.654504Z",
        "query_count": 1
    }
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Dataset successfully created

Body

🔴500Server Error

Retrieve all evaluation datasets for a specific agent

Delete multiple datasets or all datasets for an agent