Automated Tests

The Automated Tests API contains all methods related to all models used in Automated Tests.

API SUBPATH: eva-automated-tests

This API covers all Models used in Automated Tests: There's the Automated Test itself, which contains it's provided Utterances, and then their executions and results as both an Automated Tests Executions collection and a Utterance Executions collection.

Automated Tests

Once created, an automated test is then listed as an execution which still didn't run. Hence, there is no pagination for Automated Tests.

Automated Test Executions

Utterance Executions

PreviousAnswer API NextBot

Was this helpful?

#144: 4.5 - Gen AI (KAI, Rephrase, Assist) + What's New (Notifications)

Change request updated 1 year ago

Creates a new Automated Test

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

channelstringrequired

A valid channel Uuid

namestringrequired

A valid name to the test

Body

filestring · binaryrequired

File with data to test

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests?channel=text&name=text' \
  --header 'Content-Type: application/json' \
  --data '{"file":"text"}'

201

400

401

403

404

409

422

500

{
  "message": "text",
  "dataTest": {
    "testId": "text",
    "rows": 1,
    "utterances": [
      {
        "uuid": "text",
        "description": "text",
        "utterance": "text",
        "expectedCategory": "text",
        "expectedValue": "text",
        "expectedAnswer": "text",
        "createdAt": "2025-02-22T16:46:28.097Z",
        "updatedAt": "2025-02-22T16:46:28.097Z"
      }
    ]
  }
}

Created

Submits a new file for an existing, unexecuted Automated Test.

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests/{testUUID}

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

testUUIDstringrequired

A valid automated test execution Uuid

Query parameters

channelstringrequired

A valid channel Uuid

namestringrequired

A valid name to the test

Body

filestring · binaryrequired

File with data to test

Responses

application/json

*/*

application/json

*/*

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests/{testUUID}?channel=text&name=text' \
  --header 'Content-Type: application/json' \
  --data '{"file":"text"}'

200

400

401

403

404

409

422

500

{
  "message": "text",
  "dataTest": {
    "testId": "text",
    "rows": 1,
    "utterances": [
      {
        "uuid": "text",
        "description": "text",
        "utterance": "text",
        "expectedCategory": "text",
        "expectedValue": "text",
        "expectedAnswer": "text",
        "createdAt": "2025-02-22T16:46:28.097Z",
        "updatedAt": "2025-02-22T16:46:28.097Z"
      }
    ]
  }
}

Removes all automated tests from a given channel

delete

/internal/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests/remove-all-from-channel

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

userUUIDstringrequired

A valid user Uuid

channelUuidstringrequired

A valid channel Uuid

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/internal/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests/remove-all-from-channel?userUUID=text&channelUuid=text'

201

400

401

403

404

409

422

500

{
  "message": "text",
  "dataTest": {
    "testId": "text",
    "rows": 1,
    "utterances": [
      {
        "uuid": "text",
        "description": "text",
        "utterance": "text",
        "expectedCategory": "text",
        "expectedValue": "text",
        "expectedAnswer": "text",
        "createdAt": "2025-02-22T16:46:28.097Z",
        "updatedAt": "2025-02-22T16:46:28.097Z"
      }
    ]
  }
}

Removed

Acquires a pagination of all Automated Tests.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

orderBystring · default: updatedAt

Field want to sort by. Default is 'updatedAt'; other available terms are 'name' and 'score'.

directionstring · default: DESC

Direction of ordenation, ASC or DESC. The default is DESC

pageinteger · int32 · default: 1

The number of page and the default is 1

Example: 1

sizeinteger · int32 · default: 5

The number of services per pages and the default is 5

Example: 1

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution'

200

400

401

403

404

409

422

500

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "unpaged": true,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "size": 1,
  "number": 1,
  "empty": true,
  "content": [
    {
      "id": "text",
      "name": "text",
      "lastUpdated": 1,
      "channelDTO": {
        "channelId": "text",
        "channelName": "text",
        "channelImage": "text",
        "typeChannel": 1
      },
      "result": 1,
      "status": "PENDING"
    }
  ]
}

