automation

package
v0.6.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 25, 2026 License: MIT Imports: 22 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	EnvWorkflowName       = "ALICE_AUTOMATION_WORKFLOW"
	EnvWorkflowStateKey   = "ALICE_AUTOMATION_STATE_KEY"
	EnvWorkflowTaskID     = "ALICE_AUTOMATION_TASK_ID"
	EnvWorkflowSessionKey = "ALICE_AUTOMATION_SESSION_KEY"
)

Variables

View Source 
var (
	ErrTaskNotFound = errors.New("automation task not found")
)

Functions

func BuildDispatchText 

func BuildDispatchText(action Action) (string, error)

func NextRunAt 

func NextRunAt(from time.Time, schedule Schedule) time.Time

func ValidateTask 

func ValidateTask(task Task) error

Types

type Action 

type Action struct {
	Type            ActionType `json:"type"`
	Text            string     `json:"text"`
	Prompt          string     `json:"prompt,omitempty"`
	Provider        string     `json:"provider,omitempty"`
	Model           string     `json:"model,omitempty"`
	Profile         string     `json:"profile,omitempty"`
	Workflow        string     `json:"workflow,omitempty"`
	StateKey        string     `json:"state_key,omitempty"`
	SessionKey      string     `json:"session_key,omitempty"`
	ReasoningEffort string     `json:"reasoning_effort,omitempty"`
	Personality     string     `json:"personality,omitempty"`
	MentionUserIDs  []string   `json:"mention_user_ids,omitempty"`
}

type ActionType 

type ActionType string
const (
	ActionTypeSendText    ActionType = "send_text"
	ActionTypeRunLLM      ActionType = "run_llm"
	ActionTypeRunWorkflow ActionType = "run_workflow"
)

type Actor 

type Actor struct {
	UserID string `json:"user_id,omitempty"`
	OpenID string `json:"open_id,omitempty"`
	Name   string `json:"name,omitempty"`
}

func (Actor) PreferredID 

func (a Actor) PreferredID() string

type Engine 

type Engine struct {
	// contains filtered or unexported fields
}

func NewEngine 

func NewEngine(store *Store, sender Sender) *Engine

func (*Engine) RegisterSystemTask 

func (e *Engine) RegisterSystemTask(name string, interval time.Duration, run SystemTaskFunc) error

func (*Engine) Run 

func (e *Engine) Run(ctx context.Context)

func (*Engine) SetLLMRunner 

func (e *Engine) SetLLMRunner(runner LLMRunner)

func (*Engine) SetRunEnv 

func (e *Engine) SetRunEnv(env map[string]string)

func (*Engine) SetUserTaskCompletionHook added in v0.6.0 

func (e *Engine) SetUserTaskCompletionHook(hook UserTaskCompletionHook)

func (*Engine) SetUserTaskTimeout 

func (e *Engine) SetUserTaskTimeout(timeout time.Duration)

func (*Engine) SetWorkflowRunner 

func (e *Engine) SetWorkflowRunner(runner WorkflowRunner)

type LLMRunner 

type LLMRunner interface {
	Run(ctx context.Context, req llm.RunRequest) (llm.RunResult, error)
}

type ManageMode 

type ManageMode string
const (
	ManageModeCreatorOnly ManageMode = "creator_only"
	ManageModeScopeAll    ManageMode = "scope_all"
)

type PromptWorkflowRunner added in v0.3.18 

type PromptWorkflowRunner struct {
	// contains filtered or unexported fields
}

func NewPromptWorkflowRunner added in v0.3.18 

func NewPromptWorkflowRunner(backend llm.Backend) *PromptWorkflowRunner

func (*PromptWorkflowRunner) Run added in v0.3.18 

func (r *PromptWorkflowRunner) Run(ctx context.Context, req WorkflowRunRequest) (WorkflowRunResult, error)

type Route 

type Route struct {
	ReceiveIDType string `json:"receive_id_type"`
	ReceiveID     string `json:"receive_id"`
}

type Schedule 

type Schedule struct {
	Type         ScheduleType `json:"type"`
	EverySeconds int          `json:"every_seconds"`
	CronExpr     string       `json:"cron_expr,omitempty"`
}

type ScheduleType 

