Skip to content

@alneas/ai-core API Reference

Type ActionResult

type ActionResult

Result of input validation for an action.

type ActionValidationResult

Validator function for action input. Mandatory for all actions to ensure safe runtime execution.

type ActionValidator

Definition of an executable action.

interface ActionDefinition

Public descriptor of an action (excluding the executable handler). Safe to expose to UI lists, AI inspection, and external consumers.

interface ActionDescriptor

Result of retrieving a context value.

type ContextValueResult

Function that retrieves the current value of a context on demand.

type ContextGetter

Definition of an on-demand screen context provider.

interface ContextDefinition

Public descriptor of a context (excluding the getter).

interface ContextDescriptor

Registry for managing explicit screen actions and on-demand context getters. Framework-independent, zero-dependency.

class ActionRegistry

Application-owned synchronous JSON Schema; finite JSON and supported drafts are checked at runtime.

type ActionToolInputSchema

JSON values accepted at the tool boundary; functions, undefined and non-finite numbers are rejected.

type ActionToolValue