Skip to main content

Intent

The Intent feature (/admin/intent/instance) manages categorized prompt suggestions that appear in the Chat interface. Intents provide users with pre-built conversation starters organized by topic, making it easier to discover and use the AI capabilities of Turing ES.

Each intent represents a category (e.g., "Boost my work productivity") containing one or more actions — each action is a labeled prompt that is sent directly to the chat when clicked.


Intent Listing

The listing page shows all configured intents as a grid of cards. Each card displays:

  • Title — the intent category name
  • Description — a brief explanation of the category
  • Icon — a Lucide icon representing the category

A New Intent button at the top opens the creation form. Clicking an existing card navigates to its detail page.


Creating or Editing an Intent

The intent form is divided into three sections.

General Information

FieldMax LengthDescription
Title150 charsCategory name displayed in the chat interface (required)
Description500 charsBrief explanation of what prompts this intent provides
IconLucide icon picker — select an icon to represent this category

Actions

Actions are the individual prompts within an intent category. Each action has:

FieldDescription
LabelShort action label shown to the user (e.g., "Create daily schedule") — required
PromptThe full prompt text sent to the chat when the user clicks this action — required

Actions support drag-and-drop reordering — drag the handle on each action card to change the display order. Use the Add Action button to create new actions, and the trash icon to remove existing ones.

Status

FieldDescription
EnabledToggle to show or hide this intent in the chat interface. Disabled intents are not visible to users.

Pre-loaded Intents

Turing ES ships with four default intents:

IntentIconActions
Boost my work productivityBriefcaseCreate daily schedule, Draft a difficult email, Prepare meeting agenda
Learn something newGraduation CapExplain complex topics, 30-day study plan, Test my knowledge
Create or improve contentPen ToolSocial Media Ideas, Proofread & Enhance, Video Scripting
Health & MindsetHeart PulseQuick Meditation Guide, Rapid Meal Ideas, At-home Workout

These can be edited, disabled, or deleted. New intents can be added at any time.


REST API

All endpoints require authentication via the Key header.

MethodEndpointDescription
GET/api/intentList all intents (sorted by title)
GET/api/intent/enabledList enabled intents only (sorted by display order)
GET/api/intent/{id}Get a specific intent with its actions
POST/api/intentCreate a new intent
PUT/api/intent/{id}Update an intent
DELETE/api/intent/{id}Delete an intent and all its actions

Request / Response Body

{
"id": "intent-productivity",
"title": "Boost my work productivity",
"description": "Prompts to help you be more productive at work",
"icon": "lucide:briefcase",
"enabled": 1,
"sortOrder": 0,
"actions": [
{
"id": "action-1",
"label": "Create daily schedule",
"prompt": "Help me create an efficient daily schedule...",
"sortOrder": 0
},
{
"id": "action-2",
"label": "Draft a difficult email",
"prompt": "Help me draft a professional email...",
"sortOrder": 1
}
]
}

Example — list enabled intents:

curl "http://localhost:2700/api/intent/enabled" \
-H "Key: <YOUR_API_TOKEN>"

Example — create an intent:

curl -X POST "http://localhost:2700/api/intent" \
-H "Key: <YOUR_API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"title": "Data Analysis",
"description": "Prompts for analyzing and visualizing data",
"icon": "lucide:bar-chart-3",
"enabled": 1,
"sortOrder": 4,
"actions": [
{
"label": "Summarize a dataset",
"prompt": "Analyze the following dataset and provide key statistics, trends, and insights.",
"sortOrder": 0
}
]
}'

Permissions

Intent management uses role-based access control:

PermissionDescription
INTENT_VIEWView intent categories
INTENT_CREATECreate new intents
INTENT_EDITEdit existing intents
INTENT_DELETEDelete intents

All permissions also require the ROLE_ADMIN role.


PageDescription
ChatThe chat interface where intents are displayed to users
AI AgentsConfigure AI Agents that respond to chat prompts
Administration GuideUser, group, and role management