Acquires a pagination of all Utterances belonguing to a given Automated Test.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterances/{testUUID}

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

testUUIDstringrequired

A valid automated test execution Uuid

Query parameters

pageinteger · int32 · default: 1

The number of page and the default is 1

Example: 1

sizeinteger · int32 · default: 5

The number of services per pages and the default is 5

Example: 1

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterances/{testUUID}'

200

400

401

403

404

409

422

500

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "unpaged": true,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "size": 1,
  "number": 1,
  "empty": true,
  "content": [
    {
      "uuid": "text",
      "description": "text",
      "utterance": "text",
      "expectedCategory": "text",
      "expectedValue": "text",
      "expectedAnswer": "text",
      "createdAt": "2025-02-22T16:46:28.097Z",
      "updatedAt": "2025-02-22T16:46:28.097Z"
    }
  ]
}

Runs or re-runs an Automated Test.

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution/{testUUID}

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

testUUIDstringrequired

A valid automated test execution Uuid

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution/{testUUID}'

200

400

401

403

404

409

422

500

{
  "testId": "text",
  "status": "PENDING"
}

Retrieves the test assertiveness of a given Automated Test Execution.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution/{testUUID}/assertiveness

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

testUUIDstringrequired

A valid automated test execution Uuid

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution/{testUUID}/assertiveness'

200

400

401

403

404

409

422

500

{
  "testId": "text",
  "testName": "text",
  "countOfTests": 1,
  "lastUpdated": 1,
  "totalSentences": 1,
  "assertivenessChart": {
    "total": 1,
    "intents": {
      "low": 1,
      "half": 1,
      "high": 1
    },
    "questions": {
      "low": 1,
      "half": 1,
      "high": 1
    },
    "dispersionIntentChart": {
      "low": [
        {
          "confidence": 1,
          "value": "text"
        }
      ],
      "average": [
        {
          "confidence": 1,
          "value": "text"
        }
      ],
      "high": [
        {
          "confidence": 1,
          "value": "text"
        }
      ]
    },
    "dispersionQuestionsChart": {
      "low": [
        {
          "confidence": 1,
          "value": "text"
        }
      ],
      "average": [
        {
          "confidence": 1,
          "value": "text"
        }
      ],
      "high": [
        {
          "confidence": 1,
          "value": "text"
        }
      ]
    }
  },
  "status": "PENDING"
}

Acquires a pagination of all Utterance Execution results belonguing to a given Automated Test Execution.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterance-execution/{testUUID}

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

testUUIDstringrequired

A valid bot Uuid

Query parameters

filterstringrequired

LOW, AVERAGE, HIGH or ALL

pageinteger · int32 · default: 1

The number of page and the default is 1

Example: 1

sizeinteger · int32 · default: 5

The number of services per pages and the default is 5

Example: 1

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterance-execution/{testUUID}?filter=text'

200

400

401

403

404

409

422

500

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "unpaged": true,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "size": 1,
  "number": 1,
  "empty": true,
  "content": [
    {
      "utterance": "text",
      "successRate": 1,
      "categoryUtterance": {
        "expected": "text",
        "given": "text"
      },
      "answerUtterance": {
        "expected": "text",
        "given": "text"
      },
      "valueUtterance": {
        "expected": "text",
        "given": "text"
      }
    }
  ]
}

Exports all the data of an automated test. In the Cockpit, this is consumed and delivered as a .xls file.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterance-execution/{testUUID}/export

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

testUUIDstringrequired

A valid bot Uuid

Query parameters

filterstringrequired

LOW, AVERAGE, HIGH or ALL

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterance-execution/{testUUID}/export?filter=text'

200

400

401

403

404

409

422

500

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "unpaged": true,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "size": 1,
  "number": 1,
  "empty": true,
  "content": [
    {
      "utterance": "text",
      "successRate": 1,
      "categoryUtterance": {
        "expected": "text",
        "given": "text"
      },
      "answerUtterance": {
        "expected": "text",
        "given": "text"
      },
      "valueUtterance": {
        "expected": "text",
        "given": "text"
      }
    }
  ]
}