type ScheduleType string
const (
	ScheduleTypeInterval ScheduleType = "interval"
	ScheduleTypeCron     ScheduleType = "cron"
)

type Scope 

type Scope struct {
	Kind ScopeKind `json:"kind"`
	ID   string    `json:"id"`
}

type ScopeKind 

type ScopeKind string
const (
	ScopeKindUser ScopeKind = "user"
	ScopeKindChat ScopeKind = "chat"
)

type Sender added in v0.3.20 

type Sender = messaging.AutomationSender

type Snapshot 

type Snapshot struct {
	Version int    `json:"version"`
	Tasks   []Task `json:"tasks"`
}

type Store 

type Store struct {
	// contains filtered or unexported fields
}

func NewStore 

func NewStore(path string) *Store

func (*Store) ClaimDueTasks 

func (s *Store) ClaimDueTasks(at time.Time, limit int) ([]Task, error)

func (*Store) CreateTask 

func (s *Store) CreateTask(task Task) (Task, error)

func (*Store) GetTask 

func (s *Store) GetTask(taskID string) (Task, error)

func (*Store) ListTasks 

func (s *Store) ListTasks(scope Scope, statusFilter string, limit int) ([]Task, error)

func (*Store) PatchTask 

func (s *Store) PatchTask(taskID string, mutate func(task *Task) error) (Task, error)

func (*Store) Path 

func (s *Store) Path() string

func (*Store) RecordTaskResult 

func (s *Store) RecordTaskResult(taskID string, at time.Time, runErr error) error

func (*Store) RecordTaskSignal added in v0.5.23 

func (s *Store) RecordTaskSignal(taskID string, at time.Time, kind, message string, pause bool) error

func (*Store) ResetRunningTasks 

func (s *Store) ResetRunningTasks() error

type SystemTaskFunc 

type SystemTaskFunc func(ctx context.Context)

type Task 

type Task struct {
	ID                  string     `json:"id"`
	Title               string     `json:"title,omitempty"`
	Scope               Scope      `json:"scope"`
	Route               Route      `json:"route"`
	Creator             Actor      `json:"creator"`
	ManageMode          ManageMode `json:"manage_mode"`
	Schedule            Schedule   `json:"schedule"`
	Action              Action     `json:"action"`
	Status              TaskStatus `json:"status"`
	MaxRuns             int        `json:"max_runs,omitempty"`
	RunCount            int        `json:"run_count,omitempty"`
	CreatedAt           time.Time  `json:"created_at"`
	UpdatedAt           time.Time  `json:"updated_at"`
	NextRunAt           time.Time  `json:"next_run_at"`
	LastRunAt           time.Time  `json:"last_run_at,omitempty"`
	DeletedAt           time.Time  `json:"deleted_at,omitempty"`
	Running             bool       `json:"running,omitempty"`
	LastResult          string     `json:"last_result,omitempty"`
	ConsecutiveFailures int        `json:"consecutive_failures,omitempty"`
	Revision            int64      `json:"revision"`
}

func NormalizeTask 

func NormalizeTask(task Task) Task

type TaskStatus 

type TaskStatus string
const (
	TaskStatusActive  TaskStatus = "active"
	TaskStatusPaused  TaskStatus = "paused"
	TaskStatusDeleted TaskStatus = "deleted"
)

func ParseStatusFilter 

func ParseStatusFilter(raw string) (TaskStatus, bool, error)

type UserTaskCompletionHook added in v0.6.0 

type UserTaskCompletionHook func(task Task, err error)

type WorkflowCommand added in v0.5.23 

type WorkflowCommand struct {
	Text string
}

type WorkflowRunRequest 

type WorkflowRunRequest struct {
	Workflow        string
	TaskID          string
	StateKey        string
	SessionKey      string
	Scene           string
	Prompt          string
	Provider        string
	Model           string
	Profile         string
	ReasoningEffort string
	Personality     string
	Env             map[string]string
}

type WorkflowRunResult 

type WorkflowRunResult struct {
	Message  string
	Commands []WorkflowCommand
}

type WorkflowRunner 

type WorkflowRunner interface {
	Run(ctx context.Context, req WorkflowRunRequest) (WorkflowRunResult, error)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.