User Guide
API DOCSVOICE GATEWAYHELPSECURITY
Current Version
Current Version
  • Welcome
  • What's New
  • 🚀GETTING STARTED
    • Login
    • Concepts and Glossary
    • Language Models
      • Syntphony NLP
      • Other NLP and LLM Connectors
      • FAQs
    • Build a Virtual Agent
      • Overview
      • From Scratch
      • By Importing
      • Pre-Built Templates
      • Training task
    • Testing
      • Automated Test
      • Advanced Request
      • Simulate Dialog
      • View Logs
    • Create and manage profiles
  • 💬BUILD DIALOGS
    • Flows
    • Dialog Cells
      • Intent
      • Entity
      • Answer
      • Input
      • Jump
      • End
      • Service
      • Rest Connector
      • Code
      • Rule
        • Variable answers using Code and Rule cells
        • Enable and disable flows using Rule Cells
    • Data Masking of Personal Identificable Information
    • Dynamic Content and Contexts
    • Voice Agent
    • Multilingual Agent (beta)
  • ✨GENERATIVE AI
    • AI features
    • Assist Answer (beta)
    • Examples Generator
    • Knowledge AI
    • Prompt cell
      • Prompt crafting
      • Practical examples
    • Rephrase Answer
    • Zero-Shot LLM
  • 🌐CHANNELS
    • Channels
      • WhatsApp (by Infobip)
      • Facebook Messenger
      • Microsoft Teams
      • Integrating Existing Channels
    • Webchat Plugin
  • ⚙️CONFIGURATIONS
    • Parameters
    • Advanced Resources
    • Other Options
      • Intent Navigator
  • 📊ANALYTICS & INSIGHTS
    • Dashboards
      • Overview
      • Funnel charts
      • User messages
      • Conversations
      • Reports
    • External Analytics Platforms
  • API DOCS
    • Overview
    • API Guidelines
      • Conversation API
      • Cloner API
      • EVG Connector
      • Management API
        • Admin API
          • Bot Admin
          • Environment
          • Organization
          • User
          • Notification
        • Instance API
          • Knowledge AI
          • Knowledge AI NLP
          • Answer
          • Automated Tests
          • Bot
          • Broker
          • Channel
          • Dashboard
          • Dialog Manager
          • Entity
          • Generative Service
          • Intent
          • Parameters
          • Tag
          • Technical Log
          • Training
          • Transactional Service
          • Rest Connector
          • Wait Input
          • Websnippet
      • Webhooks
    • Infrastructure Guidelines
      • Syntphony CAI server Installation guide
      • Maintenance Methods
      • Supported/verified third-party software
    • Data Structure
      • Admin Data Structure
      • Environment Data Structure
    • Voice Gateway
      • Genesys Cloud CX
Powered by GitBook
On this page

Was this helpful?

  1. API DOCS
  2. API Guidelines
  3. Management API
  4. Instance API

Automated Tests

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

PreviousAnswerNextBot

Last updated 5 months ago

Was this helpful?

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

Utterance Executions

Execute the test

post
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
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution/{testUUID} HTTP/1.1
Host: 
Accept: */*
{
  "testId": "text",
  "status": "PENDING"
}

Get the test assertiveness

get
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
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution/{testUUID}/assertiveness HTTP/1.1
Host: 
Accept: */*
{
  "testId": "text",
  "testName": "text",
  "countOfTests": 1,
  "lastUpdated": 1,
  "status": "PENDING",
  "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"
        }
      ]
    }
  }
}

Find all tests

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
orderBystringOptional

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

Default: updatedAt
directionstringOptional

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

Default: DESC
pageinteger · int32Optional

The number of page and the default is 1

Default: 1Example: 1
sizeinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1
Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "id": "text",
      "name": "text",
      "lastUpdated": 1,
      "channelDTO": {
        "channelId": "text",
        "channelName": "text",
        "imageName": "text",
        "typeChannel": 1
      },
      "result": 1,
      "status": "PENDING"
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Find all page of utterances

get
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 · int32Optional

The number of page and the default is 1

Default: 1Example: 1
sizeinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1
Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterances/{testUUID} HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "uuid": "text",
      "description": "text",
      "utterance": "text",
      "expectedCategory": "text",
      "expectedValue": "text",
      "expectedAnswer": "text",
      "createdAt": "2025-05-09T10:47:08.976Z",
      "updatedAt": "2025-05-09T10:47:08.976Z"
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Find all page of automated tests utterances

get
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 · int32Optional

The number of page and the default is 1

Default: 1Example: 1
sizeinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1
Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterance-execution/{testUUID}?filter=text HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "utterance": "text",
      "successRate": 1,
      "categoryUtterance": {
        "expected": "text",
        "given": "text"
      },
      "answerUtterance": {
        "expected": "text",
        "given": "text"
      },
      "valueUtterance": {
        "expected": "text",
        "given": "text"
      }
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Export the the data of the automated test

get
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
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterance-execution/{testUUID}/export?filter=text HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "utterance": "text",
      "successRate": 1,
      "categoryUtterance": {
        "expected": "text",
        "given": "text"
      },
      "answerUtterance": {
        "expected": "text",
        "given": "text"
      },
      "valueUtterance": {
        "expected": "text",
        "given": "text"
      }
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}
  • Automated Tests
  • POSTCreate automated test
  • POSTUpdate file to test
  • Automated Test Executions
  • POSTExecute the test
  • GETGet the test assertiveness
  • GETFind all tests
  • Utterance
  • GETFind all page of utterances
  • Utterance Executions
  • GETFind all page of automated tests utterances
  • GETExport the the data of the automated test

Create automated test

post
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
201
Created
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests?channel=text&name=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{
  "message": "text",
  "dataTest": {
    "testId": "text",
    "utterances": [
      {
        "uuid": "text",
        "description": "text",
        "utterance": "text",
        "expectedCategory": "text",
        "expectedValue": "text",
        "expectedAnswer": "text",
        "createdAt": "2025-05-09T10:47:08.976Z",
        "updatedAt": "2025-05-09T10:47:08.976Z"
      }
    ],
    "rows": 1
  }
}

Update file to test

post
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
200
Ok
application/json
400
Bad Request
application/json
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
application/json
422
Unprocessable Entity
*/*
500
Internal Server Error
application/json
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests/{testUUID}?channel=text&name=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{
  "message": "text",
  "dataTest": {
    "testId": "text",
    "utterances": [
      {
        "uuid": "text",
        "description": "text",
        "utterance": "text",
        "expectedCategory": "text",
        "expectedValue": "text",
        "expectedAnswer": "text",
        "createdAt": "2025-05-09T10:47:08.976Z",
        "updatedAt": "2025-05-09T10:47:08.976Z"
      }
    ],
    "rows": 1
  }
}