Zum Hauptinhalt springen
GET
/
intent
/
list
List of all available intents and categories
curl --request GET \
  --url https://demo.enneo.ai/api/mind/intent/list \
  --header 'Authorization: Bearer <token>'
{
  "intentCandidates": {
    "id": 123,
    "name": "Complaint",
    "fullName": "Second Level: Complaint",
    "parent": 6,
    "reference": "ticket",
    "type": "skill",
    "visibility": "public",
    "color": "grey",
    "properties": [],
    "complexity": "moderate",
    "sla": 8,
    "priority": "do-not-change",
    "channels": [
      "email",
      "chat"
    ],
    "subchannels": [
      2,
      4
    ],
    "routingRelevance": true,
    "detectionDetails": {},
    "assignment": [
      "assignBySubchannel",
      "assignByCustomLogic"
    ],
    "testCase": {},
    "modifiedBy": "John Doe",
    "modifiedAt": "2024-08-29 14:38:12",
    "intentCandidates": [
      [
        {
          "code": "process_meter_reading",
          "name": "Process meter reading",
          "categoryName": "Meter reading",
          "confidence": 0.91,
          "tags": [
            "prePopulated",
            "writesToErp"
          ],
          "message": null,
          "order": 1
        }
      ]
    ],
    "children": [
      {
        "id": 123,
        "name": "Complaint",
        "fullName": "Second Level: Complaint",
        "parent": 6,
        "reference": "ticket",
        "type": "skill",
        "visibility": "public",
        "color": "grey",
        "properties": [],
        "complexity": "moderate",
        "sla": 8,
        "priority": "do-not-change",
        "channels": [
          "email",
          "chat"
        ],
        "subchannels": [
          2,
          4
        ],
        "routingRelevance": true,
        "detectionDetails": {},
        "assignment": [
          "assignBySubchannel",
          "assignByCustomLogic"
        ],
        "testCase": {},
        "modifiedBy": "John Doe",
        "modifiedAt": "2024-08-29 14:38:12",
        "intentCandidates": [
          [
            {
              "code": "process_meter_reading",
              "name": "Process meter reading",
              "categoryName": "Meter reading",
              "confidence": 0.91,
              "tags": [
                "prePopulated",
                "writesToErp"
              ],
              "message": null,
              "order": 1
            }
          ]
        ]
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.enneo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Autorisierungen

​
Authorization
string
header
erforderlich

JWT-based authentication

Abfrageparameter

​
ticketId
integer

If provided, include specific recommendations based on the provided ticket id

​
q
string
erforderlich

Search query

​
includeTopIntents
boolean
Standard:false

Includes also top intents as a root items. Top intents are suggested intents based on what the AI thinks fits to the ticket

​
includeUnassignedIntents
boolean
Standard:false

Includes any intents that are not assigned to a skill tag. Useful when a supervisor edits intents, and we don't have an agent working on the ticket

​
onlyTagsWithIntents
boolean
Standard:false

If yes, then tags with no intents assigned will be excluded from the result tree

Antwort

Successful operation

​
intentCandidates
object

Tag object with intent candidates inside