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.

Create automated test

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

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Body

application/json

file*string (binary)

File with data to test

Response

201400401403404409422500

Created

Body

*/*

messagestring

Message with success or not

dataTestDataTestDTO (object)

DTO data test response when create or update successfully a automated test

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests?channel=text&name=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "file": "binary"
    }),
});
const data = await response.json();

Response

201400401403404409422500

{
  "message": "text",
  "dataTest": {
    "testId": "text",
    "utterances": [
      {
        "uuid": "text",
        "description": "text",
        "utterance": "text",
        "expectedCategory": "text",
        "expectedValue": "text",
        "expectedAnswer": "text",
        "createdAt": "2024-12-21T11:40:18.221Z",
        "updatedAt": "2024-12-21T11:40:18.221Z"
      }
    ],
    "rows": 0
  }
}

Update file to test

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

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

testUUID*string

A valid automated test execution Uuid

Query parameters

Body

application/json

file*string (binary)

File with data to test

Response

200400401403404409422500

Ok

Body

application/json

messagestring

Message with success or not

dataTestDataTestDTO (object)

DTO data test response when create or update successfully a automated test

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests/{testUUID}?channel=text&name=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "file": "binary"
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "message": "text",
  "dataTest": {
    "testId": "text",
    "utterances": [
      {
        "uuid": "text",
        "description": "text",
        "utterance": "text",
        "expectedCategory": "text",
        "expectedValue": "text",
        "expectedAnswer": "text",
        "createdAt": "2024-12-21T11:40:18.221Z",
        "updatedAt": "2024-12-21T11:40:18.221Z"
      }
    ],
    "rows": 0
  }
}

Automated Test Executions

Execute the test

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

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

testUUID*string

A valid automated test execution Uuid

Response

200400401403404409422500

Ok

Body

*/*

testIdstring

Automated test execution uuid

statusenum

Automated test execution status

PENDINGIN_PROGRESSERRORFINISHED

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution/{testUUID}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

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

Get the test assertiveness

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

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

testUUID*string

A valid automated test execution Uuid

Response

200400401403404409422500

Ok

Body

*/*

testIdstring

Automated test execution uuid

testNamestring

Automated test execution name

countOfTestsinteger (int64)

Automated test execution tests executed

lastUpdatedinteger (int64)

Automated test execution last updated

statusenum

Automated test execution status

PENDINGIN_PROGRESSERRORFINISHED

totalSentencesinteger (int32)

Automated test execution number of utterances

assertivenessChartAssertivenessChart (object)

DTO response with assertiveness details

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution/{testUUID}/assertiveness', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

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

Find all tests

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

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

sizeinteger (int32)

contentarray of AutomatedTestDTO (object)

numberinteger (int32)

sortSortObject (object)

firstboolean

lastboolean

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

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

Utterance

Find all page of utterances

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

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

testUUID*string

A valid automated test execution Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

sizeinteger (int32)

contentarray of AutomatedTestUtterance (object)

numberinteger (int32)

sortSortObject (object)

firstboolean

lastboolean

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterances/{testUUID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "unpaged": false,
    "paged": false,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "uuid": "text",
      "description": "text",
      "utterance": "text",
      "expectedCategory": "text",
      "expectedValue": "text",
      "expectedAnswer": "text",
      "createdAt": "2024-12-21T11:40:18.221Z",
      "updatedAt": "2024-12-21T11:40:18.221Z"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

Utterance Executions

Find all page of automated tests utterances

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

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

testUUID*string

A valid bot Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

sizeinteger (int32)

contentarray of AutomatedTestUtteranceResult (object)

numberinteger (int32)

sortSortObject (object)

firstboolean

lastboolean

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterance-execution/{testUUID}?filter=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

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

Export the the data of the automated test

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

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

testUUID*string

A valid bot Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

sizeinteger (int32)

contentarray of AutomatedTestUtteranceResult (object)

numberinteger (int32)

sortSortObject (object)

firstboolean

lastboolean

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterance-execution/{testUUID}/export?filter=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

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