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
Accept the expected result of a test ticket
Set the expected value for specific ticket in a run to the observed value. This also updates the expected results for all future runs, and updates the statistics of the test run.
curl --request PATCH \
--url https://demo.enneo.ai/api/mind/aiQualityCheck/testRun/{testRunId}/acceptExpectedResult/{ticketId}
{
"success": true,
"message": "Test ticket expected result accepted successfully",
"testTicket": {
"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
Response
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 PATCH \
--url https://demo.enneo.ai/api/mind/aiQualityCheck/testRun/{testRunId}/acceptExpectedResult/{ticketId}
{
"success": true,
"message": "Test ticket expected result accepted successfully",
"testTicket": {
"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": {}
}
}