taskInstructions

codebolt.task-management.TaskInstruction(tools: Tools, userMessage: UserMessage, filepath: string, refsection: string): TaskInstruction

Encapsulates task instructions and their metadata, handling loading/processing from YAML files.

Parameters

Name	Type	Description
tools	Tools	Object containing tool definitions with descriptions and usage examples
userMessage	UserMessage	User message content handler for prompt generation
filepath	string	Path to YAML file containing task definitions
refsection	string	Specific section key to load from the YAML file

Example

import { TaskInstruction } from './task-instruction';
import { UserMessage } from './usermessage';

// Sample tools configuration
const tools = {
  fileProcessor: {
    description: "Handles file operations",
    usage: "processFile(filename)",
    example: "processFile('data.txt')"
  }
};

// Create a UserMessage instance 
const userMsg = new UserMessage(/* message configuration */);

// Initialize task instruction loader
const taskInstruction = new TaskInstruction(
  tools,
  userMsg,
  "./tasks/data_processing.yml",
  "data_cleanup"
);

// Generate prompts with task details
try {
  const prompts = await taskInstruction.toPrompt();
  console.log("Generated prompts:", prompts);
} catch (error) {
  console.error("Failed to process task:", error);
}