Member Junction
    Preparing search index...

    Interface AIDirective

    Represents a directive from an action to an AI agent. Unlike Message (which is informational and meant for display or logging), directives are structured instructions that the agent framework surfaces as explicit guidance the AI must consider.

    Actions return directives when they need to steer agent behavior — for example, telling the agent which action to call next, constraining it from taking a particular path, or providing critical context that should influence its decision.

    return {
        Success: true,
        ResultCode: 'SUCCESS',
        Message: 'Found 10 matching queries.',
        AIDirectives: [
            { message: 'Call "Run Stored Query" with QueryID "abc-123"', type: 'instruction', priority: 'high' },
            { message: 'Do NOT write fresh SQL — use the stored query above', type: 'constraint', priority: 'critical' },
            { message: 'The stored query provides columns: ID, Name, FieldCount', type: 'context', priority: 'medium' }
        ]
    };
    interface AIDirective {
        Message: string;
        Priority: "low" | "medium" | "high" | "critical";
        Type: "instruction" | "constraint" | "context" | "suggestion";
    }
    Index

    Properties

    Message Priority Type

    Properties

    Message: string

    The directive message text to surface to the AI agent

    Priority: "low" | "medium" | "high" | "critical"

    How strongly the AI should follow this directive:

    • low: Nice to follow, can be ignored if the AI has a better approach
    • medium: Should follow unless there's a clear reason not to
    • high: Must follow in most cases
    • critical: Must always follow, no exceptions
    Type: "instruction" | "constraint" | "context" | "suggestion"

    The kind of directive:

    • instruction: Direct command to perform a specific action or follow a specific path
    • constraint: Restriction on what the AI must NOT do
    • context: Important background information that should influence the AI's decisions
    • suggestion: Optional recommendation the AI may choose to follow or ignore

    Settings

    Member Visibility

    On This Page

    Properties