Instruction Configuration
The Instruction Configuration is the heart of agent behavior. It contains prompts, guidelines, and contextual instructions that define how agents operate during conversations. One instruction set can govern multiple agents (1:N relationship).
Schema: InstructionConfigurationSchema
Source: src/core/service-configuration/instruction-config.schema.ts
Attributes
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | — | — | Unique identifier for the instruction configuration |
instructionName | string | Yes | — | System-readable name (e.g., 'customer-support-agent') |
role | string | Yes | — | Role or persona the agent adopts |
introductionMessage | string | Yes | — | Initial greeting message for conversations |
instructions | string | Yes | — | Detailed behavioral guidelines and decision-making processes |
guardrails | string | Yes | — | Safety constraints, compliance rules, and forbidden topics |
requiredSkills | array<string> | No | — | Required capabilities (e.g., 'appointment_booking') |
validationRules | object | No | — | Custom validation rules for input/output |
serviceId | string | No | — | Associated service ID |
supportedServices | array<BusinessSupportServices> | No | [] | Enabled platform services (tools) |
tools | array<string> | No | — | Tool identifiers for extended capabilities |
isTemplate | boolean | No | false | Whether this is a reusable template |
isPrimary | boolean | No | false | Whether this is the primary system template |
metadata | object | No | — | Additional metadata |
knowledgeSourceIds | array<string> | No | [] | Referenced knowledge source IDs |
createdAt | number | — | — | Unix timestamp when created |
updatedAt | number | — | — | Unix timestamp when last updated |
Example
{
"id": "inst_abc123",
"instructionName": "customer-support-agent",
"role": "Customer Support Specialist",
"introductionMessage": "Hello! How can I help you today?",
"instructions": "You are a helpful customer support agent. Always be polite and professional...",
"guardrails": "Never share sensitive customer data. Always verify identity before account changes...",
"supportedServices": ["APPOINTMENT_MANAGEMENT"],
"knowledgeSourceIds": ["kb_789"],
"isTemplate": false,
"isPrimary": false,
"createdAt": 1709856000000,
"updatedAt": 1709856000000
}
Create / Update Schemas
| Schema | Description | Omits |
|---|---|---|
CreateInstructionConfigurationSchema | For creating instructions | id, createdAt, updatedAt |
UpdateInstructionConfigurationSchema | For partial updates | All fields optional except id |
Related
- Knowledge Source - Domain knowledge referenced by instructions
- Agent Configuration - Uses instruction configurations
- Deployment Configuration - References instruction configurations