API Dokumentation
ticket
- GETGet next ticket id to work on
- POSTGet a list of tickets
- POSTCreate a ticket
- PATCHUpdate a few tickets at once
- GETGet a ticket
- PATCHUpdate a ticket
- GETGet ticket variables
- GETGet a tickets history
- POSTForward a ticket
- POSTAuto-execute a ticket
- GETPing a ticket
- GETGet ticket activity
- GETGet ticket stats
- GETGet agent queue status
customer
intent
aiAgent
- GETList of all available AI agents as an array
- GETList of all available AI agents as an tree based on associated tag
- POSTLoad enneo default AI Agents
- POSTCreate a new aiAgent
- GETGet an AI Agent by id
- DELDelete an existing AI Agent
- PATCHUpdate an existing AI Agent
- GETGet similar tickets for an AI Agent
- POSTPreview an AI Agent
- POSTGet the outcome of an AI Agent
aiQualityCheck
- GETGet all test runs with pagination
- POSTSchedule a new AI quality check
- GETGet a specific test run by ID
- DELDelete a specific test run by ID
- PATCHUpdate the expected result of a test ticket
- PATCHAccept the expected result of a test ticket
- POSTAccept ALL the expected results of for a test run
- GETGet all AI agents for which test runs can be triggered
- GETGet all AI agents for which test runs can be triggered
- GETGet test cases by AI agent ID
- POSTAdd test cases for an AI agent
- DELDelete a test case by ID
- PATCHUpdate a test case by ID
intentTemplate
profile
team
reminder
settings
- GETGet settings of a client
- POSTUpdate multiple settings at once
- GETGet settings of a client and return the results in a compact form
- GETGet settings of a client in a grouped way for a category
- PUTUpdate setting
- GETSearch settings
- GETGet Subchannels
- POSTAdd a new Subchannel
- DELDelete a Subchannel
- GETGet User Defined Functions
- POSTAdd a new User Defined Function
- DELDelete a User Defined Function
- GETRedirect to Microsoft authorization page
- GETCallback for Microsoft authorization
tag
cron
version
knowledgeSourceStructure
knowledgeSource
pcProxy
cortex
Get a specific test run by ID
curl --request GET \
--url https://demo.enneo.ai/api/mind/aiQualityCheck/testRun/{testRunId}
{
"scores": {
"overall": 0.82,
"contractId": 0.72,
"sentiment": 0.89
},
"testRun": {
"id": 123,
"aiAgentId": "<string>",
"aiAgentName": "<string>",
"state": "processing",
"config": {},
"createdBy": 123,
"createdAt": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"ticketsScheduledForTesting": 123,
"ticketsTested": 123,
"successfulTests": 123,
"description": "<string>"
},
"tickets": [
{
"id": 123,
"testRunId": 123,
"testCaseId": 123,
"ticketId": 123,
"aiAgentId": "<string>",
"state": "scheduled",
"config": {},
"expectedResult": {
"contractId": "123456",
"inputParameters": {
"change_meter_reading": {
"_action": null,
"requestedDeposit": 35
}
},
"intentDetection": [
"change_meter_reading",
"change_payment_method"
],
"outcomeActions": {
"change_meter_reading": [
"Update ERP System",
"Inform Customer change is not possible"
]
},
"outcomeNotifications": {
"change_meter_reading": [
"Meter reading is plausible"
]
},
"outcomeText": {
"change_meter_reading": null
},
"outcomeType": {
"change_meter_reading": "interaction"
},
"sentiment": "disappointed",
"tags": [
"sales",
"marketing"
],
"aiSupportLevel": "human",
"error": null
},
"actualResult": {
"contractId": "123456",
"inputParameters": {
"change_meter_reading": {
"_action": null,
"requestedDeposit": 35
}
},
"intentDetection": [
"change_meter_reading",
"change_payment_method"
],
"outcomeActions": {
"change_meter_reading": [
"Update ERP System",
"Inform Customer change is not possible"
]
},
"outcomeNotifications": {
"change_meter_reading": [
"Meter reading is plausible"
]
},
"outcomeText": {
"change_meter_reading": null
},
"outcomeType": {
"change_meter_reading": "interaction"
},
"sentiment": "disappointed",
"tags": [
"sales",
"marketing"
],
"aiSupportLevel": "human",
"error": null
},
"rawResult": {},
"outcomeShort": "pass",
"outcome": {}
}
]
}
Authorizations
Cookie-based authentication
Path Parameters
Response
Represents a test run for AI quality checks. A test run is a collection of tickets that are tested against an expected output.
The ID of the test run
Id code of the AI agent that is being tested. If null, the test run is not associated with an AI agent, and applies to all AI agents
Corresponding name of the AI agent, pulled via FK from the ai_agent table
Current state of the test run
processing
, completed
If specified, any additional test run parameters
ID of the user who created the test run
Date when the test run was created
Date when the test run was completed
Number of tickets scheduled for testing
Number of tickets tested
Number of successful tests
Optional description of the test run
Represents an individual ticket that is tested regarding AI quality as part of a test run
The ID of the test case. Null if not yet saved.
The ID of the test run
The ID of the test case
The ID of the ticket
The ID code of the AI agent that this ticket is being tested against
The scheduling state of the ticket
scheduled
, processing
, completed
, error
If specified, any additional test run parameters
The expected result of the test case
The actual result of the test case
The raw result of the test case
The short outcome of the test case (pass, fail, or unknown). Null if not yet processed.
pass
, fail
, unknown
The detailed outcome of the test case, with a property per test case. See also the AiTestTicketResult for further reference. Null if not yet processed.
curl --request GET \
--url https://demo.enneo.ai/api/mind/aiQualityCheck/testRun/{testRunId}
{
"scores": {
"overall": 0.82,
"contractId": 0.72,
"sentiment": 0.89
},
"testRun": {
"id": 123,
"aiAgentId": "<string>",
"aiAgentName": "<string>",
"state": "processing",
"config": {},
"createdBy": 123,
"createdAt": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"ticketsScheduledForTesting": 123,
"ticketsTested": 123,
"successfulTests": 123,
"description": "<string>"
},
"tickets": [
{
"id": 123,
"testRunId": 123,
"testCaseId": 123,
"ticketId": 123,
"aiAgentId": "<string>",
"state": "scheduled",
"config": {},
"expectedResult": {
"contractId": "123456",
"inputParameters": {
"change_meter_reading": {
"_action": null,
"requestedDeposit": 35
}
},
"intentDetection": [
"change_meter_reading",
"change_payment_method"
],
"outcomeActions": {
"change_meter_reading": [
"Update ERP System",
"Inform Customer change is not possible"
]
},
"outcomeNotifications": {
"change_meter_reading": [
"Meter reading is plausible"
]
},
"outcomeText": {
"change_meter_reading": null
},
"outcomeType": {
"change_meter_reading": "interaction"
},
"sentiment": "disappointed",
"tags": [
"sales",
"marketing"
],
"aiSupportLevel": "human",
"error": null
},
"actualResult": {
"contractId": "123456",
"inputParameters": {
"change_meter_reading": {
"_action": null,
"requestedDeposit": 35
}
},
"intentDetection": [
"change_meter_reading",
"change_payment_method"
],
"outcomeActions": {
"change_meter_reading": [
"Update ERP System",
"Inform Customer change is not possible"
]
},
"outcomeNotifications": {
"change_meter_reading": [
"Meter reading is plausible"
]
},
"outcomeText": {
"change_meter_reading": null
},
"outcomeType": {
"change_meter_reading": "interaction"
},
"sentiment": "disappointed",
"tags": [
"sales",
"marketing"
],
"aiSupportLevel": "human",
"error": null
},
"rawResult": {},
"outcomeShort": "pass",
"outcome": {}
}
]
}